Re: [Xen-devel] [PATCH] docs: add xenstore-ls man page

[David Vrabel <david.vrabel@xxxxxxxxxx>]

On 02/07/13 11:27, Ian Campbell wrote:
> On Tue, 2013-07-02 at 11:21 +0100, David Vrabel wrote:
>> From: David Vrabel <david.vrabel@xxxxxxxxxx>
>>
>> Signed-off-by: David Vrabel <david.vrabel@xxxxxxxxxx>
> 
> Cool, thanks.
> 
> Any reason not to do the others? (I'll assume lack of time...)

xenstore-ls -p output was confusing me and it probably confuses lots of
people.

I've not got around to the other pages yet.

> xenstore-ls is actually a pointer to the multifunction xenstore client
> utility (i.e. you can run "xenstore ls ..." too).
>
> Is the normal Unix idiom in this case to have a single manpage which
> documents all the various sub-functions.

man does the right thing.  Both "man xenstore-ls" and "man xenstore ls"
will get this man page.

I think its best to have separate pages for each (sub)utility -- keeps
each page short and free of clutter.  This is how the git man pages are
done.

> BTW I'm not suggesting you write them all but perhaps a single
> xenstore.pod.1 with placeholders for the others would be a better start?

An additional xenstore(1) man page summarizing the sub-commands would be
useful.  Again, ala git.

I'll work on this and the pages for the other xenstore utilities later,
when I have more time.

David

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel