summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrancisco Redondo Marchena <francisco.marchena@codethink.co.uk>2012-08-03 10:27:27 +0100
committerJannis Pohlmann <jannis.pohlmann@codethink.co.uk>2012-08-03 14:10:09 +0100
commite9bcc84447fda02c80f2c937933d63d24ac1f143 (patch)
tree94b6333e764407741b1903fd9494f26d6d437e2e
parent371b445ab2d9d0f9ad0fd28856095e6a291c7c59 (diff)
downloadnode-startup-controller-e9bcc84447fda02c80f2c937933d63d24ac1f143.tar.gz
Document that timeout is non-mandatory parameter and its default value
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.
-rw-r--r--docs/reference/node-startup-controller/legacy-app-handler.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/reference/node-startup-controller/legacy-app-handler.xml b/docs/reference/node-startup-controller/legacy-app-handler.xml
index eb38d7d..be21981 100644
--- a/docs/reference/node-startup-controller/legacy-app-handler.xml
+++ b/docs/reference/node-startup-controller/legacy-app-handler.xml
@@ -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>