From mboxrd@z Thu Jan 1 00:00:00 1970 From: David Vrabel Subject: Re: [PATCH] docs: add xenstore-ls man page Date: Tue, 2 Jul 2013 11:38:47 +0100 Message-ID: <51D2ADB7.9070900@citrix.com> References: <1372760475-26783-1-git-send-email-david.vrabel@citrix.com> <1372760870.27768.78.camel@zakaz.uk.xensource.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: In-Reply-To: <1372760870.27768.78.camel@zakaz.uk.xensource.com> List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Sender: xen-devel-bounces@lists.xen.org Errors-To: xen-devel-bounces@lists.xen.org To: Ian Campbell Cc: Ian Jackson , xen-devel@lists.xen.org List-Id: xen-devel@lists.xenproject.org On 02/07/13 11:27, Ian Campbell wrote: > On Tue, 2013-07-02 at 11:21 +0100, David Vrabel wrote: >> From: David Vrabel >> >> Signed-off-by: David Vrabel > > 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