diff options
| -rw-r--r-- | AUTHORS | 4 | ||||
| -rw-r--r-- | CHANGE-LOG | 4 | ||||
| -rw-r--r-- | documentation/credits.html | 2 | ||||
| -rw-r--r-- | documentation/default_files.html | 8 | ||||
| -rw-r--r-- | documentation/install.html | 12 |
5 files changed, 21 insertions, 9 deletions
@@ -4,10 +4,10 @@ Lead Contributors: - Michael Larabel - Wuppermann -- Andrew Schofield -Additional Contributors (2008): +Additional Contributors: +- Andrew Schofield - Pekka Panula - Stefan Doesinger - Jörg Schirottke @@ -1,5 +1,9 @@ PHORONIX TEST SUITE CHANGE-LOG +Phoronix Test Suite (Git) + +- documentation: Bring all documentation up-to-date with Orkdal + Phoronix Test Suite 1.4.0 Beta 2 October 27, 2008 diff --git a/documentation/credits.html b/documentation/credits.html index 1e12dbd..587d2b7 100644 --- a/documentation/credits.html +++ b/documentation/credits.html @@ -17,8 +17,8 @@ <h2>Lead Developers</h2> <p>- Michael Larabel</p> <p>- Wuppermann</p> -<p>- Andrew Schofield</p> <h2>Special Thanks To</h2> +<p>- Andrew Schofield</p> <p>- Pekka Panula</p> <p>- Stefan Doesinger</p> <p>- Jörg Schirottke</p> diff --git a/documentation/default_files.html b/documentation/default_files.html index 8091490..1464cb5 100644 --- a/documentation/default_files.html +++ b/documentation/default_files.html @@ -16,6 +16,8 @@ <p>This is a per-user configuration file. Among the information stored here is the Phoronix Global account information, test options, locations for storing files, and batch mode options. This file is formatted in XML.</p> <p><em>~/.phoronix-test-suite/graph-config.xml</em></p> <p>This is a per-user configuration file for storing graph attributes. The adjustable options include HTML hex color codes for different areas of the graph, dimensions of the graph, and font sizes. This file is formatted in XML.</p> +<p><em>~/.phoronix-test-suite/modules-config.xml</em></p> +<p>This is a per-user configuration file for storing module settings.</p> <p><em>~/.phoronix-test-suite/download-cache/</em></p> <p>This directory contains test packages that have been generated when running phoronix-test-suite make-download-cache. For more information on the download cache, view the included HTML documentation.</p> <p><em>~/.phoronix-test-suite/installed-tests/</em></p> @@ -24,6 +26,12 @@ <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/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/test-profiles/</em></p> +<p>This is the directory where locally installed test profiles can be stored. This is similar to the <em>pts/test-profiles/</em> directory within the Phoronix Test Suite package.</p> +<p><em>~/.phoronix-test-suite/test-resources/</em></p> +<p>This is the directory where locally installed test profile resources can be stored. This is similar to the <em>pts/test-resources/</em> directory within the Phoronix Test Suite package.</p> +<p><em>~/.phoronix-test-suite/test-suites/</em></p> +<p>This is the directory where locally installed test suite profiles can be stored. This is similar to the <em>pts/test-suites/</em> directory within the Phoronix Test Suite package.</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> <!-- END OF PTS AREA --> diff --git a/documentation/install.html b/documentation/install.html index f9c6367..9391b49 100644 --- a/documentation/install.html +++ b/documentation/install.html @@ -18,18 +18,18 @@ Test Suite without installing it, open a terminal and run <em>./phoronix-test-su <options></em> from the same directory.</p> <h2>Dependencies</h2> <p>The only required dependencies for the Phoronix Test Suite on Linux systems -are PHP 5.x CLI (packages for it are commonly called <em>php5-cli</em> or <em>php-cli</em> -or just <em>php</em>) and the PHP GD module (commonly called <em>php-gd</em> or -<em>php5-gd</em>). It's important to note that only PHP 5 is needed and not a +is PHP 5.x CLI (packages for it are commonly called <em>php5-cli</em> or <em>php-cli</em> +or just <em>php</em>). Additionally, the PHP GD module (commonly called <em>php-gd</em> or +<em>php5-gd</em>) is also needed to render graphs to PNG image files instead of +using the experimental SVG renderer. It's important to note that only PHP 5 is needed and not a web server (Apache) or other packages commonly associated with PHP. The reasoning behind the use of PHP 5 for is the portability across platforms for this language, low impact on the overall system, a lower entrance barrier for new developers, and low number (if any) dependencies that PHP5 CLI requires. The PHP GD library is used for rendering the graphs within the PTS Results Viewer.</p> <p><strong>Note #1:</strong> Depending upon your distribution's package configuration, you may also need <em>php-posix</em> package for providing the POSIX functions.</p> -<p><strong>Note #2:</strong> Many of the timed tests need <em>/usr/bin/time</em>.</p> -<p><strong>Note #3:</strong> You may need to modify the <em>php.ini</em> file on your system in order to support uploading results to Phoronix Global or logging into your Phoronix Global account. The <em>allow_url_fopen</em>, <em>file_uploads</em>, and <em>allow_url_include</em> options must be set to true in the PHP configuration and curl must be supported by the PHP installation. <a href="http://www.phoronix.com/forums/showpost.php?p=32484&postcount=4">Additional information</a>. -<p>While PHP and PHP GD are the only required dependencies, many of the test profiles +<p><strong>Note #2:</strong> You may need to modify the <em>php.ini</em> file on your system in order to support uploading results to Phoronix Global or logging into your Phoronix Global account. The <em>allow_url_fopen</em>, <em>file_uploads</em>, and <em>allow_url_include</em> options must be set to true in the PHP configuration and curl must be supported by the PHP installation. <a href="http://www.phoronix.com/forums/showpost.php?p=32484&postcount=4">Additional information</a>. +<p>While PHP is the only required dependency, many of the test profiles do require the standard Linux development tools/libraries (GCC, etc). On a clean Ubuntu installation, it's as easy as first running <em>sudo apt-get install php5-cli php5-gd</em> and then running the Phoronix Test Suite as it will take care of installing additional dependencies.</p> <p>The Phoronix Test Suite has a feature known as "External Dependencies" |