diff options
| author | Pepe Iborra <pepeiborra@gmail.com> | 2020-06-23 14:18:56 +0100 |
|---|---|---|
| committer | sternenseemann <sternenseemann@systemli.org> | 2021-11-10 21:10:35 +0100 |
| commit | d68033afae8476a840a3d6866f9119a78e5dec84 (patch) | |
| tree | 038126234ee271b704a90e420bfdec2e07ac1806 /pkgs/development/python-modules/rangehttpserver | |
| parent | da2c9c6eabc7f94675736bab02d1d70726410764 (diff) | |
haskellPackages.mkDerivation: add doHaddockInterfaces option
This adds a new builder option `doHaddockInterfaces` to enable the -haddock flag in GHC,
which results in Haddock comments parsed at compile-time and embedded in
interface files. These are used by the :doc command in GHCi, as well as IDE
tools like ghcide and hls to display docs on hover.
The `-haddock` flag has been around since at least 8.2, even though it does not
get a mention in the GHC Users guide.
There are two downsides to turning on this flag:
1. Increased compile times, since Haddocks must be parsed and then encoded
2. Haddock parse errors now become compile errors for GHC < 9.0.1
(https://gitlab.haskell.org/ghc/ghc/-/issues/8944)
Thus we only enable the feature if we have GHC 9.0.1 and haddock is
enabled; when 9.0.1 becomes the default GHC, we may need to reevaluate
the performance concern.
Co-authored-by: sternenseemann <sternenseemann@systemli.org>
Diffstat (limited to 'pkgs/development/python-modules/rangehttpserver')
0 files changed, 0 insertions, 0 deletions