summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Larabel <michael@phx-laptop.(none)>2008-09-12 12:13:29 -0400
committerMichael Larabel <michael@phx-laptop.(none)>2008-09-12 12:13:29 -0400
commit82a686b2eec06bd084f89260eddb2a0114ab1605 (patch)
treef1d006df38f696064b7107566f7bbeeffcc3ee63 /documentation
parentfcdc23e0f8c342b471498ed58e3cfe42172bb4e5 (diff)
downloadphoronix-test-suite-upstream-82a686b2eec06bd084f89260eddb2a0114ab1605.tar.gz
phoronix-test-suite-upstream-82a686b2eec06bd084f89260eddb2a0114ab1605.tar.xz
phoronix-test-suite-upstream-82a686b2eec06bd084f89260eddb2a0114ab1605.zip
pts-core: Add support for persistent configuration options that
end-users can easily adjust for PTS modules by running "phoronix-test-suite module-setup MODULE-NAME" that are stored to ~/.phoronix-test-suite/modules-config.xml
Diffstat (limited to 'documentation')
-rw-r--r--documentation/pts_options.html4
1 files changed, 4 insertions, 0 deletions
diff --git a/documentation/pts_options.html b/documentation/pts_options.html
index 4a5da32..8f90379 100644
--- a/documentation/pts_options.html
+++ b/documentation/pts_options.html
@@ -129,6 +129,10 @@ at http://global.phoronix-test-suite.com/.</p>
Modules are used for extending the functionality of the Phoronix Test Suite without over-inflating the pts-core.</p>
<p><strong>module-info &lt;Module Name&gt;</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>
+<p><strong>module-setup &lt;Module Name&gt;</strong></p>
+<p>This option will allow you to configure all available end-user options for a PTS module. These options are then stored within the user's
+configuration file. Not all modules may have options that can be configured by the end-user. These options are then stored in
+<em>~/.phoronix-test-suite/modules-config.xml</em> and modules can access them using the <em>pts_module::read_option()</em> function.</p>
<h2>Miscellaneous Options</h2>
<p><strong>make-download-cache</strong></p>
<p>This option will backup all files that were automatically downloaded by the