[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [PATCH] virsh: consolidate memtune docs



* tools/virsh.pod (memtune): Drop second copy, fill to 80 columns,
enhance wording.
---

Seeing memtune twice in the man page is a bit confusing.

This patch doesn't touch the pending issue of whether --min_guarantee
makes sense, or should be deleted before it becomes a pre-mature
API addition.

Also, should memtune be changed to use VSH_OT_INT rather than
VSH_OT_STRING?  The current 'virsh help memtune' output looks
weird:

  OPTIONS
    [--domain] <string>  domain name, id or uuid
    --hard_limit <string>  Max memory in kilobytes
    --soft_limit <string>  Memory during contention in kilobytes
    --swap_hard_limit <string>  Max swap in kilobytes
    --min_guarantee <string>  Min guaranteed memory in kilobytes

 tools/virsh.pod |   15 ++++++++-------
 1 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 943a563..bc68146 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -513,13 +513,14 @@ Change the maximum memory allocation limit in the guest domain. This should
 not change the current memory use. The memory limit is specified in
 kilobytes.

-=item B<memtune> I<domain-id>
-
-Displays the domain memory parameters.
-
-=item B<memtune> I<domain-id> optional I<--hard-limit> B<kilobytes> optional I<--soft-limit> B<kilobytes> optional I<--swap-hard-limit> B<kilobytes> -I<--min-guarantee> B<kilobytes>
-
-Allows you to set the domain memory parameters. LXC and QEMU/KVM supports these parameters.
+=item B<memtune> I<domain-id> optional I<--hard-limit> B<kilobytes>
+optional I<--soft-limit> B<kilobytes> optional I<--swap-hard-limit>
+B<kilobytes> -I<--min-guarantee> B<kilobytes>
+
+Allows you to display or set the domain memory parameters. Without
+flags, the current settings are displayed; with a flag, the
+appropriate limit is adjusted if supported by the hypervisor.  LXC and
+QEMU/KVM supports I<--hard-limit>, I<--soft-limit>, and I<--swap-hard-limit>.

 =item B<setvcpus> I<domain-id> I<count>

-- 
1.7.2.3


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]