Opened 4 years ago

Closed 4 years ago

Last modified 11 months ago

#10879 closed bug (fixed)

base is not included in the haddock index

Reported by: Feuerbach Owned by:
Priority: normal Milestone: 7.10.3
Component: Build System (make) Version: 7.10.2
Keywords: Cc:
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: None/Unknown Test Case:
Blocked By: Blocking:
Related Tickets: Differential Rev(s): Phab:D1247
Wiki Page:

Description

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

Change History (6)

comment:2 Changed 4 years ago by thomie

Differential Rev(s): Phab:D1247
Milestone: 8.0.1

comment:3 Changed 4 years ago by Thomas Miedema <thomasmiedema@…>

In 48746ff/ghc:

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

comment:4 Changed 4 years ago by thomie

Milestone: 8.0.17.10.3
Status: newmerge

Should be fixed in the next release. Thanks for the report.

comment:5 Changed 4 years ago by bgamari

Resolution: fixed
Status: mergeclosed

Merged to ghc-7.10.

comment:6 Changed 11 months ago by bgamari

Component: Build SystemBuild System (make)

The new Hadrian build system has been merged. Relabeling the tickets concerning the legacy make build system to prevent confusion.

Note: See TracTickets for help on using tickets.