On Tue, Dec 20, 2016 at 03:12:50PM +0000, 'Federico Morg Pareschi' via
ganeti-devel wrote:
> This patch adds some more consistency in the parameter names
> displayed in various ganeti man pages.
>
> Signed-off-by: Federico Morg Pareschi <[email protected]>
> ---
> 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.
Per our discussion yesterday, all the gnt-group commands actually do work with
either group specified by name or by UUID, so this is an improvement to the
docs. However, the command line help in lib/client/gnt_group.py also uses the
string "group-name". Could you update these too please?
Similarly, could you make sure you update all the other lib/client/*.py CLI arg
strings to match the changes you've made?
> 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
> ^^^^^^
[snip]
Interestingly, gnt-instance shutdown/startup work correctly with either UUIDs,
or prefix matches on instance FQDN. However, strangely, some of the subcommands
like gnt-instance info will do prefix match on instance FQDN, but don't work
with UUID, so I think we can't just bindly change these without checking what
each subcommand actually uses.
[snip]
> -**wait** {id}
> +**wait** {*job-id*}
>
> Wait for the job by the given *id* to finish; do not produce
Change id to job-id here too.
[snip]
> -**watch** {id}
> +**watch** {(*job-id*}
>
> This command follows the output of the job by the given *id* and
> prints it.
Change id to job-id here too.
[snip]
gnt-node list-drbd, list-tags definitely looks up by prefix match on FQDN or
UUID. Is this definitely true for gnt-node add, and the others though?
> 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*}
> ADD-TAGS
> ^^^^^^^^
Thanks,
Brian.
