From e8fdb2c711545b2b37a02425d6b8e9d0909cf3a1 Mon Sep 17 00:00:00 2001 From: Michael Larabel Date: Mon, 25 Aug 2008 21:44:49 -0400 Subject: documentation: Update the test profile and suite XML specifications --- documentation/specifications_xml_suite.html | 10 +++++----- documentation/specifications_xml_test.html | 9 ++++++++- 2 files changed, 13 insertions(+), 6 deletions(-) (limited to 'documentation') 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 @@

This document describes the XML tags for writing a test suite.

PhoronixTestSuite/SuiteInformation/

Tag: Title
-Location: PhoronixTestSuite/TestProfile/
+Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_TITLE
Required: Yes
Description: The full string title of the suite.

Tag: Version
-Location: PhoronixTestSuite/TestProfile/
+Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_VERSION
Required: Yes
Description: The version of the test suite.
Supported Values: ( Formatted: x.x.x )

Tag: Description
-Location: PhoronixTestSuite/TestProfile/
+Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_DESCRIPTION
Required: Recommended
Description: A short description of the test suite.

Tag: TestType
-Location: PhoronixTestSuite/TestProfile/
+Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_TYPE
Required: Recommended
Description: The hardware area of the system that this suite is designed to stress.
Supported Values: System, Processor, Graphics, Disk, Memory, Motherboard

Tag: Maintainer
-Location: PhoronixTestSuite/TestProfile/
+Location: PhoronixTestSuite/SuiteInformation/
Internal Reference: P_SUITE_MAINTAINER
Required: Recommended
Description: The name of the maintainer of this suite.

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

Required: No - Defaults to assume all architectures are supported
Description: If the test software is limited to running on select system architectures, list them in this tag with each architecture delimited by a comma.
-Supported Values: ( Examples: x86, x86_64 )

+Supported Values: ( Examples: x86, x86_64 )

+

Tag: SupportedPlatforms
+Location: PhoronixTestSuite/TestProfile/
+Internal Reference: P_TEST_SUPPORTEDPLATFORMS
+Required: No - Defaults to assume all operating systems are supported
+Description: 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.
+Supported Values: Linux, Solaris, FreeBSD, BSD

Tag: RequiresRoot
Location: PhoronixTestSuite/TestProfile/
Internal Reference: P_TEST_ROOTNEEDED
-- cgit