On 05/20/2018 06:40 PM, Luc Van Oostenryck wrote: > Manpages are a good thing but as an input format it's a > nightmare. It would be nice to have a more adapted format > for it. > > So convert the manpage to reST and add to the Makefile what > is needed to generate the man page from it. and this patch doesn't do the Makefile part. :) > NB. This is still an experiment, but it's my intention to > make this the source file for the manpage. > > Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@xxxxxxxxx> > --- > > Note: This is not yet merged with the main sphinx patches > because I don't want the distros to be dependent on > sphinx to generate sparse's manpage. > I suppose that having the master version in .rst > and regenerate the troff/groff version at each change > would be an acceptable solution but still I don't like > this much. I would be more concerned about $USER not having sphinx than the distros being dependent on it. > Changes since v1: > * use the '.. option::' directive instead of option lists > > Documentation/.gitignore | 1 + > Documentation/conf.py | 1 + > Documentation/dev-options.rst | 4 + > Documentation/index.rst | 1 + > Documentation/sparse.rst | 462 ++++++++++++++++++++++++++++++++++ > 5 files changed, 469 insertions(+) > create mode 100644 Documentation/sparse.rst > > diff --git a/Documentation/sparse.rst b/Documentation/sparse.rst > new file mode 100644 > index 000000000..92f6a9eeb > --- /dev/null > +++ b/Documentation/sparse.rst > @@ -0,0 +1,462 @@ > +.. Sparse manpage by Josh Triplett > +.. highlight:: c > + [snip] > +DEBUG OPTIONS > +------------- > + > +.. option:: -fmem-report > + > + Report some statistics about memory allocation used by the tool. > + Should we add the -v options here? > + > +OTHER OPTIONS > +------------- > + > +.. option:: -fmax-warnings=COUNT > + > + Set the maximum number of displayed warnings > + to *COUNT*, which should be a numerical value or ``unlimited``. > + The default limit is 100. > + > + > +.. option:: -fmemcpy-max-count=COUNT > + > + Set the limit for the warnings given by ``-Wmemcpy-max-count``. > + A *COUNT* of ``unlimited`` or ``0`` will effectively disable the > + warning. The default limit is 100000. > + > + > +.. option:: -ftabstop=WIDTH > + > + Set the distance between tab stops. This helps sparse report correct > + column numbers in warnings or errors. If the value is less than 1 or > + greater than 100, the option is ignored. The default is 8. > + > + > + > +.. option:: -f[no-]unsigned-char, -f[no-]signed-char > + > + Let plain ``char`` be unsigned or signed. > + By default chars are signed. > + > + > +SEE ALSO > +======== > +:manpage:`cgcc(1)` > + > +HOMEPAGE > +======== > +`http://www.kernel.org/pub/software/devel/sparse/` I know that this is just a conversion from sparse.1, but that's not much of a homepage. The sparse wiki would be better IMO (sparse.wiki.kernel.org). > + > +MAILING LIST > +============ > +linux-sparse@xxxxxxxxxxxxxxx > + > +MAINTAINER > +========== > +Christopher Li <sparse@xxxxxxxxxxx> > Thanks. -- ~Randy -- To unsubscribe from this list: send the line "unsubscribe linux-sparse" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
