[commit: ghc] ghc-8.2: users-guide: Standardize and repair all flag references (df5e225)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : ghc-8.2
Link       : http://ghc.haskell.org/trac/ghc/changeset/df5e2256d7345bc2785443ebea8ae6bd1873750e/ghc

>---------------------------------------------------------------

commit df5e2256d7345bc2785443ebea8ae6bd1873750e
Author: Patrick Dougherty <patrick.doc at ameritech.net>
Date:   Sun Jul 23 12:55:37 2017 -0400

    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
    
    (cherry picked from commit 44b090be9a6d0165e2281542a7c713da1799e885)


>---------------------------------------------------------------

df5e2256d7345bc2785443ebea8ae6bd1873750e
 docs/users_guide/8.2.1-notes.rst                   |   4 +-
 docs/users_guide/conf.py                           |  52 ++++---
 docs/users_guide/debug-info.rst                    |   3 +-
 docs/users_guide/debugging.rst                     |   8 +-
 docs/users_guide/editing-guide.rst                 |  26 +++-
 docs/users_guide/extending_ghc.rst                 |  65 ++++-----
 docs/users_guide/ffi-chap.rst                      |  14 +-
 docs/users_guide/ghci.rst                          |  38 ++---
 docs/users_guide/glasgow_exts.rst                  |  44 +++---
 docs/users_guide/packages.rst                      |  82 +++++------
 docs/users_guide/phases.rst                        |  84 +++++------
 docs/users_guide/profiling.rst                     |  89 +++++++-----
 docs/users_guide/runtime_control.rst               | 161 +++++++++------------
 docs/users_guide/separate_compilation.rst          |  48 +++---
 docs/users_guide/shared_libs.rst                   |  21 ++-
 docs/users_guide/sooner.rst                        |  34 ++---
 docs/users_guide/using-concurrent.rst              |  18 +--
 docs/users_guide/using-optimisation.rst            |  51 +++----
 docs/users_guide/using-warnings.rst                |   6 +-
 docs/users_guide/using.rst                         |  21 +--
 utils/mkUserGuidePart/Main.hs                      |   9 +-
 utils/mkUserGuidePart/Options/CompilerDebugging.hs |   4 +-
 utils/mkUserGuidePart/Options/FindingImports.hs    |   2 +-
 utils/mkUserGuidePart/Options/Interactive.hs       |   2 +-
 utils/mkUserGuidePart/Options/Linking.hs           |  17 ++-
 utils/mkUserGuidePart/Options/Misc.hs              |   5 +-
 utils/mkUserGuidePart/Options/Modes.hs             |   4 +-
 utils/mkUserGuidePart/Options/Packages.hs          |  30 ++--
 utils/mkUserGuidePart/Options/PhasePrograms.hs     |  24 +--
 utils/mkUserGuidePart/Options/PhaseSpecific.hs     |  20 +--
 utils/mkUserGuidePart/Options/Phases.hs            |   4 +-
 utils/mkUserGuidePart/Options/Plugin.hs            |   2 +-
 utils/mkUserGuidePart/Options/ProgramCoverage.hs   |   2 +-
 utils/mkUserGuidePart/Options/RedirectingOutput.hs |  10 +-
 utils/mkUserGuidePart/Options/Verbosity.hs         |   2 +-
 utils/mkUserGuidePart/Options/Warnings.hs          |  10 +-
 36 files changed, 521 insertions(+), 495 deletions(-)

Diff suppressed because of size. To see it, use:

    git diff-tree --root --patch-with-stat --no-color --find-copies-harder --ignore-space-at-eol --cc df5e2256d7345bc2785443ebea8ae6bd1873750e