[GHC] #13980: Broken ghc-flag links in the users guide

[GHC]

#13980: Broken ghc-flag links in the users guide
-------------------------------------+-------------------------------------
        Reporter:  patrickdoc        |                Owner:  (none)
            Type:  bug               |               Status:  patch
        Priority:  normal            |            Milestone:
       Component:  Documentation     |              Version:  8.0.1
      Resolution:                    |             Keywords:
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):  Phab:D3778
       Wiki Page:                    |
-------------------------------------+-------------------------------------

Comment (by Ben Gamari <ben@…>):

 In [changeset:"44b090be9a6d0165e2281542a7c713da1799e885/ghc" 44b090b/ghc]:
 {{{
 #!CommitTicketReference repository="ghc"
 revision="44b090be9a6d0165e2281542a7c713da1799e885"
 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
 }}}

-- 
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/13980#comment:5>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler