#3810: Problems in core lib haddocks
----------------------------------+-----------------------------------------
    Reporter:  igloo              |        Owner:  waern       
        Type:  bug                |       Status:  new         
    Priority:  high               |    Milestone:  6.14.1      
   Component:  libraries (other)  |      Version:  6.12.1      
    Keywords:                     |     Testcase:              
   Blockedby:                     |   Difficulty:              
          Os:  Unknown/Multiple   |     Blocking:              
Architecture:  Unknown/Multiple   |      Failure:  None/Unknown
----------------------------------+-----------------------------------------

Comment(by waern):

 The problem with the source link here is due to the fact that the array
 package re-exports symbols from the base package, but Haddock bases all
 source links within the same package on the same path (specified with
 `--source-entity`).

 I've added the ability to specify per-package source entity paths to
 Haddock via the `--read-interface` flag to remedy that:

 {{{
   * Add source entity path to --read-interface

   You can now use this flag like this:

     --read-interface=<html path>,<source entity path>,<.haddock file>

   By "source entity path" I mean the same thing that is specified with the
   --source-entity flag. The purpose of this is to be able to specify the
 source
   entity path per package, to allow source links to work in the presence
 of
   cross-package documentation.

   When given two arguments or less the --read-interface flag behaves as
 before.
 }}}

 We should update Cabal as well so that it passes the source paths if the
 version of Haddock is >= 2.8. It's not urgent however since Haddock now
 won't insert a "Source" link if it can't find a source entity path for the
 correct package.

-- 
Ticket URL: <http://hackage.haskell.org/trac/ghc/ticket/3810#comment:7>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler
_______________________________________________
Glasgow-haskell-bugs mailing list
[email protected]
http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs

Reply via email to