Greg Mann created MESOS-4557:
--------------------------------

             Summary: Automatically generate command-line flag documentation
                 Key: MESOS-4557
                 URL: https://issues.apache.org/jira/browse/MESOS-4557
             Project: Mesos
          Issue Type: Improvement
          Components: documentation
            Reporter: Greg Mann


To ensure that the command-line flag documentation in {{configuration.md}} 
stays in sync with the help strings in the various {{flags.cpp}} files, it 
could be beneficial to automate the generation of those docs. Such a script 
could be run as part of the build process, ensuring that changes to the help 
strings would show up in the documentation as well.

In addition to parsing and formatting the help strings for display as HTML, 
this could also involve specifying collections of flags to be grouped together 
in order to provide logical structure to the {{configuration.md}} documentation.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to