Document hroller options recently added
authorKlaus Aehlig <aehlig@google.com>
Wed, 22 May 2013 12:57:16 +0000 (14:57 +0200)
committerKlaus Aehlig <aehlig@google.com>
Wed, 22 May 2013 15:03:25 +0000 (17:03 +0200)
hroller now also supports the options --skip-non-redundant and
--ignore-non-redundant, and this should be documented in the
man page as well.

While there, also use the same order in the options section
as in the synopsis, and in the synopsis group the algorithms
into
- those that modify the set of nodes to be scheduled, and
- those that modify the constraints to be taken into account.

Signed-off-by: Klaus Aehlig <aehlig@google.com>
Reviewed-by: Guido Trotter <ultrotter@google.com>

man/hroller.rst

index f7cb0f1..4666fd8 100644 (file)
@@ -24,10 +24,12 @@ Backend options:
 Algorithm options:
 
 **[ -G *name* ]**
-
 **[ -O *name...* ]**
-
 **[ --node-tags** *tag,..* **]**
+**[ --skip-non-redundant ]**
+
+**[ --offline-maintenance ]**
+**[ --ignore-non-redundant ]**
 
 Reporting options:
 
@@ -65,19 +67,26 @@ OPTIONS
 For a description of the standard options check **htools**\(7) and
 **hbal**\(1).
 
+\--force
+  Do not fail, even if the master node cannot be determined.
+
 \--node-tags *tag,...*
   Restrict to nodes having at least one of the given tags.
 
-\--one-step-only
-  Restrict to the first reboot group. Output the group one node per line.
+\--skip-non-redundant
+  Restrict to nodes not hosting any non-redundant instance.
 
 \--offline-maintenance
   Pretend that all instances are shutdown before the reboots are carried
   out. I.e., only edges from the primary to the secondary node of an instance
   are considered.
 
-\--force
-  Do not fail, even if the master node cannot be determined.
+\--ignore-non-redundnant
+  Pretend that the non-redundant instances do not exist, and only take
+  instances with primary and secondary node into account.
+
+\--one-step-only
+  Restrict to the first reboot group. Output the group one node per line.
 
 
 BUGS