This patch adds some more consistency in the parameter names
displayed in various ganeti man pages.
Signed-off-by: Federico Morg Pareschi <m...@google.com>
---
man/gnt-group.rst | 8 ++++----
man/gnt-instance.rst | 16 ++++++++--------
man/gnt-job.rst | 6 +++---
man/gnt-network.rst | 6 +++---
man/gnt-node.rst | 14 +++++++-------
man/gnt-os.rst | 5 +++--
6 files changed, 28 insertions(+), 27 deletions(-)
diff --git a/man/gnt-group.rst b/man/gnt-group.rst
index 1c313b2..afe01e5 100644
--- a/man/gnt-group.rst
+++ b/man/gnt-group.rst
@@ -188,7 +188,7 @@ EVACUATE
~~~~~~~~
| **evacuate** [\--submit] [\--print-jobid] [\--sequential] [\--force-failover]
-| [\--iallocator *NAME*] [\--to *GROUP*...] {*group*}
+| [\--iallocator *name*] [\--to *GROUP*...] {*group*}
This command will move all instances out of the given node group.
Instances are placed in a new group by an iallocator, either given on
@@ -219,7 +219,7 @@ Tags
ADD-TAGS
^^^^^^^^
-**add-tags** [\--from *file*] {*groupname*} {*tag*...}
+**add-tags** [\--from *file*] {*group*} {*tag*...}
Add tags to the given node group. If any of the tags contains invalid
characters, the entire operation will abort.
@@ -233,14 +233,14 @@ stdin.
LIST-TAGS
^^^^^^^^^
-**list-tags** {*groupname*}
+**list-tags** {*group*}
List the tags of the given node group.
REMOVE-TAGS
^^^^^^^^^^^
-**remove-tags** [\--from *file*] {*groupname*} {*tag*...}
+**remove-tags** [\--from *file*] {*group*} {*tag*...}
Remove tags from the given node group. If any of the tags are not
existing on the node, the entire operation will abort.
diff --git a/man/gnt-instance.rst b/man/gnt-instance.rst
index a29fd79..94db520 100644
--- a/man/gnt-instance.rst
+++ b/man/gnt-instance.rst
@@ -1523,7 +1523,7 @@ RENAME
^^^^^^
| **rename** [\--no-ip-check] [\--no-name-check] [\--submit] [\--print-jobid]
-| {*instance*} {*new\_name*}
+| {*old\_name*} {*new\_name*}
Renames the given instance. The instance must be stopped when running
this command. The requirements for the new name are the same as for
@@ -1559,7 +1559,7 @@ STARTUP
| [{-H|\--hypervisor-parameters} ``key=value...``]
| [{-B|\--backend-parameters} ``key=value...``]
| [\--submit] [\--print-jobid] [\--paused]
-| {*name*...}
+| {*instance*...}
Starts one or more instances, depending on the following options. The
four available modes are:
@@ -1657,7 +1657,7 @@ SHUTDOWN
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
| [\--submit] [\--print-jobid]
-| {*name*...}
+| {*instance*...}
Stops one or more instances. If the instance cannot be cleanly stopped
during a hardcoded interval (currently 2 minutes), it will forcibly
@@ -1711,7 +1711,7 @@ REBOOT
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
| [\--submit] [\--print-jobid]
-| [*name*...]
+| [*instance*...]
Reboots one or more instances. The type of reboot depends on the value
of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
@@ -2193,7 +2193,7 @@ CHANGE-GROUP
^^^^^^^^^^^^
| **change-group** [\--submit] [\--print-jobid]
-| [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
+| [\--iallocator *name*] [\--to *group*...] {*instance*}
This command moves an instance to another node group. The move is
calculated by an iallocator, either given on the command line or as a
@@ -2218,7 +2218,7 @@ Tags
ADD-TAGS
^^^^^^^^
-**add-tags** [\--from *file*] {*instancename*} {*tag*...}
+**add-tags** [\--from *file*] {*instance*} {*tag*...}
Add tags to the given instance. If any of the tags contains invalid
characters, the entire operation will abort.
@@ -2232,14 +2232,14 @@ as stdin.
LIST-TAGS
^^^^^^^^^
-**list-tags** {*instancename*}
+**list-tags** {*instance*}
List the tags of the given instance.
REMOVE-TAGS
^^^^^^^^^^^
-**remove-tags** [\--from *file*] {*instancename*} {*tag*...}
+**remove-tags** [\--from *file*] {*instance*} {*tag*...}
Remove tags from the given instance. If any of the tags are not
existing on the node, the entire operation will abort.
diff --git a/man/gnt-job.rst b/man/gnt-job.rst
index ceb9453..20fa97f 100644
--- a/man/gnt-job.rst
+++ b/man/gnt-job.rst
@@ -72,7 +72,7 @@ includes both. To skip a confirmation, pass ``--force``.
INFO
~~~~
-**info** {*id*...}
+**info** {*job-id*...}
Show detailed information about the given job id(s). If no job id
is given, all jobs are examined (warning, this is a lot of
@@ -134,7 +134,7 @@ Lists available fields for jobs.
WAIT
~~~~~
-**wait** {id}
+**wait** {*job-id*}
Wait for the job by the given *id* to finish; do not produce
any output.
@@ -142,7 +142,7 @@ any output.
WATCH
~~~~~
-**watch** {id}
+**watch** {(*job-id*}
This command follows the output of the job by the given *id* and
prints it.
diff --git a/man/gnt-network.rst b/man/gnt-network.rst
index bfac86e..c5779c5 100644
--- a/man/gnt-network.rst
+++ b/man/gnt-network.rst
@@ -175,7 +175,7 @@ Tags
ADD-TAGS
^^^^^^^^
-**add-tags** [\--from *file*] {*networkname*} {*tag*...}
+**add-tags** [\--from *file*] {*network*} {*tag*...}
Add tags to the given network. If any of the tags contains invalid
characters, the entire operation will abort.
@@ -189,14 +189,14 @@ stdin.
LIST-TAGS
^^^^^^^^^
-**list-tags** {*networkname*}
+**list-tags** {*network*}
List the tags of the given network.
REMOVE-TAGS
^^^^^^^^^^^
-**remove-tags** [\--from *file*] {*networkname*} {*tag*...}
+**remove-tags** [\--from *file*] {*network*} {*tag*...}
Remove tags from the given network. If any of the tags are not existing
on the network, the entire operation will abort.
diff --git a/man/gnt-node.rst b/man/gnt-node.rst
index 0940d7f..94f762a 100644
--- a/man/gnt-node.rst
+++ b/man/gnt-node.rst
@@ -30,7 +30,7 @@ ADD
| [\--disk-state *diskstate*]
| [\--hypervisor-state *hvstate*]
| [\--no-node-setup]
-| {*nodename*}
+| {*node*}
Adds the given node to the cluster.
@@ -96,7 +96,7 @@ EVACUATE
~~~~~~~~
| **evacuate** [-f] [\--early-release] [\--submit] [\--print-jobid]
-| [{-I|\--iallocator} *NAME* \| {-n|\--new-secondary} *destination\_node*]
+| [{-I|\--iallocator} *name* \| {-n|\--new-secondary} *destination\_node*]
| [--ignore-soft-errors]
| [{-p|\--primary-only} \| {-s|\--secondary-only} ]
| {*node*}
@@ -264,7 +264,7 @@ only the given nodes will be listed.
LIST-DRBD
~~~~~~~~~
-**list-drbd** [\--no-headers] [\--separator=*SEPARATOR*] node
+**list-drbd** [\--no-headers] [\--separator=*SEPARATOR*] *node*
Lists the mapping of DRBD minors for a given node. This outputs a static
list of fields (it doesn't accept the ``--output`` option), as follows:
@@ -381,7 +381,7 @@ Example (setting the node back to online and master
candidate)::
REMOVE
~~~~~~
-**remove** {*nodename*}
+**remove** {*node*}
Removes a node from the cluster. Instances must be removed or
migrated to another cluster before.
@@ -656,7 +656,7 @@ Tags
ADD-TAGS
^^^^^^^^
-**add-tags** [\--from *file*] {*nodename*} {*tag*...}
+**add-tags** [\--from *file*] {*node*} {*tag*...}
Add tags to the given node. If any of the tags contains invalid
characters, the entire operation will abort.
@@ -670,14 +670,14 @@ interpreted as stdin.
LIST-TAGS
^^^^^^^^^
-**list-tags** {*nodename*}
+**list-tags** {*node*}
List the tags of the given node.
REMOVE-TAGS
^^^^^^^^^^^
-**remove-tags** [\--from *file*] {*nodename*} {*tag*...}
+**remove-tags** [\--from *file*] {*node*} {*tag*...}
Remove tags from the given node. If any of the tags are not
existing on the node, the entire operation will abort.
diff --git a/man/gnt-os.rst b/man/gnt-os.rst
index 6ee82bd..65c6df3 100644
--- a/man/gnt-os.rst
+++ b/man/gnt-os.rst
@@ -46,12 +46,13 @@ are or are not valid.
INFO
~~~~
-**info**
+**info** {*OS*}
This command will list detailed information about each OS available
in the cluster, including its validity status, the supported API
versions, the supported parameters and variants (if any), and their
-documentation, etc.
+documentation, etc. If an *OS* name is given, then only the specified
+OS details will be shown.
Note that this command besides the information about the given OS(es),
shows detailed information about the given available/supported OS
--
2.8.0.rc3.226.g39d4020
