pts-core: Add a PreInstallMessage tag for test profiles that will be

shown to the user prior to installing the test

1 files changed, 8 insertions, 1 deletions

diff --git a/documentation/specifications_xml_test.html b/documentation/specifications_xml_test.html
index f4ef96e..638bcb5 100644
--- a/documentation/specifications_xml_test.html
+++ b/documentation/specifications_xml_test.html
@@ -193,7 +193,14 @@ ignored. If the value is set to 1, the first result will be void.<br>
 <strong>Required:</strong> No<br>

 <strong>Description:</strong> If the user needs to be alerted about something dealing with this 

 test, this tag can contain a string that will be shown to the user before the 

-test begins.</p>

+test begins.</p>
+<p><strong>Tag:</strong> PreInstallMessage<br>

+<strong>Location:</strong> PhoronixTestSuite/TestInformation/<br>

+<strong>Internal Reference:</strong> P_TEST_PREINSTALLMSG<br>

+<strong>Required:</strong> No<br>

+<strong>Description:</strong> If the user needs to be alerted about something dealing with this 

+test, this tag can contain a string that will be shown to the user before the 

+test is installed but after the files are downloaded.</p>

 <h2>PhoronixTestSuite/TestSettings/Default/</h2>

 <p><strong>Tag:</strong> Arguments<br>

 <strong>Location:</strong> PhoronixTestSuite/TestSettings/Default/<br>