summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Larabel <michael@phx-laptop.(none)>2008-08-29 12:21:09 -0400
committerMichael Larabel <michael@phx-laptop.(none)>2008-08-29 12:21:09 -0400
commiteb77225fbf70fd30ce57d00533012abcbfbb4fc0 (patch)
treef2258e4710b857a60373456cf72b4cd557563450 /documentation
parentbf7bda0b2f375d6d4ece2846fd542b7c9d679b73 (diff)
downloadphoronix-test-suite-upstream-eb77225fbf70fd30ce57d00533012abcbfbb4fc0.tar.gz
phoronix-test-suite-upstream-eb77225fbf70fd30ce57d00533012abcbfbb4fc0.tar.xz
phoronix-test-suite-upstream-eb77225fbf70fd30ce57d00533012abcbfbb4fc0.zip
documentation: Bring the documentation up to date for PTS 1.2 Malvik
Diffstat (limited to 'documentation')
-rw-r--r--documentation/default_files.html2
-rw-r--r--documentation/index.html1
-rw-r--r--documentation/install.html2
-rw-r--r--documentation/man-pages/phoronix-test-suite.12
-rw-r--r--documentation/tips_and_tricks.html7
5 files changed, 8 insertions, 6 deletions
diff --git a/documentation/default_files.html b/documentation/default_files.html
index 82328a1..8091490 100644
--- a/documentation/default_files.html
+++ b/documentation/default_files.html
@@ -22,7 +22,7 @@
<p>This directory is where tests are installed by default. Each test has its own directory within <em>installed-tests/</em>. In the test's folder is a <em>pts-install.xml</em> file used for managing the installation.</p>
<p><em>~/.phoronix-test-suite/test-results/</em></p>
<p>This directory is where tests results are saved by default. Each saved file has its own directory. In the saved directory is then a <em>composite.xml</em> file containing the useful results while in the <em>test-X.xml</em> files are back-ups of the results. In the <em>result-graphs</em> sub-directory are the rendered graph image files.</p>
-<p><em>~/.phoronix-test-suite/local/</em></p>
+<p><em>~/.phoronix-test-suite/module-files/</em></p>
<p>This is the directory where any Phoronix Test Suite modules should save any files to, within a sub-directory of the module's name.</p>
<p><em>~/.phoronix-test-suite/debug-messages/</em></p>
<p>When <em>DEBUG_FILE</em> has been set for saving the debug output of the Phoronix Test Suite, the files are saved in this directory.</p>
diff --git a/documentation/index.html b/documentation/index.html
index 663e111..c08a2cc 100644
--- a/documentation/index.html
+++ b/documentation/index.html
@@ -10,6 +10,7 @@
<div class="pts_doc_main">
<!-- PTS AREA -->
<h1>Phoronix Test Suite</h1>
+<p>The Phoronix Test Suite is the most comprehensive testing and benchmarking platform available for the Linux operating system. This software is designed to effectively carry out both qualitative and quantitative benchmarks in a clean, reproducible, and easy-to-use manner. This software is based upon the extensive Linux benchmarking work and internal tools developed by Phoronix.com since 2004 along with input from leading tier-one computer hardware vendors. This software is open-source and licensed under the GNU GPLv3. The Phoronix Test Suite consists of a lightweight processing core (pts-core) with each benchmark consisting of an XML-based profile with related resource scripts. The process from the benchmark installation, to the actual benchmarking, to the parsing of important hardware and software components is heavily automated and completely repeatable, asking users only for confirmation of actions.</p>
<div style="width: 1px; height: 20px;"></div>
<h2>Documentation</h2>
<h3><a href="install.html">Installation</a></h3>
diff --git a/documentation/install.html b/documentation/install.html
index 574dff4..2ee78e7 100644
--- a/documentation/install.html
+++ b/documentation/install.html
@@ -10,7 +10,7 @@
<div class="pts_doc_main">
<!-- PTS AREA -->
<h1>Phoronix Test Suite Installation</h1>
-<p>A majority of the Phoronix Test Suite development and testing is done on Ubuntu and Fedora Linux, but this software should run virtually unmodified on any Linux distribution. The only distribution-specific bits deal with the external dependencies support feature. For instance, if you're not running one of the supported distributions (Ubuntu, Fedora, Mandriva, OpenSuSE, CentOS) you may need to install a package manually in order for a test to run. For example, the OpenGL Utility Toolkit may need to be installed manually by the user to support the OpenGL source tests.</p>
+<p>A majority of the Phoronix Test Suite development and testing is done on Ubuntu and Fedora Linux, but this software should run virtually unmodified on any Linux distribution. The only distribution-specific bits deal with the external dependencies support feature. For instance, if you're not running one of the supported distributions (Ubuntu, Fedora, Mandriva, Gentoo, OpenSolaris, OpenSuSE, CentOS) you may need to install a package manually in order for a test to run. For example, GCC and the OpenGL Utility Toolkit may need to be installed manually by the user to support the OpenGL source tests.</p>
<h2>Running Locally</h2>
<p>The Phoronix Test Suite can be simply extracted from the downloaded <em>.tar.gz</em>
file or it can also be installed system-wide. If you just wish to run the Phoronix
diff --git a/documentation/man-pages/phoronix-test-suite.1 b/documentation/man-pages/phoronix-test-suite.1
index ab8f6d6..6273838 100644
--- a/documentation/man-pages/phoronix-test-suite.1
+++ b/documentation/man-pages/phoronix-test-suite.1
@@ -8,7 +8,7 @@ phoronix-test-suite \- The Phoronix Test Suite is an extensible open-source plat
.br
.B phoronix-test-suite benchmark [test | suite]
.SH DESCRIPTION
-The Phoronix Test Suite is the most comprehensive testing and benchmarking platform available for the Linux operating system. This software is designed to effectively carry out both qualitative and quantitative benchmarks in a clean, reproducible, and easy-to-use manner. This software is based upon the extensive Linux benchmarking work and internal tools developed by Phoronix.com since 2004 along with input from leading tier-one computer hardware vendors. This software is open-source and licensed under the GNU GPLv3. The Phoronix Test Suite consists of a lightweight core (pts-core) with each benchmark consisting of an XML-based profile with related resource scripts. The process from the benchmark installation, to the actual benchmarking, to the parsing of important hardware and software components is heavily automated and completely repeatable, asking users only for confirmation of actions.
+The Phoronix Test Suite is the most comprehensive testing and benchmarking platform available for the Linux operating system. This software is designed to effectively carry out both qualitative and quantitative benchmarks in a clean, reproducible, and easy-to-use manner. This software is based upon the extensive Linux benchmarking work and internal tools developed by Phoronix.com since 2004 along with input from leading tier-one computer hardware vendors. This software is open-source and licensed under the GNU GPLv3. The Phoronix Test Suite consists of a lightweight processing core (pts-core) with each benchmark consisting of an XML-based profile with related resource scripts. The process from the benchmark installation, to the actual benchmarking, to the parsing of important hardware and software components is heavily automated and completely repeatable, asking users only for confirmation of actions.
.PP
The Phoronix Test Suite can be used for simply comparing your computer's performance with your friends and co-workers or can also be used at your company for internal quality assurance purposes under Linux. Results from the Phoronix Test Suite are displayed in a results viewer with optional support for uploading them to Phoronix Global. Phoronix Global allows you to browse all uploaded results, search these results, and compare other results against your own system.
.SH OPTIONS
diff --git a/documentation/tips_and_tricks.html b/documentation/tips_and_tricks.html
index 5c7b614..cffc1fd 100644
--- a/documentation/tips_and_tricks.html
+++ b/documentation/tips_and_tricks.html
@@ -16,12 +16,14 @@ as some random information that some users may find useful.</p>
<p>- The desktop's screensaver will automatically be
shutdown when a test is running and will be restored to its previous state upon
the test's completion. This should work for GNOME, KDE, and other XDG-supportive desktop environments.</p>
+<p>- Phoronix Test Suite supports OpenSolaris and *BSD operating systems. Support for Mac OS X may
+be added in the future.</p>
+<p>- How do I find tests that are in a suite? Run <em>phoronix-test-suite info NAME-OF-SUITE</em> and (along with other information) a tree will be displayed that recursively shows the tests (along with any sub-suites) inside. To find suites that utilize a particular test, run <em>phoronix-test-suite info NAME-OF-TEST</em> and it will show that information too.</p>
+<h2>Running</h2>
<p>- When running a test in batch mode (through the use of the <em>batch-run</em>
or <em>batch-benchmark</em> options) that normally has end-user options (such
as the sub-test to run or resolution), the Phoronix Test Suite will run the test
with each unique combination of options possible.</p>
-<p>- Phoronix Test Suite supports OpenSolaris and *BSD operating systems. Support for Mac OS X may
-be added in the future.</p>
<p>- If the environmental variable <em>PTS_MERGE=custom</em> is set, no compatibility
checks will be performed when merging results and it will allow you to form custom
suites very easily, etc. Though the preferred method to create a suite is by writing
@@ -34,7 +36,6 @@ once a test has been installed the originally downloaded files for that test wil
disk space but will cause these files to be re-downloaded the next time the test needs to be re-installed. This will also
not back up the downloaded files to the Phoronix Test Suite download cache. Enabling this option is just recommended for users
with very limited disk space.</p>
-<p>- How do I find tests that are in a suite? Run <em>phoronix-test-suite info NAME-OF-SUITE</em> and (along with other information) a tree will be displayed that recursively shows the tests (along with any sub-suites) inside. To find suites that utilize a particular test, run <em>phoronix-test-suite info NAME-OF-TEST</em> and it will show that information too.</p>
<p>- If the amount of video memory for your graphics card is incorrectly reported by the Phoronix Test Suite (you can check by running <em>phoronix-test-suite diagnostics</em>), you can use the <em>VIDEO_MEMORY=</em> environmental variable for overriding the video memory capacity (in Megabytes) used by the Phoronix Test Suite.</p>
<p>- If the <em>DISPLAY</em> environmental variable is not set or <em>NO_GRAPHICS_TESTS</em> environmental variable is set, tests of type <em>Graphics</em> will not be run. Likewise, if <em>NO_SYSTEM_TESTS</em> environmental variable is set, tests of type <em>System</em> will not run. This applies to all test types where <em>NO_&lt;TEST TYPE&gt;_TESTS</em> is set.</p>
<p>- If the <em>TEST_RESULTS_NAME</em> environmental variable is set, instead of prompting the user for the name to save the results as, it will use the variable's value.</p>