diff options
| author | Michael Larabel <michael@phx-laptop.(none)> | 2008-05-30 18:02:14 -0400 |
|---|---|---|
| committer | Michael Larabel <michael@phx-laptop.(none)> | 2008-05-30 18:02:14 -0400 |
| commit | 57790e6294e857bcd0919ec7c3bc4dd034eba484 (patch) | |
| tree | 9225db4f519e3964e970854f3a0af9d14258f6d1 /documentation | |
| parent | a39a09c8166e49708dbc63e961420596def2875f (diff) | |
| download | phoronix-test-suite-upstream-57790e6294e857bcd0919ec7c3bc4dd034eba484.tar.gz phoronix-test-suite-upstream-57790e6294e857bcd0919ec7c3bc4dd034eba484.tar.xz phoronix-test-suite-upstream-57790e6294e857bcd0919ec7c3bc4dd034eba484.zip | |
Add installation documentation...
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/index.html | 1 | ||||
| -rw-r--r-- | documentation/install.html | 64 | ||||
| -rw-r--r-- | documentation/writing_your_first_test.html | 2 |
3 files changed, 66 insertions, 1 deletions
diff --git a/documentation/index.html b/documentation/index.html index e64ce75..7091962 100644 --- a/documentation/index.html +++ b/documentation/index.html @@ -35,6 +35,7 @@ Suite as either a developer, profile/suite maintainer for your favorite software package(s) (or other software that you develop), or support for your company, please contact <em>phoronix [at] phoronix.com</em>.</p> <p>Additionally, there are the <a href="http://www.phoronix.com/forums/forumdisplay.php?f=49">Phoronix Test Suite Forums</a> for support questions and related discussions as well as the <a href="http://phoronix-test-suite.com/mailman/listinfo/trondheim-pts_phoronix-test-suite.com">Phoronix Test Suite mailing list</a>.</p> <h2>Documentation</h2> +<h3><a href="install.html">Installation</a></h3> <h3><a href="pts_options.html">Explanation Of User Options</a></h3> <h3><a href="writing_your_first_test.html">Writing Your First Test Profile</a></h3> <h3><a href="10_press_release.html">1.0 Press Release</a></h3> diff --git a/documentation/install.html b/documentation/install.html new file mode 100644 index 0000000..c0d9a0d --- /dev/null +++ b/documentation/install.html @@ -0,0 +1,64 @@ +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<Title>Phoronix Test Suite - Installation Guidelines</Title> +<link href="includes/pts-documentation.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="pts_doc_header"><div class="pts_doc_fixed"><div id="pts_doc_logo"></div></div></div> +<div class="pts_doc_fixed"> +<div class="pts_doc_notice"><div style="float: left"><a href="index.html"><< Documentation Home</a></div><div style="float: right;">Installation Guidelines</div></div> +<div class="pts_doc_main"> +<!-- PTS AREA --> +<h1>Phoronix Test Suite Installation</h1> +<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 +Test Suite without installing it, open a terminal and run <em>./phoronix-test-suite +<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 +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>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> +<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 +where there is currently no External Dependencies profile, the needed package(s) +are listed.</p> +<h2>File Structure</h2> +<p>If manually changing the location of the phoronix-test-suite file, the environmental +<em>PTS_USER_DIR</em> variable must be adjusted inside the file to reflect the +absolute location that leads to the root directory of the <em>pts</em> and <em>pts-core</em> +folders. The <em>pts</em> folder houses the XML test profiles, XML test suites, +test resource files, the External Dependencies files, and other important information. +The <em>pts-core</em> directory is the "engine" of the Phoronix Test +Suite.</p> +<h2>Generic Installation</h2> +<p>Running install-sh from the root directory of the Phoronix Test Suite will +install the software for system-wide access. By default the <em>phoronix-test-suite</em> +exectable 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 +Suite in your home directory).</p> +<h2>Debian/Ubuntu Installation</h2> +<p>Debian/Ubuntu users are able to follow the Generic Installation instructions +or optionally can generate their own Debian package. If <em>dpkg-dev</em> is installed, +run <em>php pts/etc/scripts/package-build-deb.php</em> and a Debian package will +be generated which can be subsequently installed. This package contains the <em>phoronix-test-suite</em> +exectable in /usr/bin/, 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>.</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> +</html> diff --git a/documentation/writing_your_first_test.html b/documentation/writing_your_first_test.html index d68a9b9..58ea45c 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>For more information, visit <a href="http://www.phoronix-test-suite.com/">Phoronix-Test-Suite.com</a> and the <a href="index.html">included documentation</a>.</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 insie 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> |