Re: [PATCH v2] doc: the man page in reST

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sun, May 20, 2018 at 07:32:30PM -0700, Randy Dunlap wrote:
> On 05/20/2018 07:28 PM, Luc Van Oostenryck wrote:
> > On Sun, May 20, 2018 at 07:06:58PM -0700, Randy Dunlap wrote:
> >> On 05/20/2018 06:40 PM, Luc Van Oostenryck wrote:
> >>>
> >>> 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.
> > 
> > $USER not installing sparse via its distro?
> 
> Right.
> 
> > But the problem is the same, anyway.
> > 
> > Just to be clear, by the 'solution' here above I mean:
> > - use the .rst as the master version, where all changes are made
> > - still ship a sparse.1 file so people and distros don't depend on sphinx
> > - the maintainer must care to regenerate sparse.1 when sparse.rst is
> >   modified.
> 
> Sure, I got that.
> But IMO distros will not have a problem with using sphinx.
> Users might.

Yes, most probably.
My point of view is that only sparse developers who make changes to
the documentation need to have sphinx installed (and thanks, sphinx
is sooo much simpler to install than most other doc toolchains).

> >>> +DEBUG OPTIONS
> >>> +-------------
> >>> +
> >>> +.. option:: -fmem-report
> >>> +
> >>> +	Report some statistics about memory allocation used by the tool.
> >>> +
> >>
> >> Should we add the -v options here?
> > 
> > I hesitated myself the other day.
> > I almost moved this option to dev-options and then I forgot about it.
> > I really don't have a strong opinion about it.
> > On one side, most the dev-options (and this -fmem-report) have no
> > use for the normal sparse users, even the ones that uses it a lot.
> > On the other side, it's annoying to have two files/manpages for
> > these options.
> 
> I think that it makes sense to have two files/manpages and move some of
> the options from sparse.rst to dev-options.rst.

Perfect then.
 
Cheers,
-- Luc
--
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



[Index of Archives]     [Newbies FAQ]     [LKML]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Trinity Fuzzer Tool]

  Powered by Linux