Rearrange tags in gnt-cluster/gnt-node
authorIustin Pop <iustin@google.com>
Sun, 30 Dec 2012 15:27:58 +0000 (16:27 +0100)
committerIustin Pop <iustin@google.com>
Tue, 8 Jan 2013 09:28:44 +0000 (10:28 +0100)
This patch makes the gnt-cluster and gnt-node man page more consistent
with the other man pages, where the tag commands are listed in a
separate section at the end.

Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: Guido Trotter <ultrotter@google.com>

man/gnt-cluster.rst
man/gnt-node.rst

index c6b0df4..f5d13be 100644 (file)
@@ -27,20 +27,6 @@ ACTIVATE-MASTER-IP
 
 Activates the master IP on the master node.
 
-ADD-TAGS
-~~~~~~~~
-
-**add-tags** [\--from *file*] {*tag*...}
-
-Add tags to the cluster. If any of the tags contains invalid
-characters, the entire operation will abort.
-
-If the ``--from`` option is given, the list of tags will be
-extended with the contents of that file (each line becomes a tag).
-In this case, there is not need to pass tags on the command line
-(if you do, both sources will be used). A file name of - will be
-interpreted as stdin.
-
 COMMAND
 ~~~~~~~
 
@@ -522,13 +508,6 @@ comma-separated list of disk templates.
 For details about how to use ``--hypervisor-state`` and ``--disk-state``
 have a look at **ganeti**(7).
 
-LIST-TAGS
-~~~~~~~~~
-
-**list-tags**
-
-List the tags of the cluster.
-
 MASTER-FAILOVER
 ~~~~~~~~~~~~~~~
 
@@ -680,20 +659,6 @@ configuration mismatches.
 See **ganeti(7)** for a description of ``--submit`` and other common
 options.
 
-REMOVE-TAGS
-~~~~~~~~~~~
-
-**remove-tags** [\--from *file*] {*tag*...}
-
-Remove tags from the cluster. If any of the tags are not existing
-on the cluster, the entire operation will abort.
-
-If the ``--from`` option is given, the list of tags to be removed will
-be extended with the contents of that file (each line becomes a tag).
-In this case, there is not need to pass tags on the command line (if
-you do, tags from both sources will be removed). A file name of - will
-be interpreted as stdin.
-
 RENAME
 ~~~~~~
 
@@ -760,30 +725,6 @@ When the all disk sizes are consistent, the command will return no
 output. Otherwise it will log details about the inconsistencies in
 the configuration.
 
-SEARCH-TAGS
-~~~~~~~~~~~
-
-**search-tags** {*pattern*}
-
-Searches the tags on all objects in the cluster (the cluster
-itself, the nodes and the instances) for a given pattern. The
-pattern is interpreted as a regular expression and a search will be
-done on it (i.e. the given pattern is not anchored to the beggining
-of the string; if you want that, prefix the pattern with ^).
-
-If no tags are matching the pattern, the exit code of the command
-will be one. If there is at least one match, the exit code will be
-zero. Each match is listed on one line, the object and the tag
-separated by a space. The cluster will be listed as /cluster, a
-node will be listed as /nodes/*name*, and an instance as
-/instances/*name*. Example:
-
-::
-
-    # gnt-cluster search-tags time
-    /cluster ctime:2007-09-01
-    /nodes/node1.example.com mtime:2007-10-04
-
 VERIFY
 ~~~~~~
 
@@ -857,6 +798,68 @@ VERSION
 
 Show the cluster version.
 
+Tags
+~~~~
+
+ADD-TAGS
+^^^^^^^^
+
+**add-tags** [\--from *file*] {*tag*...}
+
+Add tags to the cluster. If any of the tags contains invalid
+characters, the entire operation will abort.
+
+If the ``--from`` option is given, the list of tags will be
+extended with the contents of that file (each line becomes a tag).
+In this case, there is not need to pass tags on the command line
+(if you do, both sources will be used). A file name of - will be
+interpreted as stdin.
+
+LIST-TAGS
+^^^^^^^^^
+
+**list-tags**
+
+List the tags of the cluster.
+
+REMOVE-TAGS
+^^^^^^^^^^^
+
+**remove-tags** [\--from *file*] {*tag*...}
+
+Remove tags from the cluster. If any of the tags are not existing
+on the cluster, the entire operation will abort.
+
+If the ``--from`` option is given, the list of tags to be removed will
+be extended with the contents of that file (each line becomes a tag).
+In this case, there is not need to pass tags on the command line (if
+you do, tags from both sources will be removed). A file name of - will
+be interpreted as stdin.
+
+SEARCH-TAGS
+^^^^^^^^^^^
+
+**search-tags** {*pattern*}
+
+Searches the tags on all objects in the cluster (the cluster
+itself, the nodes and the instances) for a given pattern. The
+pattern is interpreted as a regular expression and a search will be
+done on it (i.e. the given pattern is not anchored to the beggining
+of the string; if you want that, prefix the pattern with ^).
+
+If no tags are matching the pattern, the exit code of the command
+will be one. If there is at least one match, the exit code will be
+zero. Each match is listed on one line, the object and the tag
+separated by a space. The cluster will be listed as /cluster, a
+node will be listed as /nodes/*name*, and an instance as
+/instances/*name*. Example:
+
+::
+
+    # gnt-cluster search-tags time
+    /cluster ctime:2007-09-01
+    /nodes/node1.example.com mtime:2007-10-04
+
 .. vim: set textwidth=72 :
 .. Local Variables:
 .. mode: rst
index fc423b5..f3e26aa 100644 (file)
@@ -78,20 +78,6 @@ Example::
     # gnt-node add -g group2 -s 192.0.2.9 node9.group2.example.com
 
 
-ADD-TAGS
-~~~~~~~~
-
-**add-tags** [\--from *file*] {*nodename*} {*tag*...}
-
-Add tags to the given node. If any of the tags contains invalid
-characters, the entire operation will abort.
-
-If the ``--from`` option is given, the list of tags will be
-extended with the contents of that file (each line becomes a tag).
-In this case, there is not need to pass tags on the command line
-(if you do, both sources will be used). A file name of - will be
-interpreted as stdin.
-
 EVACUATE
 ~~~~~~~~
 
@@ -274,13 +260,6 @@ LIST-FIELDS
 Lists available fields for nodes.
 
 
-LIST-TAGS
-~~~~~~~~~
-
-**list-tags** {*nodename*}
-
-List the tags of the given node.
-
 MIGRATE
 ~~~~~~~
 
@@ -372,20 +351,6 @@ Example::
     # gnt-node remove node5.example.com
 
 
-REMOVE-TAGS
-~~~~~~~~~~~
-
-**remove-tags** [\--from *file*] {*nodename*} {*tag*...}
-
-Remove tags from the given node. If any of the tags are not
-existing on the node, the entire operation will abort.
-
-If the ``--from`` option is given, the list of tags to be removed will
-be extended with the contents of that file (each line becomes a tag).
-In this case, there is not need to pass tags on the command line (if
-you do, tags from both sources will be removed). A file name of - will
-be interpreted as stdin.
-
 VOLUMES
 ~~~~~~~
 
@@ -645,6 +610,44 @@ The ``-M`` option can be used to prepend the node name to all command
 output lines. ``--sync`` forces the opcode to acquire the node lock(s)
 in exclusive mode.
 
+Tags
+~~~~
+
+ADD-TAGS
+^^^^^^^^
+
+**add-tags** [\--from *file*] {*nodename*} {*tag*...}
+
+Add tags to the given node. If any of the tags contains invalid
+characters, the entire operation will abort.
+
+If the ``--from`` option is given, the list of tags will be
+extended with the contents of that file (each line becomes a tag).
+In this case, there is not need to pass tags on the command line
+(if you do, both sources will be used). A file name of - will be
+interpreted as stdin.
+
+LIST-TAGS
+^^^^^^^^^
+
+**list-tags** {*nodename*}
+
+List the tags of the given node.
+
+REMOVE-TAGS
+^^^^^^^^^^^
+
+**remove-tags** [\--from *file*] {*nodename*} {*tag*...}
+
+Remove tags from the given node. If any of the tags are not
+existing on the node, the entire operation will abort.
+
+If the ``--from`` option is given, the list of tags to be removed will
+be extended with the contents of that file (each line becomes a tag).
+In this case, there is not need to pass tags on the command line (if
+you do, tags from both sources will be removed). A file name of - will
+be interpreted as stdin.
+
 .. vim: set textwidth=72 :
 .. Local Variables:
 .. mode: rst