diff options
| author | Patrick Dougherty <patrick.doc@ameritech.net> | 2017-07-23 12:55:37 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2017-07-23 15:47:21 -0400 |
| commit | 44b090be9a6d0165e2281542a7c713da1799e885 (patch) | |
| tree | 51bc316cb5a86810efbbe3ee606b9cdf8a82cd6e /utils/mkUserGuidePart/Options/ProgramCoverage.hs | |
| parent | d4e97212fdcb6127d750577aa7f2d709fee27d56 (diff) | |
| download | haskell-44b090be9a6d0165e2281542a7c713da1799e885.tar.gz | |
users-guide: Standardize and repair all flag references
This patch does three things:
1.) It simplifies the flag parsing code in `conf.py` to properly display
flag definitions created by `.. (ghc|rts)-flag::`. Additionally, all flag
references must include the associated arguments. Documentation has been
added to `editing-guide.rst` to explain this.
2.) It normalizes all flag definitions to a similar format. Notably, all
instances of `<>` have been replaced with `⟨⟩`. All references across the
users guide have been updated to match.
3.) It fixes a couple issues with the flag reference table's generation code,
which did not handle comma separated flags in the same cell and did not
properly reference flags with arguments.
Test Plan:
`SPHINXOPTS = -n` to activate "nitpicky" mode, which reports all broken
references. All remaining errors are references to flags without any
documentation.
Reviewers: austin, bgamari
Reviewed By: bgamari
Subscribers: rwbarton, thomie
GHC Trac Issues: #13980
Differential Revision: https://phabricator.haskell.org/D3778
Diffstat (limited to 'utils/mkUserGuidePart/Options/ProgramCoverage.hs')
| -rw-r--r-- | utils/mkUserGuidePart/Options/ProgramCoverage.hs | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/utils/mkUserGuidePart/Options/ProgramCoverage.hs b/utils/mkUserGuidePart/Options/ProgramCoverage.hs index c7b2894668..8da7df37b7 100644 --- a/utils/mkUserGuidePart/Options/ProgramCoverage.hs +++ b/utils/mkUserGuidePart/Options/ProgramCoverage.hs @@ -9,7 +9,7 @@ programCoverageOptions = "Turn on Haskell program coverage instrumentation" , flagType = DynamicFlag } - , flag { flagName = "-hpcdir dir" + , flag { flagName = "-hpcdir ⟨dir⟩" , flagDescription = "Directory to deposit ``.mix`` files during compilation "++ "(default is ``.hpc``)" |