summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Maw <jonathan.maw@codethink.co.uk>2012-08-01 14:08:41 +0100
committerJannis Pohlmann <jannis.pohlmann@codethink.co.uk>2012-08-02 16:17:42 +0100
commit01149c2a14e5b96ec0f40d8570f3b557fc7c0e3c (patch)
tree5fe1baa03c550b3a43f583e3a5d23712340b8064
parent930e5fa136f0d2e462de40939294d12aab6a9ab8 (diff)
downloadnode-startup-controller-01149c2a14e5b96ec0f40d8570f3b557fc7c0e3c.tar.gz
Specify difference between NSM and NSM dummy in docmentation
Explicitly states the difference between the Node State Manager Dummy and the real Node State Manager, i.e. * The NSM dummy toggles between successfully setting the node state and failing to set the node state. * The NSM dummy toggles between the LUC being required, and the LUC not being required. * The NSM dummy will shut down its fast shutdown clients, then its normal shutdown clients, on receiving the SIGHUP signal
-rw-r--r--docs/reference/node-startup-controller/node-startup-controller-docs.xml16
-rw-r--r--docs/reference/node-startup-controller/test-tsm.xml5
2 files changed, 15 insertions, 6 deletions
diff --git a/docs/reference/node-startup-controller/node-startup-controller-docs.xml b/docs/reference/node-startup-controller/node-startup-controller-docs.xml
index ff9effd..5530b78 100644
--- a/docs/reference/node-startup-controller/node-startup-controller-docs.xml
+++ b/docs/reference/node-startup-controller/node-startup-controller-docs.xml
@@ -85,7 +85,21 @@
<title>Testing</title>
<note>
These tests are performed against the Node State Manager Dummy. The real
- Node State Manager behaves differently to the dummy.
+ Node State Manager behaves differently from the NSM dummy in the following ways:
+ <itemizedlist>
+ <listitem>
+ When the NSM dummy receives a request to set the node state, it alternates
+ between successfully setting the node state, and failing to set the node state.
+ </listitem>
+ <listitem>
+ When the NSM dummy is queried as to whether the LUC is required, it alternates
+ between saying no and yes.
+ </listitem>
+ <listitem>
+ On receiving a SIGHUP, the NSM dummy will shut down all its fast shutdown
+ clients, then all its normal shutdown clients.
+ </listitem>
+ </itemizedlist>
</note>
<xi:include href="test-example.xml"/>
<xi:include href="test-tsm.xml"/>
diff --git a/docs/reference/node-startup-controller/test-tsm.xml b/docs/reference/node-startup-controller/test-tsm.xml
index c09af81..7b016bc 100644
--- a/docs/reference/node-startup-controller/test-tsm.xml
+++ b/docs/reference/node-startup-controller/test-tsm.xml
@@ -54,11 +54,6 @@
<section>
<title>Test Overview</title>
- <note>
- The Node State Manager Dummy (application ID <emphasis role="bold">NSMD</emphasis>)
- alternates between failing and succeeding to set the node state. This behaviour does
- not extend to the real Node State Manager.
- </note>
<para>
The following behaviours will be confirmed:
<itemizedlist>