summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Larabel <michael@phx-laptop.(none)>2008-09-29 22:04:43 -0400
committerMichael Larabel <michael@phx-laptop.(none)>2008-09-29 22:04:43 -0400
commit30a3bf991dc989cd40a18cc8e9cbb30294ce9cbe (patch)
tree7cb120bd37861238c2532b3579e1d382b3de700d /documentation
parenteb162655f7cfa075d0507c50c8bd47aef0efb50d (diff)
downloadphoronix-test-suite-upstream-30a3bf991dc989cd40a18cc8e9cbb30294ce9cbe.tar.gz
phoronix-test-suite-upstream-30a3bf991dc989cd40a18cc8e9cbb30294ce9cbe.tar.xz
phoronix-test-suite-upstream-30a3bf991dc989cd40a18cc8e9cbb30294ce9cbe.zip
pts-core: Add PreRunMessage tag to the suite specification for showing
the user a message before testing begins (similar to PreRunMessage in tests)
Diffstat (limited to 'documentation')
-rw-r--r--documentation/specifications_xml_suite.html7
1 files changed, 7 insertions, 0 deletions
diff --git a/documentation/specifications_xml_suite.html b/documentation/specifications_xml_suite.html
index 45036b1..4f9ec18 100644
--- a/documentation/specifications_xml_suite.html
+++ b/documentation/specifications_xml_suite.html
@@ -39,6 +39,13 @@
<strong>Internal Reference:</strong> P_SUITE_MAINTAINER<br>
<strong>Required:</strong> Recommended<br>
<strong>Description:</strong> The name of the maintainer of this suite.</p>
+<p><strong>Tag:</strong> PreRunMessage<br>
+<strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br>
+<strong>Internal Reference:</strong> P_SUITE_PRERUNMSG<br>
+<strong>Required:</strong> No<br>
+<strong>Description:</strong> If the user needs to be alerted about something dealing with this
+suite -- and just not to a specific test -- this tag can contain a string that will be shown to the user before the
+tests in the suite are executed.</p>
<h2>PhoronixTestSuite/RunTest/<br>
NOTE: Multiple instances of these tags are allowed for multiple tests in a suite</h2>
<p><strong>Tag:</strong> Test<br>