From 44b090be9a6d0165e2281542a7c713da1799e885 Mon Sep 17 00:00:00 2001 From: Patrick Dougherty Date: Sun, 23 Jul 2017 12:55:37 -0400 Subject: users-guide: Standardize and repair all flag references MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- utils/mkUserGuidePart/Options/ProgramCoverage.hs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'utils/mkUserGuidePart/Options/ProgramCoverage.hs') 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``)" -- cgit v1.2.1