[GHC] #11654: User Guide: Generate command line options table from ghc-flags directives

[GHC]

#11654: User Guide: Generate command line options table from ghc-flags directives
-------------------------------------+-------------------------------------
        Reporter:  bgamari           |                Owner:  patrickdoc
            Type:  task              |               Status:  new
        Priority:  normal            |            Milestone:  8.4.1
       Component:  Documentation     |              Version:  7.10.3
      Resolution:                    |             Keywords:
Operating System:  Unknown/Multiple  |         Architecture:
                                     |  Unknown/Multiple
 Type of failure:  None/Unknown      |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------

Comment (by patrickdoc):

 I have a proof of concept for this. It's looking like the best plan is to
 wrap the table info into the declaration of a flag, something like:

 {{{
 .. ghc-flag:: -v
     :shortdesc: verbose mode (equivalent to -v3)
     :type: dynamic
     :reverse: (none for this flag)

     Longer decription here...
 }}}

 Which would render as:

 **-v**
    Longer description here

 and then the table could look like,

 | **-v** | verbose mode (equivalent to -v3) | dynamic |    |

 ---

 The main tasks remaining are figuring out the formatting of the table,
 determining what
 variables actually need to be passed around, and moving all the info into
 the flag declarations from the `mkUserGuidePart` files.

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