[GHC] #8475: Library docs: broken links to Foreign.ForeignPtr
#8475: Library docs: broken links to Foreign.ForeignPtr ------------------------------------+------------------------------------- Reporter: simonmar | Owner: Type: bug | Status: new Priority: high | Milestone: 7.8.1 Component: Documentation | Version: 7.6.3 Keywords: | Operating System: Unknown/Multiple Architecture: Unknown/Multiple | Type of failure: None/Unknown Difficulty: Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | ------------------------------------+------------------------------------- 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. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8475 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8475: Library docs: broken links to Foreign.ForeignPtr -------------------------------------+------------------------------------ Reporter: simonmar | Owner: hellertime Type: bug | Status: new Priority: high | Milestone: 7.8.1 Component: Documentation | Version: 7.6.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Changes (by hellertime): * owner: => hellertime -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8475#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8475: Library docs: broken links to Foreign.ForeignPtr -------------------------------------+------------------------------------ Reporter: simonmar | Owner: hellertime Type: bug | Status: patch Priority: high | Milestone: 7.8.1 Component: Documentation | Version: 7.6.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Changes (by hellertime): * status: new => patch Comment: 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. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8475#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8475: Library docs: broken links to Foreign.ForeignPtr
-------------------------------------+------------------------------------
Reporter: simonmar | Owner: hellertime
Type: bug | Status: patch
Priority: high | Milestone: 7.8.1
Component: Documentation | Version: 7.6.3
Resolution: | Keywords:
Operating System: Unknown/Multiple | Architecture: Unknown/Multiple
Type of failure: None/Unknown | Difficulty: Unknown
Test Case: | Blocked By:
Blocking: | Related Tickets:
-------------------------------------+------------------------------------
Changes (by ezyang):
* cc: davidterei@… (added)
Comment:
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
#8475: Library docs: broken links to Foreign.ForeignPtr -------------------------------------+------------------------------------ Reporter: simonmar | Owner: hellertime Type: bug | Status: infoneeded Priority: high | Milestone: 7.8.1 Component: Documentation | Version: 7.6.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Changes (by simonpj): * status: patch => infoneeded Comment: 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 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8475#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8475: Library docs: broken links to Foreign.ForeignPtr -------------------------------------+------------------------------------ Reporter: simonmar | Owner: hellertime Type: bug | Status: infoneeded Priority: high | Milestone: 7.8.1 Component: Documentation | Version: 7.6.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Comment (by hellertime): Reformatted the patch to reflect my correct e-mail address. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8475#comment:5 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8475: Library docs: broken links to Foreign.ForeignPtr -------------------------------------+------------------------------------ Reporter: simonmar | Owner: hellertime Type: bug | Status: infoneeded Priority: high | Milestone: 7.8.1 Component: Documentation | Version: 7.6.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Comment (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. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8475#comment:6 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8475: Library docs: broken links to Foreign.ForeignPtr -------------------------------------+------------------------------------ Reporter: simonmar | Owner: hellertime Type: bug | Status: infoneeded Priority: high | Milestone: 7.8.1 Component: Documentation | Version: 7.6.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Comment (by dterei): No no good reason I can remember. Fairly sure it was a copy-paste mistake. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8475#comment:7 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8475: Library docs: broken links to Foreign.ForeignPtr -------------------------------------+------------------------------------ Reporter: simonmar | Owner: hellertime Type: bug | Status: patch Priority: high | Milestone: 7.8.3 Component: Documentation | Version: 7.6.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Changes (by thoughtpolice): * status: infoneeded => patch -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8475#comment:8 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8475: Library docs: broken links to Foreign.ForeignPtr
-------------------------------------+------------------------------------
Reporter: simonmar | Owner: hellertime
Type: bug | Status: patch
Priority: high | Milestone: 7.8.3
Component: Documentation | Version: 7.6.3
Resolution: | Keywords:
Operating System: Unknown/Multiple | Architecture: Unknown/Multiple
Type of failure: None/Unknown | Difficulty: Unknown
Test Case: | Blocked By:
Blocking: | Related Tickets:
-------------------------------------+------------------------------------
Comment (by Austin Seipp
#8475: Library docs: broken links to Foreign.ForeignPtr -------------------------------------+------------------------------------ Reporter: simonmar | Owner: hellertime Type: bug | Status: merge Priority: high | Milestone: 7.8.3 Component: Documentation | Version: 7.6.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Changes (by thoughtpolice): * status: patch => merge -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8475#comment:10 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8475: Library docs: broken links to Foreign.ForeignPtr -------------------------------------+------------------------------------ Reporter: simonmar | Owner: hellertime Type: bug | Status: closed Priority: high | Milestone: 7.8.3 Component: Documentation | Version: 7.6.3 Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Changes (by thoughtpolice): * status: merge => closed * resolution: => fixed Comment: Merged, thanks! -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8475#comment:11 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC