[commit: ghc] master: Add a note on building documentation (f846945)
git at git.haskell.org
git at git.haskell.org
Tue Oct 23 20:10:59 UTC 2018
Repository : ssh://git@git.haskell.org/ghc
On branch : master
Link : http://ghc.haskell.org/trac/ghc/changeset/f846945cfa4af667176ec1181c6904a6ba28dff3/ghc
>---------------------------------------------------------------
commit f846945cfa4af667176ec1181c6904a6ba28dff3
Author: Andrey Mokhov <andrey.mokhov at gmail.com>
Date: Wed Nov 1 12:03:12 2017 +0000
Add a note on building documentation
See #414
>---------------------------------------------------------------
f846945cfa4af667176ec1181c6904a6ba28dff3
README.md | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/README.md b/README.md
index b25e31a..90db95a 100644
--- a/README.md
+++ b/README.md
@@ -109,6 +109,13 @@ use `hadrian/UserSettings.hs` for the same purpose, see [documentation](doc/user
* `build -B` forces Shake to rerun all rules, even if the previous build results are
are still up-to-date.
+#### Documentation
+
+To build GHC documentation, run `build docs --haddock`. The `docs` is the documentation
+target, and the `--haddock` flag enables building Haddock. This is a temporary solution
+and [we plan](https://github.com/snowleopard/hadrian/issues/414) to simplify this command
+to `build docs`.
+
#### Source distribution
To build a GHC source distribution tarball, run Hadrian with the `sdist-ghc` target.
More information about the ghc-commits
mailing list