summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Larabel <michael@phx-laptop.(none)>2008-08-06 18:01:25 -0400
committerMichael Larabel <michael@phx-laptop.(none)>2008-08-06 18:01:25 -0400
commitfc441cc72029ef2f560575225b55e14eba08f426 (patch)
tree12a5e9b97f3cf079ddb34292c7120c5086445d2b /documentation
parent0a76507207676c5bf6029d1b00772a18481fe435 (diff)
downloadphoronix-test-suite-upstream-fc441cc72029ef2f560575225b55e14eba08f426.tar.gz
phoronix-test-suite-upstream-fc441cc72029ef2f560575225b55e14eba08f426.tar.xz
phoronix-test-suite-upstream-fc441cc72029ef2f560575225b55e14eba08f426.zip
pts-core: Add test-module and debug-module options for running through
all module function calls for testing their functionality
Diffstat (limited to 'documentation')
-rw-r--r--documentation/sensor_monitoring.html2
-rw-r--r--documentation/writing_your_first_module.html4
2 files changed, 5 insertions, 1 deletions
diff --git a/documentation/sensor_monitoring.html b/documentation/sensor_monitoring.html
index 8cad5ae..c6931e0 100644
--- a/documentation/sensor_monitoring.html
+++ b/documentation/sensor_monitoring.html
@@ -24,7 +24,7 @@ system temperature, battery power consumption, CPU voltage, +3.33V line voltage,
in the future.</p>
<p>The full list of supported sensor options can be found by running <em>phoronix-test-suite
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
+values can be read by running <em>phoronix-test-suite test-module system_monitor</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,
one would run <em>MONITOR=cpu.temp phoronix-test-suite benchmark universe</em>.
diff --git a/documentation/writing_your_first_module.html b/documentation/writing_your_first_module.html
index f066117..a015614 100644
--- a/documentation/writing_your_first_module.html
+++ b/documentation/writing_your_first_module.html
@@ -37,6 +37,10 @@ defined in <em>PTS_MODULES</em> can be set within the <em>LoadModules</em> tag
found in <em>~/.phoronix-test-suite/user-config.xml</em>. Multiple modules can
be loaded simultaneously using the <em>PTS_MODULES</em> variable or <em>LoadModules</em>
tag by delimiting each command with a comma (<em>,</em>).</p>
+<p>Note: To run through all of the function calls for a module without needing to run a test,
+run <em>phoronix-test-suite test-module MODULE_NAME</em>. Additionally, running
+<em>phoronix-test-suite debug-module MODULE_NAME</em> will yield additional debugging details while
+executing the same process.</p>
<h1>PHP Module</h1>
<p>To see all of the functions supported for modules written in PHP, look at <em>pts-core/modules/dummy_module.php</em>
and additionally the other .php modules that ship with the Phoronix Test Suite.