Document that timeout is non-mandatory parameter and its default value
authorFrancisco Redondo Marchena <francisco.marchena@codethink.co.uk>
Fri, 3 Aug 2012 09:27:27 +0000 (10:27 +0100)
committerJannis Pohlmann <jannis.pohlmann@codethink.co.uk>
Fri, 3 Aug 2012 13:10:09 +0000 (14:10 +0100)
Modify in the documentation for legacy app handler that timeout is a
non-mandatory legacy app handler argument and its default value is
1000 milliseconds.

docs/reference/node-startup-controller/legacy-app-handler.xml

index eb38d7d..be21981 100644 (file)
@@ -19,7 +19,7 @@
       <command>legacy-app-handler</command>
       <arg choice="plain"><option>--unit</option> <replaceable>UNIT</replaceable></arg>
       <arg choice="plain"><option>--shutdown-mode</option> <replaceable>MODE</replaceable></arg>
-      <arg><option>--timeout</option> <replaceable>TIMEOUT</replaceable></arg>
+      <arg><option>[--timeout</option> <replaceable>TIMEOUT]</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -51,7 +51,7 @@
           <term><option>-t</option>, <option>--timeout</option></term>
           <listitem><para>
             The amount of time in milliseconds the Node State Manager will wait until it
-            considers shutdown to have failed.
+            considers shutdown to have failed. By default its value is 1000 milliseconds.
           </para></listitem>
         </varlistentry>
       </variablelist>