[cfe-dev] scan-build man page

[Ted Kremenek]

Hi James,

The man page looks really great.  My main concern, however, is supporting divergent documents.  Ideally we want the documentation for scan-build, the man page, etc., to all be in sync.  My main concern about having a separate man page file is that someone is now responsible for keeping it up-to-date.  It's a bit of engineering, but I'd prefer we go in a direction where the man page and the scan-build documentation on the website (or at least part of it) were machine generated from some common description, which includes the common prose and the the checker options.

It sounds like you had a fairly mechanical process for generating the man page (you took scan-build's output and manually post processed it).  Do you think we could automate this with a script, so the man page could just be a product of the build?  Alternatively, since scan-build generates most of this text, maybe it could generate the options part of the man page itself (as an option to its output format), and have that output concatenated with some common preamble.  What do you think?

Cheers,
Ted

On May 3, 2012, at 2:45 PM, James K. Lowden <jklowden at schemamania.org> wrote:

> The attached file is a complete man page in mdoc format for
> scan-build.  
> 
> I used the text produced by running scan-build without options as a
> basis.  I cleaned up the wording and tried to arrange things
> in a somewhat predictable order while adhering to the standard man page
> format.  
> 
> --jkl
> <scan-build.1>_______________________________________________
> cfe-dev mailing list
> cfe-dev at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev