[libvirt] [PATCH] docs: document freecell --all

Based on a smaller patch developed by Moritoshi Oshiro: https://bugzilla.redhat.com/show_bug.cgi?id=693963 * tools/virsh.pod (freecell): Mention all, and clarify that optional cellno requires --cellno. --- I think this is the first case where virsh.pod is trying to convey mutually exclusive options; does the resulting layout look reasonable? tools/virsh.pod | 5 +++-- 1 files changed, 3 insertions(+), 2 deletions(-) diff --git a/tools/virsh.pod b/tools/virsh.pod index f4bd294..2e98d5b 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -314,10 +314,11 @@ crashed. =back -=item B<freecell> optional I<cellno> +=item B<freecell> optional { I<--cellno> B<cellno> | I<--all> } Prints the available amount of memory on the machine or within a -NUMA cell if I<cellno> is provided. +NUMA cell if I<cellno> is provided. If I<--all> is provided instead +of I<--cellno>, then show the information on all NUMA cells. =item B<cpu-baseline> I<FILE> -- 1.7.4

On Wed, Apr 06, 2011 at 11:28:37AM -0600, Eric Blake wrote:
Based on a smaller patch developed by Moritoshi Oshiro: https://bugzilla.redhat.com/show_bug.cgi?id=693963
* tools/virsh.pod (freecell): Mention all, and clarify that optional cellno requires --cellno. ---
I think this is the first case where virsh.pod is trying to convey mutually exclusive options; does the resulting layout look reasonable?
I applied and checked with man, looks fine to me, ACK, daniel -- Daniel Veillard | libxml Gnome XML XSLT toolkit http://xmlsoft.org/ daniel@veillard.com | Rpmfind RPM search engine http://rpmfind.net/ http://veillard.com/ | virtualization library http://libvirt.org/

On 04/10/2011 09:12 PM, Daniel Veillard wrote:
On Wed, Apr 06, 2011 at 11:28:37AM -0600, Eric Blake wrote:
Based on a smaller patch developed by Moritoshi Oshiro: https://bugzilla.redhat.com/show_bug.cgi?id=693963
* tools/virsh.pod (freecell): Mention all, and clarify that optional cellno requires --cellno. ---
I think this is the first case where virsh.pod is trying to convey mutually exclusive options; does the resulting layout look reasonable?
I applied and checked with man, looks fine to me,
ACK,
Thanks; pushed. -- Eric Blake eblake@redhat.com +1-801-349-2682 Libvirt virtualization library http://libvirt.org
participants (2)
-
Daniel Veillard
-
Eric Blake