#2657: DPH Haddock document isn't linked from Libraries document
------------------------------+---------------------------------------------
Reporter: shelarcy | Owner:
Type: bug | Status: new
Priority: high | Milestone: 6.10.1
Component: Documentation | Version: 6.9
Severity: normal | Resolution:
Keywords: | Difficulty: Unknown
Testcase: | Architecture: Unknown/Multiple
Os: Unknown/Multiple |
------------------------------+---------------------------------------------
Changes (by igloo):
* owner: igloo =>
* cc: [EMAIL PROTECTED] (added)
Comment:
Fixing this is easy in theory, it's just:
{{{
hunk ./libraries/gen_contents_index 12
+ if [ -d dph ]
+ then
+ HADDOCK_FILES="$HADDOCK_FILES `ls -1
dph/*/dist/doc/html/*/*.haddock | sort`"
+ fi
hunk ./libraries/gen_contents_index 26
- NAME=`echo "$HADDOCK_FILE" | sed 's#/.*##'`
+ NAME=`echo "$HADDOCK_FILE" | sed 's#/dist/.*##' | sed 's#.*/##' `
}}}
Unfortunately, life is never that simple. The dph packages have a number
of "Other" (as opposed to "Exposed") modules. When haddocking those, Cabal
passes `--hide=Data.Array.Parallel.Stream.Flat` etc to haddock, so no docs
get generated. However, the script that calls haddock to make the index
doesn't know about "Other" modules, so it doesn't pass them to haddock,
and they get put in the contents page.
Haddock manages to not put the "Other" modules in the package-specific
index, so presumably it's just a matter of recording that the module is
hidden in the haddock interface file. David, is this easy to fix?
--
Ticket URL: <http://hackage.haskell.org/trac/ghc/ticket/2657#comment:3>
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
