[Hackage] #488: Include links to GHC documentation in packages' haddock docs

#488: Include links to GHC documentation in packages' haddock docs --------------------------------+------------------------------------------- Reporter: SamB | Owner: Type: defect | Status: new Priority: normal | Milestone: Component: hackageDB website | Version: 1.6.0.1 Severity: normal | Keywords: Difficulty: unknown | Ghcversion: Platform: | --------------------------------+------------------------------------------- It would be really nice if packages' haddock documentation didn't have broken (well, missing) links whenever it refers to GHC core packages that aren't also on hackage. Even nicer would be if dependencies on GHC core packages also linked to their Haddock documentation. -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/488 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects

#488: Include links to GHC documentation in packages' haddock docs --------------------------------+------------------------------------------- Reporter: SamB | Owner: Type: defect | Status: new Priority: normal | Milestone: Component: hackageDB website | Version: 1.6.0.1 Severity: normal | Resolution: Keywords: | Difficulty: unknown Ghcversion: | Platform: --------------------------------+------------------------------------------- Comment (by duncan): The solution is to put the core packages on hackage too. I the past base was not uploaded to hackage because of the worry that cabal-install might try to upgrade it. However that will not happen any more. -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/488#comment:1 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects

#488: Include links to GHC documentation in packages' haddock docs --------------------------------+------------------------------------------- Reporter: SamB | Owner: Type: defect | Status: closed Priority: normal | Milestone: Component: hackageDB website | Version: 1.6.0.1 Severity: normal | Resolution: fixed Keywords: | Difficulty: unknown Ghcversion: | Platform: --------------------------------+------------------------------------------- Changes (by duncan): * status: new => closed * resolution: => fixed Comment: It appears that Ross has uploaded the docs for base. -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/488#comment:2 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects

#488: Include links to GHC documentation in packages' haddock docs --------------------------------+------------------------------------------- Reporter: SamB | Owner: Type: defect | Status: reopened Priority: normal | Milestone: Component: hackageDB website | Version: 1.6.0.1 Severity: normal | Resolution: Keywords: | Difficulty: unknown Ghcversion: | Platform: --------------------------------+------------------------------------------- Changes (by ross): * status: closed => reopened * resolution: fixed => Comment: The base docs have always been there. I assume the report was about ghc and ghc-prim not having docs, and base not having a package page. Relying on your assurance that it won't cause trouble, I've uploaded base-4.0.0.0, so now there's a base page. I'll put up the docs for the other two later. -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/488#comment:3 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects

#488: Include links to GHC documentation in packages' haddock docs --------------------------------+------------------------------------------- Reporter: SamB | Owner: Type: defect | Status: reopened Priority: normal | Milestone: Component: hackageDB website | Version: 1.6.0.1 Severity: normal | Resolution: Keywords: | Difficulty: unknown Ghcversion: | Platform: --------------------------------+------------------------------------------- Comment (by duncan): Replying to [comment:3 ross]:
The base docs have always been there. I assume the report was about ghc and ghc-prim not having docs, and base not having a package page.
Relying on your assurance that it won't cause trouble, I've uploaded
I thought SamB was talking about things like `Int` linking to the base package. base-4.0.0.0, so now there's a base page. I'll put up the docs for the other two later. Ok, lets see what happens. :-) -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/488#comment:4 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects

Replying to [comment:3 ross]:
Relying on your assurance that it won't cause trouble, I've uploaded
#488: Include links to GHC documentation in packages' haddock docs --------------------------------+------------------------------------------- Reporter: SamB | Owner: Type: defect | Status: reopened Priority: normal | Milestone: Component: hackageDB website | Version: 1.6.0.1 Severity: normal | Resolution: Keywords: | Difficulty: unknown Ghcversion: | Platform: --------------------------------+------------------------------------------- Comment (by duncan): Replying to [comment:4 duncan]: base-4.0.0.0, so now there's a base page. I'll put up the docs for the other two later.
Ok, lets see what happens. :-)
One bug: {{{ $ cabal install base --dry-run Resolving dependencies... cabal: Distribution/Client/Dependency/TopDown.hs:168:37-73: Non-exhaustive patterns in lambda }}} However that's not an immediate problem since it only happens when you explicitly ask to install base. Doing and ordinary install/upgrade does not try to upgrade base, though the error messages could be improved: With the released cabal-install: {{{ $ cabal install syb --dry-run -w ghc-6.8.2 Resolving dependencies... cabal: cannot configure syb-0.1.0.0. It requires base >=4.0 There is no available version of base that satisfies >=4.0 }}} That's because in the released version we simply ignore base in the available package set. In the current darcs version: {{{ $ cabal install syb --dry-run -w ghc-6.8.2 Resolving dependencies... cabal: cannot configure syb-0.1.0.0. It requires base >=4.0 For the dependency on base >=4.0 there are these packages: base-4.0.0.0. However none of them are available. base-4.0.0.0 was excluded because of the top level dependency base -any }}} The constraint here was on picking an installed version of base (there's no version constraint). But we're not printing that properly. -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/488#comment:5 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects

#488: Include links to GHC documentation in packages' haddock docs --------------------------------+------------------------------------------- Reporter: SamB | Owner: Type: defect | Status: reopened Priority: normal | Milestone: Component: hackageDB website | Version: 1.6.0.1 Severity: normal | Resolution: Keywords: | Difficulty: unknown Ghcversion: | Platform: --------------------------------+------------------------------------------- Comment (by SamB): Sounds good. Ross seems to have accurately summarized my complaints. (I hadn't realized that base had docs, though.) -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/488#comment:6 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects

#488: Include links to GHC documentation in packages' haddock docs --------------------------------+------------------------------------------- Reporter: SamB | Owner: Type: defect | Status: reopened Priority: normal | Milestone: Component: hackageDB website | Version: 1.6.0.1 Severity: normal | Resolution: Keywords: | Difficulty: unknown Ghcversion: | Platform: --------------------------------+------------------------------------------- Comment (by duncan): Is there anything left to do here? -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/488#comment:7 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects

#488: Include links to GHC documentation in packages' haddock docs --------------------------------+------------------------------------------- Reporter: SamB | Owner: Type: defect | Status: closed Priority: normal | Milestone: Component: hackageDB website | Version: 1.6.0.1 Severity: normal | Resolution: fixed Keywords: | Difficulty: unknown Ghcversion: | Platform: --------------------------------+------------------------------------------- Changes (by ross@soi.city.ac.uk): * status: reopened => closed * resolution: => fixed Comment: All done, I think. -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/488#comment:8 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects
participants (1)
-
Hackage