[libvirt] [PATCH 0/3] Doc fixes
*** BLURB HERE *** Osier Yang (3): virsh: Fix the string breaking style Doc: Improve the document for nodesuspend Doc: Add "note" for node-memory-tune tools/virsh-host.c | 6 +++--- tools/virsh.pod | 16 +++++++++++----- 2 files changed, 14 insertions(+), 8 deletions(-) -- 1.8.1.4
--- Pushed under trivial rule. --- tools/virsh-host.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/virsh-host.c b/tools/virsh-host.c index 967bd52..3438ae7 100644 --- a/tools/virsh-host.c +++ b/tools/virsh-host.c @@ -516,7 +516,7 @@ static const vshCmdInfo info_nodesuspend[] = { }, {.name = "desc", .data = N_("Suspend the host node for a given time duration " - "and attempt to resume thereafter.") + "and attempt to resume thereafter.") }, {.name = NULL} }; @@ -525,8 +525,8 @@ static const vshCmdOptDef opts_node_suspend[] = { {.name = "target", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, - .help = N_("mem(Suspend-to-RAM), " - "disk(Suspend-to-Disk), hybrid(Hybrid-Suspend)") + .help = N_("mem(Suspend-to-RAM), disk(Suspend-to-Disk), " + "hybrid(Hybrid-Suspend)") }, {.name = "duration", .type = VSH_OT_INT, -- 1.8.1.4
Explicitly lists the possible values for "--target" option; Gets rid of the confused strings like "Suspend-to-RAM"; Emphasises the node *has to* be suspended in the time duration specified by "--duration". And rewords the entire document a bit according to the API's implementation and document. --- tools/virsh.pod | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/tools/virsh.pod b/tools/virsh.pod index 8839e3c..35a7292 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -297,11 +297,14 @@ If I<cell> is specified, this will prints specified cell statistics only. =item B<nodesuspend> [I<target>] [I<duration>] -Puts the node (host machine) into a system-wide sleep state such as -Suspend-to-RAM, Suspend-to-Disk or Hybrid-Suspend and sets up a -Real-Time-Clock interrupt to fire (to wake up the node) after a time delay -specified by the 'duration' parameter. The duration time should be -at least 60 seconds. +Puts the node (host machine) into a system-wide sleep state and schedule +the node's Real-Time-Clock interrupt to resume the node after the time +duration specified by I<duration> is out. +I<target> specifies the state to which the host will be suspended to, it +can be "mem"(suspended to RAM), "disk"(suspended to disk), or "hybrid" +(suspended to both RAM and disk). I<duration> specifies the time duration +in seconds for which the host has to be suspended, it should be at least +60 seconds. =item B<node-memory-tune> [I<shm-pages-to-scan>] [I<shm-sleep-millisecs>] -- 1.8.1.4
On 01/22/2014 07:55 AM, Osier Yang wrote:
Explicitly lists the possible values for "--target" option; Gets rid of the confused strings like "Suspend-to-RAM"; Emphasises the node *has to* be suspended in the time duration specified by "--duration". And rewords the entire document a bit according to the API's implementation and document. --- tools/virsh.pod | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/tools/virsh.pod b/tools/virsh.pod index 8839e3c..35a7292 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -297,11 +297,14 @@ If I<cell> is specified, this will prints specified cell statistics only.
=item B<nodesuspend> [I<target>] [I<duration>]
-Puts the node (host machine) into a system-wide sleep state such as -Suspend-to-RAM, Suspend-to-Disk or Hybrid-Suspend and sets up a -Real-Time-Clock interrupt to fire (to wake up the node) after a time delay -specified by the 'duration' parameter. The duration time should be -at least 60 seconds. +Puts the node (host machine) into a system-wide sleep state and schedule +the node's Real-Time-Clock interrupt to resume the node after the time +duration specified by I<duration> is out.
+I<target> specifies the state to which the host will be suspended to, it +can be "mem"(suspended to RAM), "disk"(suspended to disk), or "hybrid" +(suspended to both RAM and disk). I<duration> specifies the time duration
This would look better with spaces in front of the parentheses. I think 'suspend' instead of 'suspended' would look better inside the parentheses too.
+in seconds for which the host has to be suspended, it should be at least +60 seconds.
=item B<node-memory-tune> [I<shm-pages-to-scan>] [I<shm-sleep-millisecs>]
ACK Jan
On 22/01/14 17:32, Ján Tomko wrote:
On 01/22/2014 07:55 AM, Osier Yang wrote:
Explicitly lists the possible values for "--target" option; Gets rid of the confused strings like "Suspend-to-RAM"; Emphasises the node *has to* be suspended in the time duration specified by "--duration". And rewords the entire document a bit according to the API's implementation and document. --- tools/virsh.pod | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/tools/virsh.pod b/tools/virsh.pod index 8839e3c..35a7292 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -297,11 +297,14 @@ If I<cell> is specified, this will prints specified cell statistics only.
=item B<nodesuspend> [I<target>] [I<duration>]
-Puts the node (host machine) into a system-wide sleep state such as -Suspend-to-RAM, Suspend-to-Disk or Hybrid-Suspend and sets up a -Real-Time-Clock interrupt to fire (to wake up the node) after a time delay -specified by the 'duration' parameter. The duration time should be -at least 60 seconds. +Puts the node (host machine) into a system-wide sleep state and schedule +the node's Real-Time-Clock interrupt to resume the node after the time +duration specified by I<duration> is out. +I<target> specifies the state to which the host will be suspended to, it +can be "mem"(suspended to RAM), "disk"(suspended to disk), or "hybrid" +(suspended to both RAM and disk). I<duration> specifies the time duration This would look better with spaces in front of the parentheses. I think 'suspend' instead of 'suspended' would look better inside the parentheses too.
Pushed with above suggestions, thanks for the reviewing. Osier
To let the user know the command onlys work for KSM under Linux. --- tools/virsh.pod | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tools/virsh.pod b/tools/virsh.pod index 35a7292..07f4397 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -317,6 +317,9 @@ different numa nodes can be merged. When set to 0, only pages which physically reside in the memory area of same NUMA node can be merged. When set to 1, pages from all nodes can be merged. Default to 1. +B<Note>: Currently the "shared memory service" only means KSM (Kernel Samepage +Merging). + =item B<capabilities> Print an XML document describing the capabilities of the hypervisor -- 1.8.1.4
On 01/22/2014 07:55 AM, Osier Yang wrote:
To let the user know the command onlys work for KSM under Linux. --- tools/virsh.pod | 3 +++ 1 file changed, 3 insertions(+)
diff --git a/tools/virsh.pod b/tools/virsh.pod index 35a7292..07f4397 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -317,6 +317,9 @@ different numa nodes can be merged. When set to 0, only pages which physically reside in the memory area of same NUMA node can be merged. When set to 1, pages from all nodes can be merged. Default to 1.
+B<Note>: Currently the "shared memory service" only means KSM (Kernel Samepage +Merging). + =item B<capabilities>
Print an XML document describing the capabilities of the hypervisor
ACK If you're touching this, you should also add 'shm-merge-across-nodes' to the list of node-memory-tunes parameters a few lines above. Jan
On 22/01/14 17:33, Ján Tomko wrote:
On 01/22/2014 07:55 AM, Osier Yang wrote:
To let the user know the command onlys work for KSM under Linux. --- tools/virsh.pod | 3 +++ 1 file changed, 3 insertions(+)
diff --git a/tools/virsh.pod b/tools/virsh.pod index 35a7292..07f4397 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -317,6 +317,9 @@ different numa nodes can be merged. When set to 0, only pages which physically reside in the memory area of same NUMA node can be merged. When set to 1, pages from all nodes can be merged. Default to 1.
+B<Note>: Currently the "shared memory service" only means KSM (Kernel Samepage +Merging). + =item B<capabilities>
Print an XML document describing the capabilities of the hypervisor
ACK
If you're touching this, you should also add 'shm-merge-across-nodes' to the list of node-memory-tunes parameters a few lines above.
Oh, right, I pushed with it's added. Thanks. Osier
participants (2)
-
Ján Tomko -
Osier Yang