Re: [libvirt] [PATCH 1/2] Clarify virsh freecell manpage entry

--- tools/virsh.pod | 23 ++++++++++++++++++----- 1 files changed, 18 insertions(+), 5 deletions(-) diff --git a/tools/virsh.pod b/tools/virsh.pod index f0df4fd..b4deae8 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -401,11 +401,24 @@ B<virsh> list --title 0 Domain-0 running Mailserver 1 2 fedora paused -=item B<freecell> [B<cellno> | I<--all>] - -Prints the available amount of memory on the machine or within a -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<freecell> [{ [I<--cellno>] B<cellno> | I<--all> }] + +Prints the available amount of memory on the machine or within a NUMA +cell. The freecell command can provide one of three different +displays of available memory on the machine depending on the options +specified. With no options, it displays the total free memory on the +machine. With the --all option, it displays the free memory on each +node and the total free memory on the machine. Finally, with a +numeric argument or with --cellno it will display the free memory for +that node only.

+ + For example: + + freecell => total free memory on the machine + freecell --all => free memory on each node, and the total + freecell --cellno 0 => free memory on node 0 only + freecell 0 => free memory on node 0 only + freecell --cellno=0 => free memory on node 0 only