diff options
| -rw-r--r-- | documentation/credits.html | 2 | ||||
| -rw-r--r-- | documentation/includes/pts-documentation.css | 6 | ||||
| -rw-r--r-- | documentation/install.html | 17 | ||||
| -rw-r--r-- | documentation/pts_options.html | 75 | ||||
| -rw-r--r-- | documentation/sensor_monitoring.html | 2 | ||||
| -rw-r--r-- | documentation/tips_and_tricks.html | 21 | ||||
| -rw-r--r-- | documentation/writing_your_first_test.html | 2 | ||||
| -rwxr-xr-x | phoronix-test-suite | 1 |
8 files changed, 68 insertions, 58 deletions
diff --git a/documentation/credits.html b/documentation/credits.html index 24b1807..02312ce 100644 --- a/documentation/credits.html +++ b/documentation/credits.html @@ -12,7 +12,7 @@ <!-- PTS AREA --> <h1>Phoronix Test Suite</h1> <div style="width: 1px; height: 20px;"></div> -<p>The phoronix-test-suite, pts_Graph, and tandem_Xml are open-source projects by <a href="http://www.phoronixmedia.com/">Phoronix Media</a>.</p> +<p>The phoronix-test-suite, pts_Graph, and tandem_Xml are some of the other open-source projects provided by <a href="http://www.phoronixmedia.com/">Phoronix Media</a>.</p> <p>The default font that ships with the Phoronix Test Suite for the results graphing is from the Liberation (GPL-licensed) font collection from <a href="https://www.redhat.com/promo/fonts/">Red Hat</a>.</p> <h2>Lead Developers</h2> <p>- Michael Larabel</p> diff --git a/documentation/includes/pts-documentation.css b/documentation/includes/pts-documentation.css index 03846ba..3f8f417 100644 --- a/documentation/includes/pts-documentation.css +++ b/documentation/includes/pts-documentation.css @@ -16,14 +16,14 @@ div#pts_doc_header { width: 100%; margin: 0; - background-color: #2b6b29; + background-color: #000; } div#pts_doc_logo { width: 135px; height: 70px; padding: 3px; - background: #2b6b29 url(pts-documentation.png) no-repeat; + background: #000 url(pts-documentation.png) no-repeat; position: relative; left: 552px; } @@ -53,7 +53,7 @@ div.pts_doc_notice } div.pts_doc_bottom { - background-color: #2b6b29; + background-color: #222; color: #FFF; text-align: left; padding: 3px 8px; diff --git a/documentation/install.html b/documentation/install.html index 1b1f0d1..5f10f18 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 are done on Ubuntu and Fedora Linux, but this testing 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, 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> <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 @@ -26,13 +26,12 @@ behind the use of PHP 5 for is the portability across platforms for this languag 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>Note #1: Depending upon your distribution's package configuration, you may also need <em>php-posix</em> package for providing the POSIX functions.</p> -<p>Note #2: You may need to modify the <em>php.ini</em> file on your system in order to support uploading results to PTS Global or logging into your PTS 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><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> <em>/usr/bin/time</em> is needed by many of the timed tests.</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 PTS Global or logging into your PTS 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 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 build-essential -php5-cli php-gd</em> and then running the Phoronix Test Suite. In addition, <em>/usr/bin/time</em> -is another dependency used by many of the tests.</p> +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" where the Phoronix Test Suite can attempt to automatically install some of the test-specific dependencies on supported distributions. If running on a distribution @@ -52,7 +51,7 @@ install the software for system-wide access. By default the <em>phoronix-test-su executable is in <em>/usr/bin/</em>, the Phoronix Test Suite files in <em>/usr/share/phoronix-test-suite/</em>, and the documentation in /<em>usr/share/doc/phoronix-test-suite/</em>. Root access is required. The default installation prefix is /usr/ but can be adjusted as the -first argument (example: install-sh /home/user-name/ to install the Phoronix Test +first argument (example: <em>install-sh /home/user/</em> to install the Phoronix Test Suite in your home directory).</p> <h2>Debian/Ubuntu Installation</h2> <p>Debian/Ubuntu users are able to follow the Generic Installation instructions @@ -66,7 +65,9 @@ and the documentation in <em>/usr/share/doc/phoronix-test-suite/</em>.</p> <h2>Mandriva Installation</h2> <p>Mandriva packages are being worked on by Stephane Teletchea and are expected for inclusion in Mandriva Linux 2009 development.</p> <h2>OpenSolaris Installation</h2> -<p>The Phoronix Test Suite core (pts-core) is supported on Solaris and OpenSolaris platforms, but some features may not fully function. Additionally, the PTS External Dependencies feature is supported on OpenSolaris. However, not all test profiles are supported on Solaris / OpenSolaris, and it may be in violation of your end-user agreement to perform such benchmarks on the Sun Solaris operating system. Using the OpenSolaris IPS (Image Packaging System), installing <em>SUNWphp524</em> will provide PHP, PHP GD, and related dependencies.</p> +<p>The Phoronix Test Suite core (pts-core) is supported on Solaris and OpenSolaris platforms, but some features may not fully function. Additionally, the PTS External Dependencies feature is supported on OpenSolaris using IPS (the Image Packaging System). However, not all test profiles are supported on Solaris / OpenSolaris, and it may be in violation of your end-user agreement to perform such benchmarks on the Sun Solaris operating system. Using the OpenSolaris Image Packaging System, installing <em>SUNWphp524</em> will provide PHP, PHP GD, and related dependencies.</p> +<h2>FreeBSD Installation</h2> +<p>The Phoronix Test Suite also supports *BSD operating systems. However, like the Solaris support, not all test profiles are compatible with BSD operating systems, but pts-core has been tested against FreeBSD 7.0.</p> <!-- END OF PTS AREA --> </div></div><div class="pts_doc_fixed"><div class="pts_doc_bottom"><div style="float: left;"><a href="http://www.phoronix-test-suite.com/">Phoronix-Test-Suite.com</a></div><div style="float: right;">Copyright © 2008 by <a href="http://www.phoronixmedia.com/">Phoronix Media</a>.</div></div></div> </body> diff --git a/documentation/pts_options.html b/documentation/pts_options.html index 0945b52..34428f8 100644 --- a/documentation/pts_options.html +++ b/documentation/pts_options.html @@ -10,7 +10,7 @@ <div class="pts_doc_main"> <!-- PTS AREA --> <h1>Phoronix Test Suite Options</h1> -<h2>Installation Options</h2> +<h2>Test Installation Options</h2> <p><strong>install <To Install></strong></p> <p>This option will install the selected test(s) inside the testing environment directory (defaults to ~/.phoronix-test-suite/installed-tests). The install process @@ -39,16 +39,19 @@ dependencies are automatically checked.</p> <p>This option will install all available test(s) inside the testing environment directory (defaults to ~/.phoronix-test-suite/installed-tests). The install process from downloading of the test files to the installation is fully automated.</p> -<p><strong>list-installed-tests</strong></p> -<p>This option will list all tests that have been installed by the Phoronix Test -Suite.</p> -<p><strong>list-test-usage</strong></p> -<p>This option is similar to list-installed-tests with showing the tests that are installed, -but it will also show the date/time a test was installed, when the test was last run, and the -number of times the test was run by the Phoronix Test Suite.</p> +<p><strong>force-install <To Install></strong></p> +<p>This option will force the installation (or re-installation) of a test or suite. +The arguments and process is similar to the install option but even if the test +is installed, the entire installation process will automatically be executed. +This option should only be used when debugging a test installation problem.</p> +<p><strong>force-install-all</strong></p> +<p>This option will force the installation (or re-installation) of all tests. +The process is similar to the install-all option but even if a test is installed, +the entire installation process will automatically be executed. This option should +only be used when debugging a test installation problem.</p> <p><strong>list-possible-dependencies</strong></p> <p>List all possible external dependencies used by tests within the Phoronix Test Suite.</p> -<h2>Testing Options</h2> +<h2>Run Options</h2> <p><strong>benchmark <To Run></strong></p> <p>This option will install the selected test(s) (if needed) and will proceed to run the test(s). This option is equivalent to running phoronix-test-suite with @@ -57,13 +60,7 @@ be supplied or the PTS Global ID or saved local file name.</p> <p><strong>run <To Run></strong></p> <p>This option will run the selected test(s). The name of the test or suite must be supplied or the PTS Global ID or saved local file name.</p> -<p><strong>list-tests</strong></p> -<p>This option will list all available tests. The name, title, status, and license -are displayed for each test.</p> -<p><strong>list-suites</strong></p> -<p>This option will list all available test suites. The name, title, and type -are displayed for each suite.</p> -<h2>Batch Testing Options</h2> +<h2>Batch Run Options</h2> <p><strong>batch-setup</strong></p> <p>This option is used to configure the batch mode options for the Phoronix Test Suite, which is subsequently written to the user configuration file. Among the @@ -75,6 +72,30 @@ will be ran in the Phoronix Test Suite batch mode.</p> <p><strong>batch-benchmark <To Run></strong></p> <p>This option and its arguments are equivalent to the benchmark option, but the process will be ran in the Phoronix Test Suite batch mode.</p> +<p><strong>analyze <Saved Name></strong></p> +<p>This option will analyze a batch results file and plot out the performance impact +from the different options onto a line graph (i.e. to see the impact that changing the video +resolution has on the system's performance).</p> +<h2>Test Options</h2> +<p><strong>list-tests</strong></p> +<p>This option will list all available tests. The name, title, status, and license +are displayed for each test.</p> +<p><strong>list-suites</strong></p> +<p>This option will list all available test suites. The name, title, and type +are displayed for each suite.</p> +<p><strong>list-installed-tests</strong></p> +<p>This option will list all tests that have been installed by the Phoronix Test +Suite.</p> +<p><strong>list-test-usage</strong></p> +<p>This option is similar to list-installed-tests with showing the tests that are installed, +but it will also show the date/time a test was installed, when the test was last run, and the +number of times the test was run by the Phoronix Test Suite.</p> +<p><strong>info <To Show></strong></p> +<p>This option will show details about the test or suite that's supplied as the +first argument to this option. When supplying the name of a test, the version, +maintainer, type, download size, license information, and suites using this test +are displayed. When supplying the name of a suite, the version, maintainer, type, +and tests that make up the suite are displayed.</p> <h2>Result Viewing Options</h2> <p><strong>list-results</strong></p> <p>This option will list all saved results. The file name, title, test(s) performed, @@ -101,7 +122,7 @@ this information automatically. A new PTS Global account can be created (for fre at http://global.phoronix-test-suite.com/.</p> <h2>Module Options</h2> <p><strong>list-modules</strong></p> -<p>This option will list all modules that are installed / present in the <em>pts-core/modules/<em> directory. +<p>This option will list all modules that are installed / present in the <em>pts-core/modules/</em> directory. Modules are used for extending the functionality of the Phoronix Test Suite without over-inflating the pts-core.</p> <p><strong>module-info <Module Name></strong></p> <p>This option will show detailed information on a PTS module such as the version, developer, and a description of its purpose.</p> @@ -115,37 +136,17 @@ Phoronix Test Suite thereby conserving bandwidth and reducing time. Through modi the user configuration file, the download cache location can be adjusted. The Phoronix Test Suite supports reading from download caches over the network and on remote file-systems.</p> -<p><strong>info <To Show></strong></p> -<p>This option will show details about the test or suite that's supplied as the -first argument to this option. When supplying the name of a test, the version, -maintainer, type, download size, license information, and suites using this test -are displayed. When supplying the name of a suite, the version, maintainer, type, -and tests that make up the suite are displayed.</p> <p><strong>clone <PTS Global ID></strong></p> <p>This option will download a local copy of a file that was saved to PTS Global, as long as a valid PTS Global ID is supplied.</p> <p><strong>system-info</strong></p> <p>This option will show installed system hardware and software that has been detected by the Phoronix Test Suite.</p> -<p><strong>sensor-options</strong></p> -<p>This option will show system sensors that can be monitored through the Phoronix -Test Suite.</p> <p><strong>diagnostics</strong></p> <p>This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite.</p> <p><strong>version</strong></p> <p>This option will print the Phoronix Test Suite version.</p> -<h2>Other Options</h2> -<p><strong>force-install <To Install></strong></p> -<p>This option will force the installation (or re-installation) of a test or suite. -The arguments and process is similar to the install option but even if the test -is installed, the entire installation process will automatically be executed. -This option should only be used when debugging a test installation problem.</p> -<p><strong>force-install-all</strong></p> -<p>This option will force the installation (or re-installation) of all tests. -The process is similar to the install-all option but even if a test is installed, -the entire installation process will automatically be executed. This option should -only be used when debugging a test installation problem.</p> <p><strong>refresh-graphs <Saved Name></strong></p> <p>This option will re-render and save all result graphs within a saved file. This option can be used when making modifications to the graphing code or its diff --git a/documentation/sensor_monitoring.html b/documentation/sensor_monitoring.html index 1a9c215..8cad5ae 100644 --- a/documentation/sensor_monitoring.html +++ b/documentation/sensor_monitoring.html @@ -23,7 +23,7 @@ system temperature, battery power consumption, CPU voltage, +3.33V line voltage, +5.00V line voltage, and +12.00V line voltage. Additional sensors will be supported in the future.</p> <p>The full list of supported sensor options can be found by running <em>phoronix-test-suite -sensor-options</em>. The sensors actually detected on the current system and their +module-info system_monitor</em>. The sensors actually detected on the current system and their values can be read by running <em>phoronix-test-suite sensors</em>. Selecting sensors to monitor is performed through the <em>MONITOR</em> environmental variable. As examples, to monitor just the CPU temperature while running the universe suite, diff --git a/documentation/tips_and_tricks.html b/documentation/tips_and_tricks.html index 312725b..c9230a2 100644 --- a/documentation/tips_and_tricks.html +++ b/documentation/tips_and_tricks.html @@ -13,16 +13,15 @@ <p>This page shares some tips and tricks about the Phoronix Test Suite as well as some random information that some users may find useful.</p> <h2>General</h2> -<p>- If running within a GNOME desktop, the screensaver will automatically be +<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. If the using a different desktop environment, it will attempt -to interrupt the screensaver using an XDG command.</p> +the test's completion. This should work for GNOME, KDE, and other XDG-supportive desktop environments.</p> <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 support for Mac OS X and OpenSolaris may be added in -the future.</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 @@ -40,7 +39,8 @@ Phoronix Premium subscriber @ <a href="http://www.phoronix.com/scan.php?page=pho You may also contact us (phoronix [at] phoronix.com) for additional information or ideas.</p> <h2>Download Caches</h2> -<p>- If you're a company or simply own multiple computers, the download caching support of the Phoronix Test Suite can work quite well. This feature allows you to very simply setup a local (or network-wide) repository for the Phoronix Test Suite of all the files the different tests use. After you've installed the tests on one system that you normally use (or have ran <em>phoronix-test-suite install-all</em>) running <em>phoronix-test-suite make-download-cache</em> will cache all of the files that each test downloaded. The location of this cache is <em>~/.phoronix-test-suite/download-cache/</em>. Once the cache has been created, you can copy this folder to other systems and place the files in the same location. Then when the Phoronix Test Suite needs to download a file for a test, before downloading it from the Internet it will first check this cache for the file(s). If the files are there and the MD5 check-sums have been verified, it will simply copy the file -- thereby saving bandwidth and time. The download cache location can be downloaded in <em>~/.phoronix-test-suite/user-config.xml</em>. By adjusting the download cache, you could setup the cache folder to be on an FTP or NFS share (as an example) on a server that's accessible via your LAN. Configure your test systems to use this local repository and you'll be saving time and bandwidth.</p> +<p>- If you're a company or simply own multiple computers, the download caching support of the Phoronix Test Suite can work quite well. This feature allows you to very simply setup a local (or network-wide) repository for the Phoronix Test Suite of all the files the different tests use. After you've installed the tests on one system that you normally use (or have ran <em>phoronix-test-suite install-all</em>) running <em>phoronix-test-suite make-download-cache</em> will cache all of the files that each test downloaded. The location of this cache is <em>~/.phoronix-test-suite/download-cache/</em>.</p> +<p>Once the cache has been created, you can copy this folder to other systems and place the files in the same location. Then when the Phoronix Test Suite needs to download a file for a test, before downloading it from the Internet it will first check this cache for the file(s). If the files are there and the MD5 check-sums have been verified, it will simply copy the file -- thereby saving bandwidth and time. The download cache location can be downloaded in <em>~/.phoronix-test-suite/user-config.xml</em>. By adjusting the download cache, you could setup the cache folder to be on an FTP or NFS share (as an example) on a server that's accessible via your LAN. Configure your test systems to use this local repository and you'll be saving time and bandwidth.</p> <p>- I already have many of the source files for the standard tests, do I need to re-download them? Nope! Just throw them into <em>~/.phoronix-test-suite/download-cache/</em> and then fire up the Phoronix Test Suite. If the file-names and MD5 check-sums match, it will automatically use these cached files.</p> <h2>Configuration</h2> <p>- The user configuration options for the Phoronix Test Suite are stored in @@ -56,9 +56,16 @@ same generic <em>graph-config.xml</em> configuration is used.</p> <p>- The Phoronix Test Suite recursively determines tests/suites and allows a suite to call another suite.</p> <p>- One of the quickest and easiest ways to understand how to write a profile -is by just looking at the some of the existing profiles within the <em>pts/ </em>folder.</p> +is by just looking at the some of the existing profiles within the <em>pts/</em> folder.</p> <p>- The XML syntax for all file specifications are defined within <em>pts-core/functions/pts-interfaces.php</em> and trailing each definition is a comment describing its purpose / value.</p> +<h2>Module Writing</h2> +<p>- By writing a PTS module, you can easily extend the functionality of the Phoronix Test Suite. Some examples are +being able to email the results upon completion, controlling the system's screensaver, updating a text LCD panel with +the current test status, etc.</p> +<p>- One of the quickest and easiest ways to understand how to write a profile +is by just looking at the some of the existing modules within the <em>pts-core/modules</em> folder. The Phoronix Test +Suite has support for both shell and PHP modules.</p> <h2>Debugging</h2> <p>- Setting <em>DEBUG=1</em> as an environmental variable prior to running the Phoronix Test Suite will put it in a diagnostics mode. In this mode, additional diff --git a/documentation/writing_your_first_test.html b/documentation/writing_your_first_test.html index 3bf92ad..879af27 100644 --- a/documentation/writing_your_first_test.html +++ b/documentation/writing_your_first_test.html @@ -115,7 +115,7 @@ benchmark sample-program</em>. The Phoronix Test Suite should now handle the res installing the test, running the test, and recording the results (if you so choose). There is no additional work that needs to be done for the results to be recorded in the PTS Results Viewer or even reporting the results to PTS Global.</p> -<p><strong>For more information, visit <a href="http://www.phoronix-test-suite.com/">Phoronix-Test-Suite.com</a> and read the <a href="index.html">included documentation</a>. It should also be of great help to just look at the existing test profiles, which can be found inside the <em>phoronix-test-suite/pts/</em> folder with the <em>test-resources</em> and <em>test-profiles</em> sub directories.</strong></p> +<p><strong>For more information, visit <a href="http://www.phoronix-test-suite.com/">Phoronix-Test-Suite.com</a> and read the <a href="index.html">included documentation</a>. It should also be of great help to just look at the existing test profiles, which can be found inside the <em>phoronix-test-suite/pts/</em> folder with the <em>test-resources</em> and <em>test-profiles</em> sub-directories.</strong></p> <!-- END OF PTS AREA --> </div></div><div class="pts_doc_fixed"><div class="pts_doc_bottom"><div style="float: left;"><a href="http://www.phoronix-test-suite.com/">Phoronix-Test-Suite.com</a></div><div style="float: right;">Copyright © 2008 by <a href="http://www.phoronixmedia.com/">Phoronix Media</a>.</div></div></div> </body> diff --git a/phoronix-test-suite b/phoronix-test-suite index 30b7a5b..7087cf4 100755 --- a/phoronix-test-suite +++ b/phoronix-test-suite @@ -197,6 +197,7 @@ Batch Testing Options: batch-setup: Setup the batch mode options batch-run <suite OR test>: Run the specified test(s) in batch mode batch-benchmark <suite OR test OR saved file>: Install and run the test(s) in batch mode + analyze <suite / test / saved file / Global ID>: Provide an analysis of the results generated from a batch run Result Viewing Options: list-results: List all saved results |