From 5e968f9261b798222a845ef38a54621b45013678 Mon Sep 17 00:00:00 2001 From: Ben Gamari Date: Tue, 4 Apr 2017 12:07:25 -0400 Subject: [PATCH] HACKING: Update for Phabricator patch workflow --- HACKING.md | 33 +++++++++------------------------ 1 file changed, 9 insertions(+), 24 deletions(-) diff --git a/HACKING.md b/HACKING.md index 6ed39eaf1c..ecfd35b50e 100644 --- a/HACKING.md +++ b/HACKING.md @@ -49,13 +49,11 @@ $ cp mk/build.mk.sample mk/build.mk $ ... double-check mk/build.mk ... ``` -Now build. If you have multiple cores, **you should always use them to -speed up compilation**: +Now build. The convenient `validate` script will build the tree in a way which +is both quick to build and consistent with our testsuite, ``` -$ ./boot -$ ./configure -$ make -jN # is the number of cores you have. +$ ./validate --build-only ``` You can use the `./inplace/bin/ghc-stage2` binary to play with the @@ -63,26 +61,13 @@ newly built compiler. Now, hack on your copy and rebuild (with `make`) as necessary. -Then start by making your commits however you want. When you're done, you -can use `git format-patch` to create a series of `.patch` files you -can give to us. In this example, we'll assume I'm on a `bugfix` branch -and want to submit my patches: +Then start by making your commits however you want. When you're done, you'll +need to submit your patch to [Phabricator](https://phabricator.haskell.org/) for +code review. To do so you will need to +[install Arcanist](https://secure.phabricator.com/book/phabricator/article/arcanist/#installing-arcanist), +Phabricator's CLI tool. Once installed, you can submit your work for code review +using `arc diff`. -``` -$ git branch -* bugfix - master -$ git format-patch master -o patches -... -$ -``` - -Now create a trac ticket: - - - -And attach the files in your `patches/` directory. Set the status from -*new* to *patch* and we'll review it as soon as we can! Useful links: ============= -- GitLab