Commit cc425644 authored by Iustin Pop's avatar Iustin Pop

Update man pages for the tags operations

This adds documentation on the {list,add,remove}-tags commands to the
gnt-{cluster,node,instance} man pages.

Reviewed-by: imsnah
parent 75f49d9b
......@@ -55,6 +55,21 @@
<refsect1>
<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>
......@@ -208,6 +223,16 @@
</para>
</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>
......@@ -220,6 +245,21 @@
</para>
</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>
......
......@@ -750,6 +750,53 @@ node1.example.com:sdb:/dev/md1
</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;
......
......@@ -100,6 +100,22 @@
</para>
</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>
......@@ -240,6 +256,17 @@
</para>
</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>
......@@ -261,6 +288,21 @@
</para>
</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>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment