[GHC] #10879: base is not included in the haddock index
#10879: base is not included in the haddock index -------------------------------------+------------------------------------- Reporter: Feuerbach | Owner: Type: bug | Status: new Priority: normal | Milestone: Component: Build | Version: 7.10.2 System | Keywords: | Operating System: Unknown/Multiple Architecture: | Type of failure: None/Unknown Unknown/Multiple | Test Case: | Blocked By: Blocking: | Related Tickets: Differential Revisions: | -------------------------------------+------------------------------------- It appears that starting from ghc 7.10 base is no longer present in the haddock html index distributed with ghc. {{{ % grep -c base ~/.stack/programs/x86_64-linux/ghc-7.8.4/share/doc/ghc/html/libraries/index.html 1 % grep -c base ~/.stack/programs/x86_64-linux/ghc-7.10.2/share/doc/ghc/html/libraries/index.html 0 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10879> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10879: base is not included in the haddock index -------------------------------------+------------------------------------- Reporter: Feuerbach | Owner: Type: bug | Status: new Priority: normal | Milestone: Component: Build System | Version: 7.10.2 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Revisions: -------------------------------------+------------------------------------- Comment (by hvr): Curiously, it's contained in here: http://downloads.haskell.org/~ghc/7.10.2/docs/html/libraries/index.html -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10879#comment:1> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10879: base is not included in the haddock index -------------------------------------+------------------------------------- Reporter: Feuerbach | Owner: Type: bug | Status: new Priority: normal | Milestone: 8.0.1 Component: Build System | Version: 7.10.2 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Revisions: Phab:D1247 -------------------------------------+------------------------------------- Changes (by thomie): * differential: => Phab:D1247 * milestone: => 8.0.1 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10879#comment:2> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10879: base is not included in the haddock index -------------------------------------+------------------------------------- Reporter: Feuerbach | Owner: Type: bug | Status: new Priority: normal | Milestone: 8.0.1 Component: Build System | Version: 7.10.2 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Revisions: Phab:D1247 -------------------------------------+------------------------------------- Comment (by Thomas Miedema <thomasmiedema@…>): In [changeset:"48746fff87f79a3c7cc128816f9e84bf4e578445/ghc" 48746ff/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="48746fff87f79a3c7cc128816f9e84bf4e578445" Docs: make sure all libs are included in index.html (#10879) During the build, when HADDOCK_DOCS=YES, the command 'cd libraries && sh gen_contents_index --intree' is run, which calls haddock to generate the haddock index at 'libraries/dist-haddock/index.html'. What it did before was check the ./packages file for all libraries. The problem is that 'base' and 'ghc-prim' were folded into the main repo some time ago, hence don't have an entry in the ./packages file anymore. As a result, 'base' and 'ghc-prim' were missing from the index.html file. It now simply runs haddock on all the all the `.haddock` files in the libraries directory. The only risk is that this could include the extra libraries in the index.html, if you ever built them in the past (with BUILD_EXTRA_PKGS=YES), even though now you want to exclude them (with BUILD_EXTRA_PKGS=NO). gen_contents_index doesn't have access to build system variables though (PACKAGES_STAGE1+PACKAGES_STAGE2), so fixing this would be a little bit fiddly. Test Plan: 'make libraries/dist-haddock/index.html && grep -q base libraries/dist-haddock/index.html && echo ok' Reviewed by: austin Differential Revision: https://phabricator.haskell.org/D1247 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10879#comment:3> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10879: base is not included in the haddock index -------------------------------------+------------------------------------- Reporter: Feuerbach | Owner: Type: bug | Status: merge Priority: normal | Milestone: 7.10.3 Component: Build System | Version: 7.10.2 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Revisions: Phab:D1247 -------------------------------------+------------------------------------- Changes (by thomie): * status: new => merge * milestone: 8.0.1 => 7.10.3 Comment: Should be fixed in the next release. Thanks for the report. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10879#comment:4> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10879: base is not included in the haddock index -------------------------------------+------------------------------------- Reporter: Feuerbach | Owner: Type: bug | Status: closed Priority: normal | Milestone: 7.10.3 Component: Build System | Version: 7.10.2 Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Revisions: Phab:D1247 -------------------------------------+------------------------------------- Changes (by bgamari): * status: merge => closed * resolution: => fixed Comment: Merged to `ghc-7.10`. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10879#comment:5> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
participants (1)
-
GHC