Opened 2 years ago

Last modified 9 months ago

#12619 new task

Allow users guide to be built independently from GHC

Reported by: bgamari Owned by:
Priority: normal Milestone: 8.8.1
Component: Compiler Version: 8.0.1
Keywords: newcomer Cc:
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 (last modified by bgamari)

At HIW 2016 it was suggested that this would greatly reduce the friction to contributing users guide fixes.

Moreover, this would make our readthedocs mirror significantly easier to maintain.

Change History (9)

comment:1 Changed 2 years ago by bgamari

Milestone: 8.2.1

comment:2 Changed 2 years ago by bgamari

The only real sticky spot in this task is utils/mkUserGuideParts. It is a utility compiled by stage1 which takes a Haskell data structure containing bits of ReST and outputs ReST sources for the manpage and flags table. Ideally we would have a Sphinx extension to handle this but my previous attempts at this have been thwarted by various annoying technical limitations of Sphinx.

The alternative would be to simply build mkUserGuideParts with the stage0 compiler (either by default or with a build system setting).

comment:3 Changed 2 years ago by bgamari

Description: modified (diff)

comment:4 Changed 2 years ago by simonpj

Indeed! Why not always build mkUserGuideParts with stage0? It's just a utility, right? Absolutely no need to build it with stage1.

comment:5 Changed 2 years ago by thomie

The reason we don't build mkUserGuideParts with stage0 currently is that it depends on the ghc library. Main.hs import DynFlags, although currently only to get to glasgowExtsFlags.

comment:6 Changed 2 years ago by bgamari

Description: modified (diff)

This would perhaps be made easier by #11654.

comment:7 Changed 21 months ago by bgamari

Milestone: 8.2.18.4.1

Given that 8.2.1-rc1 is imminent, I'm bumping these off to the 8.4

comment:8 Changed 11 months ago by bgamari

Milestone: 8.4.18.6.1

This ticket won't be resolved in 8.4; remilestoning for 8.6. Do holler if you are affected by this or would otherwise like to work on it.

comment:9 Changed 9 months ago by bgamari

Keywords: newcomer added
Milestone: 8.6.18.8.1

For the record, I believe this should now be much easier as mkUserGuideParts has been removed. It would likely be best (and easiest!) to start with Hadrian, however.

Note: See TracTickets for help on using tickets.