[GHC] #1572: Make it easy to find documentation for installed packages

GHC trac at galois.com
Wed Aug 1 14:16:59 EDT 2007


#1572: Make it easy to find documentation for installed packages
-------------------------+--------------------------------------------------
    Reporter:  simonpj   |        Owner:         
        Type:  task      |       Status:  new    
    Priority:  normal    |    Milestone:         
   Component:  Compiler  |      Version:  6.6.1  
    Severity:  normal    |   Resolution:         
    Keywords:            |   Difficulty:  Unknown
          Os:  Unknown   |     Testcase:         
Architecture:  Unknown   |  
-------------------------+--------------------------------------------------
Changes (by claus):

  * cc:  => claus.reinke at talk21.com

Comment:

 there are also other tools who'd like easy access to that information, on
 behalf of the user;-) for instance, one of my haskell mode plugins for vim
 uses haddock's index to figure out which haskell identifiers have
 documentation, and where to find it:

 [http://www.cs.kent.ac.uk/people/staff/cr3/toolbox/haskell/Vim/
 haskell_doc.vim]

 one would like at least '''a central html table of contents plus a central
 index for the user, plus a more accessible format of the index for ide-
 like tools'''. currently, the toc and index contain all packages built
 together with ghc, but the information in the index isn't easily
 accessible for tools. preferably, added packages should integrate their
 toc and index with the central ones (or include the central ones into
 their own central toc and index, if they are a user-build).

 also, i have found that ghc-pkg reports where the docs *might* be, even if
 they aren't installed! perhaps there should be a separate documentation
 package associated with each binary package?

 this is also related to #1226 (finding ghc user_guide installed location).

-- 
Ticket URL: <http://hackage.haskell.org/trac/ghc/ticket/1572>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler


More information about the Glasgow-haskell-bugs mailing list