diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51c8fa28..af7a414f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,25 +32,26 @@ cd haddock ### Git Branches -For improvements to the documentation generator, -please base your pull request on the latest GHC version branch -(`ghc-9.2` for instance). +If your patch consists of glue code and interface changes with GHC, please +open a Pull Request targeting the `ghc-head` branch. + +Otherwise, for improvements to the documentation generator, +please base your pull request on the current GHC version branch +(`ghc-9.0` for instance). The PR will be forward-ported to `ghc-head` +so that documentation built within GHC can benefit from it. ### Building the packages #### Using `cabal` -Requires cabal `>= 3.4` and GHC `== 9.2`: +Requires cabal `>= 3.4` and the latest build of GHC: -First update the package list: +You can install the latest build of GHC via ghcup using this command: ```bash -cabal v2-update +ghcup install ghc -u "https://gitlab.haskell.org/ghc/ghc/-/jobs/artifacts/master/raw/ghc-x86_64-deb9-linux-integer-simple.tar.xz?job=validate-x86_64-linux-deb9-integer-simple" head ``` -This is needed as haddock@ghc-9.2 uses the -[ghc.head](https://ghc.gitlab.haskell.org/head.hackage/) package repository. - ```bash cabal v2-build all --enable-tests cabal v2-test all @@ -70,3 +71,4 @@ cabal v2-test html-test latex-test hoogle-test hypsrc-test \ [SSCCE]: http://sscce.org/ + |