[Git][ghc/ghc][master] haddock: Update CONTRIBUTING with missing step, add missing test
Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC Commits: b734c75d by Igor Ranieri at 2026-06-16T20:27:32-04:00 haddock: Update CONTRIBUTING with missing step, add missing test dependency - - - - - 2 changed files: - utils/haddock/CONTRIBUTING.md - utils/haddock/haddock-test/haddock-test.cabal Changes: ===================================== utils/haddock/CONTRIBUTING.md ===================================== @@ -33,6 +33,14 @@ $ ./hadrian/build -j --flavour=Quick --freeze1 _build/stage1/bin/haddock Currently, this cannot be done with hadrian but has to be done with a `cabal-install` built from `master`. +First, generate the `.haddock` interface files for GHC's bundled libraries: + +``` +$ ./hadrian/build -j docs-haddock +``` + +Then run the tests: + ``` cabal test -w <absolute-path-to-ghc-repo>/_build/stage1/bin/ghc ``` ===================================== utils/haddock/haddock-test/haddock-test.cabal ===================================== @@ -16,7 +16,7 @@ library default-language: Haskell2010 ghc-options: -Wall hs-source-dirs: src - build-depends: base >= 4.3 && < 4.24, bytestring, directory, process, filepath, Cabal + build-depends: base >= 4.3 && < 4.24, bytestring, directory, process, filepath, Cabal, containers exposed-modules: Test.Haddock View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/b734c75d68e572192f0ca2efb875ad1f... -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/b734c75d68e572192f0ca2efb875ad1f... You're receiving this email because of your account on gitlab.haskell.org.
participants (1)
-
Marge Bot (@marge-bot)