[Git][ghc/ghc][master] Update the outdated instructions in HACKING.md on how to compile GHC

Marge Bot (@marge-bot) gitlab at gitlab.haskell.org
Thu Jun 8 22:41:46 UTC 2023



Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
567b32e1 by David Binder at 2023-06-08T18:41:29-04:00
Update the outdated instructions in HACKING.md on how to compile GHC

- - - - -


1 changed file:

- HACKING.md


Changes:

=====================================
HACKING.md
=====================================
@@ -23,47 +23,15 @@ Contributing patches to GHC in a hurry
 ======================================
 
 Make sure your system has the necessary tools to compile GHC. You can
-find an overview here:
+find an overview of how to prepare your system for compiling GHC here:
 
 <https://gitlab.haskell.org/ghc/ghc/wikis/building/preparation>
 
-Next, clone the repository and all the associated libraries:
+After you have prepared your system, you can build GHC following the instructions described here:
 
-```
-$ git clone --recursive git at gitlab.haskell.org:ghc/ghc.git
-```
+<https://gitlab.haskell.org/ghc/ghc/-/wikis/building/hadrian>
 
-On Windows, you need an extra repository containing some build tools.
-These can be downloaded for you by `configure`. This only needs to be done once by running:
-
-```
-$ ./configure --enable-tarballs-autodownload
-```
-
-First copy `mk/build.mk.sample` to `mk/build.mk` and ensure it has
-your preferred build settings. (You probably want to at least set
-`BuildFlavour` to `quick`):
-
-```
-$ cp mk/build.mk.sample mk/build.mk
-$ ... double-check mk/build.mk ...
-```
-
-Now build. The convenient `validate` script will build the tree in a way which
-is both quick to build and consistent with our testsuite:
-
-```
-$ ./validate --build-only
-```
-
-You can use the `_validatebuild/stage1/bin/ghc` binary to play with the
-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 submit
-a pull request on Github for small changes. For larger changes the patch needs to be
-submitted to [GitLab](https://gitlab.haskell.org/ghc/ghc/merge_requests) for code review.
+Then start by making your commits however you want. When you're done, you can submit a merge request to [GitLab](https://gitlab.haskell.org/ghc/ghc/merge_requests) for code review.
 Changes to the `base` library require a proposal to the [core libraries committee](https://github.com/haskell/core-libraries-committee/issues).
 The GHC Wiki has a good summary for the [overall process](https://gitlab.haskell.org/ghc/ghc/wikis/working-conventions/fixing-bugs). One or several reviewers will review your PR, and when they are ok with your changes, they will assign the PR to [Marge Bot](https://gitlab.haskell.org/marge-bot) which will automatically rebase, batch and then merge your PR (assuming the build passes).
 



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/567b32e12cbae07bee78d66252e83a0ad08419be

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/567b32e12cbae07bee78d66252e83a0ad08419be
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20230608/ce139772/attachment-0001.html>


More information about the ghc-commits mailing list