summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Larabel <michael@phx-laptop.(none)>2008-08-25 21:44:49 -0400
committerMichael Larabel <michael@phx-laptop.(none)>2008-08-25 21:44:49 -0400
commite8fdb2c711545b2b37a02425d6b8e9d0909cf3a1 (patch)
tree51a4d9d2d32d09c30a3a0e696f392c8cafa21560 /documentation
parent3a90c84c198da72e5db522f97c886a20ae523d03 (diff)
downloadphoronix-test-suite-upstream-e8fdb2c711545b2b37a02425d6b8e9d0909cf3a1.tar.gz
phoronix-test-suite-upstream-e8fdb2c711545b2b37a02425d6b8e9d0909cf3a1.tar.xz
phoronix-test-suite-upstream-e8fdb2c711545b2b37a02425d6b8e9d0909cf3a1.zip
documentation: Update the test profile and suite XML specifications
Diffstat (limited to 'documentation')
-rw-r--r--documentation/specifications_xml_suite.html10
-rw-r--r--documentation/specifications_xml_test.html9
2 files changed, 13 insertions, 6 deletions
diff --git a/documentation/specifications_xml_suite.html b/documentation/specifications_xml_suite.html
index f124eef..45036b1 100644
--- a/documentation/specifications_xml_suite.html
+++ b/documentation/specifications_xml_suite.html
@@ -13,29 +13,29 @@
<p>This document describes the XML tags for writing a test suite.</p>
<h2>PhoronixTestSuite/SuiteInformation/</h2>
<p><strong>Tag:</strong> Title<br>
-<strong>Location:</strong> PhoronixTestSuite/TestProfile/<br>
+<strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br>
<strong>Internal Reference:</strong> P_SUITE_TITLE<br>
<strong>Required:</strong> Yes<br>
<strong>Description:</strong> The full string title of the suite.</p>
<p><strong>Tag:</strong> Version<br>
-<strong>Location:</strong> PhoronixTestSuite/TestProfile/<br>
+<strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br>
<strong>Internal Reference:</strong> P_SUITE_VERSION<br>
<strong>Required:</strong> Yes<br>
<strong>Description:</strong> The version of the test suite.<br>
<strong>Supported Values:</strong> ( Formatted: x.x.x )</p>
<p><strong>Tag:</strong> Description<br>
-<strong>Location:</strong> PhoronixTestSuite/TestProfile/<br>
+<strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br>
<strong>Internal Reference:</strong> P_SUITE_DESCRIPTION<br>
<strong>Required:</strong> Recommended<br>
<strong>Description:</strong> A short description of the test suite.</p>
<p><strong>Tag:</strong> TestType<br>
-<strong>Location:</strong> PhoronixTestSuite/TestProfile/<br>
+<strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br>
<strong>Internal Reference:</strong> P_SUITE_TYPE<br>
<strong>Required:</strong> Recommended<br>
<strong>Description:</strong> The hardware area of the system that this suite is designed to stress.<br>
<strong>Supported Values:</strong> System, Processor, Graphics, Disk, Memory, Motherboard</p>
<p><strong>Tag:</strong> Maintainer<br>
-<strong>Location:</strong> PhoronixTestSuite/TestProfile/<br>
+<strong>Location:</strong> PhoronixTestSuite/SuiteInformation/<br>
<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>
diff --git a/documentation/specifications_xml_test.html b/documentation/specifications_xml_test.html
index 3b26810..afb2026 100644
--- a/documentation/specifications_xml_test.html
+++ b/documentation/specifications_xml_test.html
@@ -55,7 +55,14 @@ configurations), UNKNOWN</p>
<strong>Required:</strong> No - Defaults to assume all architectures are supported<br>
<strong>Description:</strong> If the test software is limited to running on select system architectures,
list them in this tag with each architecture delimited by a comma.<br>
-<strong>Supported Values:</strong> ( Examples: x86, x86_64 )</p>
+<strong>Supported Values:</strong> ( Examples: x86, x86_64 )</p>
+<p><strong>Tag:</strong> SupportedPlatforms<br>
+<strong>Location:</strong> PhoronixTestSuite/TestProfile/<br>
+<strong>Internal Reference:</strong> P_TEST_SUPPORTEDPLATFORMS<br>
+<strong>Required:</strong> No - Defaults to assume all operating systems are supported<br>
+<strong>Description:</strong> If the test software is limited to running on select operating systems,
+list them in this tag with each OS being delimited by a comma.<br>
+<strong>Supported Values:</strong> Linux, Solaris, FreeBSD, BSD</p>
<p><strong>Tag:</strong> RequiresRoot<br>
<strong>Location:</strong> PhoronixTestSuite/TestProfile/<br>
<strong>Internal Reference:</strong> P_TEST_ROOTNEEDED<br>