Opened 6 years ago

Closed 5 years ago

#8475 closed bug (fixed)

Library docs: broken links to Foreign.ForeignPtr

Reported by: simonmar Owned by: hellertime
Priority: high Milestone: 7.8.3
Component: Documentation Version: 7.6.3
Keywords: Cc: davidterei@…
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: None/Unknown Test Case:
Blocked By: Blocking:
Related Tickets: Differential Rev(s):
Wiki Page:

Description

In the library docs at http://www.haskell.org/ghc/docs/latest/html/libraries/index.html, the Foreign.ForeignPtr module in the contents is the one from haskell2010, not base. This causes various problems, it seems. For instance:

  • the link from ForeignPtr to Foreign.ForeignPtr is broken
  • the link from Foreign.Concurrent to Foreign.ForeignPtr is broken

there are probably other broken links too. We need to figure out what to do about overlapping modules properly.

Attachments (1)

0001-document-Foreign.ForeignPtr-fixes-8475.patch (646 bytes) - added by hellertime 6 years ago.
Fixes #8475

Download all attachments as: .zip

Change History (12)

comment:1 Changed 6 years ago by hellertime

Owner: set to hellertime

comment:2 Changed 6 years ago by hellertime

Status: newpatch

Haddock was being to not to document Foreign.ForeignPtr resulting in the incorrect links noted in this ticket.

This patch removes the haddock pragma so that the documentation once again is generated.

comment:3 Changed 6 years ago by ezyang

Cc: davidterei@… added

CC'ing David Terei, since he was the one originally responsible for adding the OPTIONS_HADDOCK hide to this module. David, was there any particular reason why you added that pragma in this commit?

commit 555183b053d1ec9e27083c0f15f648a69c716bc2
Author:	David Terei <davidterei@gmail.com>  Tue May 17 05:57:46 2011
Committer:	David Terei <davidterei@gmail.com>  Sat Jun 18 16:06:34 2011

SafeHaskell: Added SafeHaskell to base

comment:4 Changed 6 years ago by simonpj

Status: patchinfoneeded

I'll change the status back to 'info needed', pending David's reply. Chris: do time out if David doesn't reply in a week or so.

Simon

Changed 6 years ago by hellertime

Fixes #8475

comment:5 Changed 6 years ago by hellertime

Reformatted the patch to reflect my correct e-mail address.

comment:6 Changed 6 years ago by simonmar

Well, there are two Foreign.ForeignPtr modules, one in base and one in haskell2010. I don't think we have a good story for what Haddock does in that case - which one gets listed in the contents? It should be safe to generate documentation for both, so that at least the hyperlinks would work correctly.

comment:7 Changed 6 years ago by dterei

No no good reason I can remember. Fairly sure it was a copy-paste mistake.

comment:8 Changed 5 years ago by thoughtpolice

Status: infoneededpatch

comment:9 Changed 5 years ago by Austin Seipp <austin@…>

In 4dac3a4124e5b3bb2ef8f9105f8921dcbb5183f7/ghc:

base: Document Foreign.ForeignPtr (#8475)

Signed-off-by: Austin Seipp <austin@well-typed.com>

comment:10 Changed 5 years ago by thoughtpolice

Status: patchmerge

comment:11 Changed 5 years ago by thoughtpolice

Resolution: fixed
Status: mergeclosed

Merged, thanks!

Note: See TracTickets for help on using tickets.