[GHC] #14920: Flag reference doesn't include `-haddock` and `-haddock-opts`

GHC ghc-devs at haskell.org
Thu Mar 15 05:39:35 UTC 2018


#14920: Flag reference doesn't include `-haddock` and `-haddock-opts`
-------------------------------------+-------------------------------------
        Reporter:  sjakobi           |                Owner:  sjakobi
            Type:  bug               |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  Documentation     |              Version:  8.4.1
      Resolution:                    |             Keywords:
Operating System:  Unknown/Multiple  |         Architecture:
                                     |  Unknown/Multiple
 Type of failure:  None/Unknown      |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------

Comment (by alexbiehl):

 A comment on `-haddock`: yes, with this flag GHC will take a closer look
 on comments and keep them in its syntax tree for haddock to pick them up
 (see `collectDocs` in haddock-api package).

 For "Hi Haddock", as as a first approximation I am in favour of only
 putting documentation in hi files when `-haddock` flag is given. If it
 turns out to be performant enough we could still enable `-haddock` by
 default later.

-- 
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14920#comment:3>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler


More information about the ghc-tickets mailing list