Update documentation of --print-jobid
authorHelga Velroyen <helgav@google.com>
Thu, 27 Aug 2015 11:41:08 +0000 (13:41 +0200)
committerHelga Velroyen <helgav@google.com>
Thu, 27 Aug 2015 11:55:16 +0000 (13:55 +0200)
This fixes issue 915. In the man pages, the option
'--print-jobid' was accidentally documented as
'--print-job-id'. This fixes all occurrences.

Signed-off-by: Helga Velroyen <helgav@google.com>
Reviewed-by: Klaus Aehlig <aehlig@google.com>

man/ganeti.rst
man/gnt-backup.rst
man/gnt-cluster.rst
man/gnt-group.rst
man/gnt-instance.rst
man/gnt-network.rst
man/gnt-node.rst
man/gnt-os.rst

index a23cb8d..867a289 100644 (file)
@@ -266,7 +266,7 @@ availability for a certain command can be checked by calling the
 command using the ``--help`` option.
 
 | **gnt-...** *command* [\--dry-run] [\--priority {low | normal | high}]
-| [\--submit] [\--print-job-id]
+| [\--submit] [\--print-jobid]
 
 The ``--dry-run`` option can be used to check whether an operation
 would succeed.
@@ -298,7 +298,7 @@ the specified format; if they are preceded by other characters
 (whitespace included), they become normal reasons and have no special
 effect.
 
-The ``--print-job-id`` option makes the command print the job id as first
+The ``--print-jobid`` option makes the command print the job id as first
 line on stdout, so that it is easy to parse by other programs.
 
 Defaults
index f9a9359..0f00b80 100644 (file)
@@ -26,7 +26,7 @@ EXPORT
 
 | **export** {-n *node*}
 | [\--shutdown-timeout=*N*] [\--noshutdown] [\--remove-instance]
-| [\--ignore-remove-failures] [\--submit] [\--print-job-id]
+| [\--ignore-remove-failures] [\--submit] [\--print-jobid]
 | [\--transport-compression=*compression-mode*]
 | [\--zero-free-space] [\--zeroing-timeout-fixed]
 | [\--zeroing-timeout-per-mib]
@@ -91,7 +91,7 @@ IMPORT
 | [-t [diskless | plain | drbd | file]]
 | [\--identify-defaults]
 | [\--ignore-ipolicy]
-| [\--submit] [\--print-job-id]
+| [\--submit] [\--print-jobid]
 | {*instance*}
 
 Imports a new instance from an export residing on *source-node* in
index f84fef8..a04d50c 100644 (file)
@@ -670,7 +670,7 @@ be 1.
 MODIFY
 ~~~~~~
 
-| **modify** [\--submit] [\--print-job-id]
+| **modify** [\--submit] [\--print-jobid]
 | [\--force]
 | [\--vg-name *vg-name*]
 | [\--enabled-hypervisors *hypervisors*]
@@ -822,7 +822,7 @@ The ``info`` option shows whether the watcher is currently paused.
 REDIST-CONF
 ~~~~~~~~~~~
 
-**redist-conf** [\--submit] [\--print-job-id]
+**redist-conf** [\--submit] [\--print-jobid]
 
 This command forces a full push of configuration files from the
 master node to the other nodes in the cluster. This is normally not
index ed248cf..1c313b2 100644 (file)
@@ -23,7 +23,7 @@ COMMANDS
 ADD
 ~~~
 
-| **add** [\--submit] [\--print-job-id]
+| **add** [\--submit] [\--print-jobid]
 | [\--node-parameters=*NDPARAMS*]
 | [\--alloc-policy=*POLICY*]
 | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
@@ -75,7 +75,7 @@ ASSIGN-NODES
 ~~~~~~~~~~~~
 
 | **assign-nodes**
-| [\--force] [\--submit] [\--print-job-id]
+| [\--force] [\--submit] [\--print-jobid]
 | {*group*} {*node*...}
 
 Assigns one or more nodes to the specified group, moving them from their
@@ -93,7 +93,7 @@ options.
 MODIFY
 ~~~~~~
 
-| **modify** [\--submit] [\--print-job-id]
+| **modify** [\--submit] [\--print-jobid]
 | [\--node-parameters=*NDPARAMS*]
 | [\--alloc-policy=*POLICY*]
 | [\--hypervisor-state *hvstate*]
@@ -124,7 +124,7 @@ options.
 REMOVE
 ~~~~~~
 
-| **remove** [\--submit] [\--print-job-id] {*group*}
+| **remove** [\--submit] [\--print-jobid] {*group*}
 
 Deletes the indicated node group, which must be empty. There must always be at
 least one group, so the last group cannot be removed.
@@ -176,7 +176,7 @@ List available fields for node groups.
 RENAME
 ~~~~~~
 
-| **rename** [\--submit] [\--print-job-id] {*oldname*} {*newname*}
+| **rename** [\--submit] [\--print-jobid] {*oldname*} {*newname*}
 
 Renames a given group from *oldname* to *newname*.
 
@@ -187,7 +187,7 @@ options.
 EVACUATE
 ~~~~~~~~
 
-| **evacuate** [\--submit] [\--print-job-id] [\--sequential] [\--force-failover]
+| **evacuate** [\--submit] [\--print-jobid] [\--sequential] [\--force-failover]
 | [\--iallocator *NAME*] [\--to *GROUP*...] {*group*}
 
 This command will move all instances out of the given node group.
index 80103be..62d34e8 100644 (file)
@@ -43,7 +43,7 @@ ADD
 | {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*
    \| {-g|--node-group} *nodegroup*}
 | {{-o|\--os-type} *os-type*}
-| [\--submit] [\--print-job-id]
+| [\--submit] [\--print-jobid]
 | [\--ignore-ipolicy]
 | [\--no-wait-for-sync]
 | [{-c|\--communication=yes|no}]
@@ -1211,7 +1211,7 @@ REMOVE
 ^^^^^^
 
 | **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
-| [\--print-job-id] [\--force] {*instance*}
+| [\--print-jobid] [\--force] {*instance*}
 
 Remove an instance. This will remove all data from the instance and
 there is *no way back*. If you are not sure if you use an instance
@@ -1346,7 +1346,7 @@ MODIFY
 | [{-O|\--os-parameters} *param*=*value*... ]
 | [--os-parameters-private *param*=*value*... ]
 | [\--offline \| \--online]
-| [\--submit] [\--print-job-id]
+| [\--submit] [\--print-jobid]
 | [\--ignore-ipolicy]
 | [\--hotplug]
 | [\--hotplug-if-possible]
@@ -1475,7 +1475,7 @@ REINSTALL
 | [{-O|\--os-parameters} *OS\_PARAMETERS*]
 | [--os-parameters-private} *OS\_PARAMETERS*]
 | [--os-parameters-secret} *OS\_PARAMETERS*]
-| [\--submit] [\--print-job-id]
+| [\--submit] [\--print-jobid]
 | {*instance*...}
 
 Reinstalls the operating system on the given instance(s). The
@@ -1501,7 +1501,7 @@ options.
 RENAME
 ^^^^^^
 
-| **rename** [\--no-ip-check] [\--no-name-check] [\--submit] [\--print-job-id]
+| **rename** [\--no-ip-check] [\--no-name-check] [\--submit] [\--print-jobid]
 | {*instance*} {*new\_name*}
 
 Renames the given instance. The instance must be stopped when running
@@ -1537,7 +1537,7 @@ STARTUP
 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
 | [{-H|\--hypervisor-parameters} ``key=value...``]
 | [{-B|\--backend-parameters} ``key=value...``]
-| [\--submit] [\--print-job-id] [\--paused]
+| [\--submit] [\--print-jobid] [\--paused]
 | {*name*...}
 
 Starts one or more instances, depending on the following options.  The
@@ -1635,7 +1635,7 @@ SHUTDOWN
 | [\--force] [\--force-multiple] [\--ignore-offline] [\--no-remember]
 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
-| [\--submit] [\--print-job-id]
+| [\--submit] [\--print-jobid]
 | {*name*...}
 
 Stops one or more instances. If the instance cannot be cleanly stopped
@@ -1689,7 +1689,7 @@ REBOOT
 | [\--force-multiple]
 | [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
 | \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
-| [\--submit] [\--print-job-id]
+| [\--submit] [\--print-jobid]
 | [*name*...]
 
 Reboots one or more instances. The type of reboot depends on the value
@@ -1753,17 +1753,17 @@ Disk management
 REPLACE-DISKS
 ^^^^^^^^^^^^^
 
-| **replace-disks** [\--submit] [\--print-job-id] [\--early-release]
+| **replace-disks** [\--submit] [\--print-jobid] [\--early-release]
 | [\--ignore-ipolicy] {-p} [\--disks *idx*] {*instance*}
 
-| **replace-disks** [\--submit] [\--print-job-id] [\--early-release]
+| **replace-disks** [\--submit] [\--print-jobid] [\--early-release]
 | [\--ignore-ipolicy] {-s} [\--disks *idx*] {*instance*}
 
-| **replace-disks** [\--submit] [\--print-job-id] [\--early-release]
+| **replace-disks** [\--submit] [\--print-jobid] [\--early-release]
 | [\--ignore-ipolicy]
 | {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
 
-| **replace-disks** [\--submit] [\--print-job-id] [\--early-release]
+| **replace-disks** [\--submit] [\--print-jobid] [\--early-release]
 | [\--ignore-ipolicy] {-a\|\--auto} {*instance*}
 
 This command is a generalized form for replacing disks. It is
@@ -1812,7 +1812,7 @@ options.
 ACTIVATE-DISKS
 ^^^^^^^^^^^^^^
 
-| **activate-disks** [\--submit] [\--print-job-id] [\--ignore-size]
+| **activate-disks** [\--submit] [\--print-jobid] [\--ignore-size]
 | [\--wait-for-sync] {*instance*}
 
 Activates the block devices of the given instance. If successful, the
@@ -1851,7 +1851,7 @@ options.
 DEACTIVATE-DISKS
 ^^^^^^^^^^^^^^^^
 
-**deactivate-disks** [-f] [\--submit] [\--print-job-id] {*instance*}
+**deactivate-disks** [-f] [\--submit] [\--print-jobid] {*instance*}
 
 De-activates the block devices of the given instance. Note that if you
 run this command for an instance with a drbd disk template, while it
@@ -1872,7 +1872,7 @@ options.
 GROW-DISK
 ^^^^^^^^^
 
-| **grow-disk** [\--no-wait-for-sync] [\--submit] [\--print-job-id]
+| **grow-disk** [\--no-wait-for-sync] [\--submit] [\--print-jobid]
 | [\--absolute]
 | {*instance*} {*disk*} {*amount*}
 
@@ -1931,7 +1931,7 @@ instance.
 RECREATE-DISKS
 ^^^^^^^^^^^^^^
 
-| **recreate-disks** [\--submit] [\--print-job-id]
+| **recreate-disks** [\--submit] [\--print-jobid]
 | [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
 | [\--disk=*N*[:[size=*VAL*][,spindles=*VAL*][,mode=*ro\|rw*]]] {*instance*}
 
@@ -1976,7 +1976,7 @@ FAILOVER
 | [\--shutdown-timeout=*N*]
 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
 | [\--cleanup]
-| [\--submit] [\--print-job-id]
+| [\--submit] [\--print-jobid]
 | {*instance*}
 
 Failover will stop the instance (if running), change its primary node,
@@ -2036,10 +2036,10 @@ MIGRATE
 
 | **migrate** [-f] [\--allow-failover] [\--non-live]
 | [\--migration-mode=live\|non-live] [\--ignore-ipolicy] [\--ignore-hvversions]
-| [\--no-runtime-changes] [\--submit] [\--print-job-id]
+| [\--no-runtime-changes] [\--submit] [\--print-jobid]
 | [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
 
-| **migrate** [-f] \--cleanup [\--submit] [\--print-job-id] {*instance*}
+| **migrate** [-f] \--cleanup [\--submit] [\--print-jobid] {*instance*}
 
 Migrate will move the instance to its secondary node without shutdown.
 As with failover, it works for instances having the drbd disk template
@@ -2134,7 +2134,7 @@ MOVE
 
 | **move** [-f] [\--ignore-consistency]
 | [-n *node*] [\--compress=*compression-mode*] [\--shutdown-timeout=*N*]
-| [\--submit] [\--print-job-id] [\--ignore-ipolicy]
+| [\--submit] [\--print-jobid] [\--ignore-ipolicy]
 | {*instance*}
 
 Move will move the instance to an arbitrary node in the cluster. This
@@ -2171,7 +2171,7 @@ Example::
 CHANGE-GROUP
 ^^^^^^^^^^^^
 
-| **change-group** [\--submit] [\--print-job-id]
+| **change-group** [\--submit] [\--print-jobid]
 | [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
 
 This command moves an instance to another node group. The move is
index dac1611..bfac86e 100644 (file)
@@ -40,7 +40,7 @@ ADD
 | [\--network6=*NETWORK6*]
 | [\--gateway6=*GATEWAY6*]
 | [\--mac-prefix=*MACPREFIX*]
-| [\--submit] [\--print-job-id]
+| [\--submit] [\--print-jobid]
 | [\--no-conflicts-check]
 | {*network*}
 
@@ -80,7 +80,7 @@ MODIFY
 | [\--network6=*NETWORK6*]
 | [\--gateway6=*GATEWAY6*]
 | [\--mac-prefix=*MACPREFIX*]
-| [\--submit] [\--print-job-id]
+| [\--submit] [\--print-jobid]
 | {*network*}
 
 Modifies parameters from the network.
@@ -95,7 +95,7 @@ options.
 REMOVE
 ~~~~~~
 
-| **remove** [\--submit] [\--print-job-id] {*network*}
+| **remove** [\--submit] [\--print-jobid] {*network*}
 
 Deletes the indicated network, which must be not connected to any node group.
 
index 05381da..8beb0ea 100644 (file)
@@ -92,7 +92,7 @@ Example::
 EVACUATE
 ~~~~~~~~
 
-| **evacuate** [-f] [\--early-release] [\--submit] [\--print-job-id]
+| **evacuate** [-f] [\--early-release] [\--submit] [\--print-jobid]
 | [{-I|\--iallocator} *NAME* \| {-n|\--new-secondary} *destination\_node*]
 | [{-p|\--primary-only} \| {-s|\--secondary-only} ]
 |  {*node*}
@@ -298,7 +298,7 @@ MIGRATE
 ~~~~~~~
 
 | **migrate** [-f] [\--non-live] [\--migration-mode=live\|non-live]
-| [\--ignore-ipolicy] [\--submit] [\--print-job-id] {*node*}
+| [\--ignore-ipolicy] [\--submit] [\--print-jobid] {*node*}
 
 This command will migrate all instances having the given node as
 primary to their secondary nodes. This works only for instances
@@ -322,7 +322,7 @@ Example::
 MODIFY
 ~~~~~~
 
-| **modify** [-f] [\--submit] [\--print-job-id]
+| **modify** [-f] [\--submit] [\--print-jobid]
 | [{-C|\--master-candidate} ``yes|no``]
 | [{-D|\--drained} ``yes|no``] [{-O|\--offline} ``yes|no``]
 | [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``] [\--auto-promote]
@@ -512,7 +512,7 @@ Example::
 MODIFY-STORAGE
 ~~~~~~~~~~~~~~
 
-| **modify-storage** [\--allocatable={yes|no}] [\--submit] [\--print-job-id]
+| **modify-storage** [\--allocatable={yes|no}] [\--submit] [\--print-jobid]
 | {*node*} {*storage-type*} {*volume-name*}
 
 Modifies storage volumes on a node. Only LVM physical volumes can
@@ -552,7 +552,7 @@ Example::
 POWERCYCLE
 ~~~~~~~~~~
 
-**powercycle** [\--yes] [\--force] [\--submit] [\--print-job-id] {*node*}
+**powercycle** [\--yes] [\--force] [\--submit] [\--print-jobid] {*node*}
 
 This command (tries to) forcefully reboot a node. It is a command
 that can be used if the node environment is broken, such that the
index 97c0c85..6ee82bd 100644 (file)
@@ -65,7 +65,7 @@ operating system.
 MODIFY
 ~~~~~~
 
-| **modify** [\--submit] [\--print-job-id]
+| **modify** [\--submit] [\--print-jobid]
 | [ [ -O | --os-parameters ] =*option*=*value*]
 | [ --os-parameters-private=*option*=*value*]
 | [-H *HYPERVISOR*:option=*value*[,...]]