Update man pages for the tags operations
authorIustin Pop <iustin@google.com>
Mon, 8 Oct 2007 15:11:45 +0000 (15:11 +0000)
committerIustin Pop <iustin@google.com>
Mon, 8 Oct 2007 15:11:45 +0000 (15:11 +0000)
This adds documentation on the {list,add,remove}-tags commands to the
gnt-{cluster,node,instance} man pages.

Reviewed-by: imsnah

man/gnt-cluster.sgml
man/gnt-instance.sgml
man/gnt-node.sgml

index 6b0cc71..ef9e58f 100644 (file)
     <title>COMMANDS</title>
 
     <refsect2>
     <title>COMMANDS</title>
 
     <refsect2>
+      <title>ADD-TAGS</title>
+
+      <cmdsynopsis>
+        <command>add-tags</command>
+        <arg choice="req"
+        rep="repeat"><replaceable>tag</replaceable></arg>
+      </cmdsynopsis>
+
+      <para>
+        Add tags to the cluster. If any of the tags contains invalid
+        characters, the entire operation will abort.
+      </para>
+    </refsect2>
+
+    <refsect2>
       <title>COMMAND</title>
 
       <cmdsynopsis>
       <title>COMMAND</title>
 
       <cmdsynopsis>
     </refsect2>
 
     <refsect2>
     </refsect2>
 
     <refsect2>
+      <title>LIST-TAGS</title>
+
+      <cmdsynopsis>
+        <command>list-tags</command>
+      </cmdsynopsis>
+
+      <para>List the tags of the cluster.</para>
+    </refsect2>
+
+    <refsect2>
       <title>MASTERFAILOVER</title>
 
       <cmdsynopsis>
       <title>MASTERFAILOVER</title>
 
       <cmdsynopsis>
     </refsect2>
 
     <refsect2>
     </refsect2>
 
     <refsect2>
+      <title>REMOVE-TAGS</title>
+
+      <cmdsynopsis>
+        <command>remove-tags</command>
+        <arg choice="req"
+        rep="repeat"><replaceable>tag</replaceable></arg>
+      </cmdsynopsis>
+
+      <para>
+        Remove tags from the cluster. If any of the tags are not
+        existing on the cluster, the entire operation will abort.
+      </para>
+    </refsect2>
+
+    <refsect2>
       <title>RENAME</title>
 
       <cmdsynopsis>
       <title>RENAME</title>
 
       <cmdsynopsis>
index fd4cf57..53885e7 100644 (file)
@@ -750,6 +750,53 @@ node1.example.com:sdb:/dev/md1
 
     </refsect2>
 
 
     </refsect2>
 
+    <refsect2>
+      <title>TAGS</title>
+
+    <refsect3>
+        <title>ADD-TAGS</title>
+
+        <cmdsynopsis>
+          <command>add-tags</command>
+          <arg choice="req"><replaceable>instancename</replaceable></arg>
+          <arg choice="req"
+            rep="repeat"><replaceable>tag</replaceable></arg>
+        </cmdsynopsis>
+
+        <para>
+          Add tags to the given instance. If any of the tags contains
+          invalid characters, the entire operation will abort.
+        </para>
+      </refsect3>
+
+      <refsect3>
+        <title>LIST-TAGS</title>
+
+        <cmdsynopsis>
+          <command>list-tags</command>
+          <arg choice="req"><replaceable>instancename</replaceable></arg>
+        </cmdsynopsis>
+
+        <para>List the tags of the given instance.</para>
+      </refsect3>
+
+      <refsect3>
+        <title>REMOVE-TAGS</title>
+        <cmdsynopsis>
+          <command>remove-tags</command>
+          <arg choice="req"><replaceable>instancename</replaceable></arg>
+          <arg choice="req"
+            rep="repeat"><replaceable>tag</replaceable></arg>
+        </cmdsynopsis>
+
+        <para>
+          Remove tags from the given instance. If any of the tags are
+          not existing on the node, the entire operation will abort.
+        </para>
+      </refsect3>
+
+    </refsect2>
+
   </refsect1>
 
   &footer;
   </refsect1>
 
   &footer;
index 7341f13..1b71e59 100644 (file)
     </refsect2>
 
     <refsect2>
     </refsect2>
 
     <refsect2>
+      <title>ADD-TAGS</title>
+
+      <cmdsynopsis>
+        <command>add-tags</command>
+        <arg choice="req"><replaceable>nodename</replaceable></arg>
+        <arg choice="req"
+        rep="repeat"><replaceable>tag</replaceable></arg>
+      </cmdsynopsis>
+
+      <para>
+        Add tags to the given node. If any of the tags contains
+        invalid characters, the entire operation will abort.
+      </para>
+    </refsect2>
+
+    <refsect2>
       <title>INFO</title>
 
       <cmdsynopsis>
       <title>INFO</title>
 
       <cmdsynopsis>
     </refsect2>
 
     <refsect2>
     </refsect2>
 
     <refsect2>
+      <title>LIST-TAGS</title>
+
+      <cmdsynopsis>
+        <command>list-tags</command>
+        <arg choice="req"><replaceable>nodename</replaceable></arg>
+      </cmdsynopsis>
+
+      <para>List the tags of the given node.</para>
+    </refsect2>
+
+    <refsect2>
       <title>REMOVE</title>
 
       <cmdsynopsis>
       <title>REMOVE</title>
 
       <cmdsynopsis>
     </refsect2>
 
     <refsect2>
     </refsect2>
 
     <refsect2>
+      <title>REMOVE-TAGS</title>
+      <cmdsynopsis>
+        <command>remove-tags</command>
+        <arg choice="req"><replaceable>nodename</replaceable></arg>
+        <arg choice="req"
+        rep="repeat"><replaceable>tag</replaceable></arg>
+      </cmdsynopsis>
+
+      <para>
+        Remove tags from the given node. If any of the tags are not
+        existing on the node, the entire operation will abort.
+      </para>
+    </refsect2>
+
+    <refsect2>
       <title>VOLUMES</title>
 
       <cmdsynopsis>
       <title>VOLUMES</title>
 
       <cmdsynopsis>