[Cluster-devel] cluster3 man pages

[Fabio M. Di Nitto <fdinitto@redhat.com>]

On 1/21/2010 6:35 PM, David Teigland wrote:
> On Thu, Jan 21, 2010 at 05:52:14PM +0100, Fabio M. Di Nitto wrote:
>> On 1/21/2010 5:28 PM, David Teigland wrote:
>>> In the process of updating content in my cluster3 man pages, I also tried
>>> to align the style/structure/etc with this stanard:
>>>
>>> http://www.kernel.org/doc/man-pages/online/pages/man7/man-pages.7.html
>>>
>>> I think it would be nice to try to sync up all our man pages with those
>>> conventions, it's been somewhat ad hoc in the past.  The following which
>>> I've updated should be mostly in line with the standard, so you can copy
>>> bits from them:
>>
>> would it be possible to have a list of man pages that needs updating
>> instead? I am not man page expert, nor I have a gigantic interest to
>> learn the whole standard behind it but I can fix mine if I know they are
>> broken and what?s broken.
> 
> The main issue is getting the content up to date, of course; many seem to
> be out of date to one degree or another.

Absolutely agreed.

>  Standardizing the
> structure/style at the same time is just a suggestion.
>

Of course, I like the idea to be able to generate html man pages (maybe
even at build time). If you can help us spotting the format changes that
need to be done, that would speed up greatly.

> I also forgot to mention that it would be good to update cluster.rng
> descriptions at the same time.  We want cluster.rng descriptions to be
> only 1-2 line fragments, followed by a man page reference where more
> details can be found.  (This is so the docs people can generate a
> cluster.conf reference table.)

Indeed.

You made a lot of commits there, should be easy to follow your as example.

Fabio