diff options
| author | Simon Jakobi <simon.jakobi@gmail.com> | 2018-06-04 17:51:03 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2018-06-04 17:56:57 -0400 |
| commit | 85309a3cda367425cca727dfa45e5e6c63b47391 (patch) | |
| tree | 0a4aff565a1e34843cbb178707971f86786d939f /mk | |
| parent | aa77c602e910cb9a4e17022464c0341fd731f3e0 (diff) | |
| download | haskell-85309a3cda367425cca727dfa45e5e6c63b47391.tar.gz | |
Serialize docstrings to ifaces, display them with new GHCi :doc command
If `-haddock` is set, we now extract docstrings from the renamed ast
and serialize them in the .hi-files.
This includes some of the changes from D4749 with the notable
exceptions of the docstring lexing and renaming.
A currently limited and experimental GHCi :doc command can be used
to display docstrings for declarations.
The formatting of pretty-printed docstrings is changed slightly,
causing some changes in testsuite/tests/haddock.
Test Plan: ./validate
Reviewers: alexbiehl, hvr, gershomb, harpocrates, bgamari
Reviewed By: alexbiehl
Subscribers: rwbarton, thomie, carter
Differential Revision: https://phabricator.haskell.org/D4758
Diffstat (limited to 'mk')
| -rw-r--r-- | mk/config.mk.in | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/mk/config.mk.in b/mk/config.mk.in index 92830fa1e8..6ff8e0ee7d 100644 --- a/mk/config.mk.in +++ b/mk/config.mk.in @@ -311,8 +311,11 @@ GhcThreaded = $(if $(findstring thr,$(GhcRTSWays)),YES,NO) # # -O(2) is pretty desirable, otherwise no inlining of prelude # things (incl "+") happens when compiling with this compiler +# +# -haddock is needed so the GHCi :doc command can find the boot +# library docs in the respective .hi-files -GhcLibHcOpts=-O2 +GhcLibHcOpts=-O2 -haddock # Strip local symbols from libraries? This can make the libraries smaller, # but makes debugging somewhat more difficult. Doesn't work with all ld's. |