[Tracking] Documenting the Expected Undocumented Flags
This file contains many compiler flags that are undocumented. The goal is document every single one of them.
Building the docs
The source of the GHC users guide is found in the GHC repository in the
In order to build it, please follow the first three steps listed at ghc.dev, and then run
$ hadrian/build _build/docs/html/users_guide/index.html
You will then find the index file at
Merge Requests Etiquette
When creating a merge request:
- Insert this text at the bottom of the pull-request:
- Mention @core-libraries (by simply writing it out) at the end of the description. This will greatly help the review process.
- Insert the
~documentationlabel. You can use the quick action
/label ~documentationat the end of the MR's description when creating it for the first time;
- Set the milestone to
All those steps are important to ensure consistency in our efforts.