josh/phoronix-test-suite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

pts-core: Fix various typos in correct source locations, rebuild docs

Browse Source 
Closes: https://github.com/phoronix-test-suite/phoronix-test-suite/pull/804
This commit is contained in:
Michael Larabel
2024-08-17 20:05:21 -05:00
parent c259552dc1
commit 781d435be2
17 changed files with 774 additions and 719 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
documentation/man-pages/phoronix-test-suite.1
View File

@@ -258,7 +258,7 @@ This option can be used for validating a Phoronix Test Suite test suite as being
This option is used if you wish to automatically attempt to sort the results by their result identifier string. Alternatively, if using the environment variable "SORT_BY" other sort modes can be used, such as SORT_BY=date / SORT_BY=date-desc for sorting by the test run-time/date. This option is used if you wish to automatically attempt to sort the results by their result identifier string. Alternatively, if using the environment variable "SORT_BY" other sort modes can be used, such as SORT_BY=date / SORT_BY=date-desc for sorting by the test run-time/date.
.TP .TP
.B compare-results-to-baseline [Test Result] [Test Result] .B compare-results-to-baseline [Test Result] [Test Result]
This option will allows you to specify a result as a baseline (first parameter) and a second result file (second parameter) that will offer some analysis for showing how the second result compares to the first in matching tests. This option allows you to specify a result as a baseline (first parameter) and a second result file (second parameter) that will offer some analysis for showing how the second result compares to the first in matching tests.
.TP .TP
.B compare-results-two-way [Test Result] .B compare-results-two-way [Test Result]
This option will allows you to specify a result file and from there to compare two individual runs within that result file for looking at wins/losses and other metrics in a head-to-head type comparison. This option will allows you to specify a result file and from there to compare two individual runs within that result file for looking at wins/losses and other metrics in a head-to-head type comparison.
@@ -267,7 +267,7 @@ This option will allows you to specify a result file and from there to compare t
This option is used if you wish to edit the title and description of an existing result file. This option is used if you wish to edit the title and description of an existing result file.
.TP .TP
.B extract-from-result-file [Test Result] .B extract-from-result-file [Test Result]
This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is the prompted to specify a new result file name and select which result identifier to extract. This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is then prompted to specify a new result file name and select which result identifier to extract.
.TP .TP
.B keep-results-in-result-file [Test Result] .B keep-results-in-result-file [Test Result]
This option is the inverse of the remove-results-from-result-file sub-command. If you wish to remove all results but those listed from a given result file, this option can be used. The user must specify a saved results file and then they will be prompted to provide a string to search for in keeping those results in that given result file but removing all other data. This option is the inverse of the remove-results-from-result-file sub-command. If you wish to remove all results but those listed from a given result file, this option can be used. The user must specify a saved results file and then they will be prompted to provide a string to search for in keeping those results in that given result file but removing all other data.
@@ -278,6 +278,9 @@ This option will manually merge multiple sets of test results generated by the P
.B prune-empty-results [Test Result] .B prune-empty-results [Test Result]
This option is used if there are test results (benchmarks) to be dropped from a given result file that had no successful runs. I.e. if any run attempt(s) only errored out without producing any result for any of the test run(s) saved in that file. The user must specify a saved results file. This option is used if there are test results (benchmarks) to be dropped from a given result file that had no successful runs. I.e. if any run attempt(s) only errored out without producing any result for any of the test run(s) saved in that file. The user must specify a saved results file.
.TP .TP
.B prune-zero-data [Test Result]
This option is used if there are test results (benchmarks) to be where there is line graph data that currently has zero values (e.g. inaccurate/invalid sensor readings) and you wish to just drop those zero reading values from the result file.
.TP
.B remove-incomplete-results-from-result-file [Test Result] .B remove-incomplete-results-from-result-file [Test Result]
This option is used if there are test results (benchmarks) to be dropped from a given result file for having incomplete data, either a test run did not attempt to run that benchmark or failed to properly run. The user must specify a saved results file and the command will then attempt to find any results with incomplete/missing data and prompt the user with confirmation to remove them. This option is used if there are test results (benchmarks) to be dropped from a given result file for having incomplete data, either a test run did not attempt to run that benchmark or failed to properly run. The user must specify a saved results file and the command will then attempt to find any results with incomplete/missing data and prompt the user with confirmation to remove them.
.TP .TP
@@ -313,10 +316,10 @@ This option will display a short list of possible Phoronix Test Suite commands.
This option is used for testing the distribution-specific dependency handler for external dependencies. This option is used for testing the distribution-specific dependency handler for external dependencies.
.TP .TP
.B debug-render-test .B debug-render-test
This option is used during the development of the Phoronix Test Suite software for testing of the result and graph rendering code-paths This option will download a large number of reference test results from LinuxBenchmarking.com. This option is used during the development of the Phoronix Test Suite software for testing of the result and graph rendering code paths. This option will download a large number of reference test results from LinuxBenchmarking.com.
.TP .TP
.B debug-self-test .B debug-self-test
This option is used during the development of the Phoronix Test Suite software for testing of internal interfaces, commands, and other common code-paths. The produced numbers should only be comparable for the same version of the Phoronix Test Suite, on the same hardware/software system, conducted on the same day of testing. This isn't intended as any scientific benchmark but simply to stress common PHP code-paths and looking for hot areas to optimize, etc. This option is used during the development of the Phoronix Test Suite software for testing of internal interfaces, commands, and other common code paths. The produced numbers should only be comparable for the same version of the Phoronix Test Suite, on the same hardware/software system, conducted on the same day of testing. This isn't intended as any scientific benchmark but simply to stress common PHP code paths and looking for hot areas to optimize, etc.
.TP .TP
.B help .B help
This option will display a list of available Phoronix Test Suite commands and possible parameter types. This option will display a list of available Phoronix Test Suite commands and possible parameter types.
@@ -341,7 +344,7 @@ This option is used if you wish to analyze a result file by seeing various stati
This option is used if you wish to analyze a result file to see which runs produced the most wins/losses of those result identifiers in the saved file. This option is used if you wish to analyze a result file to see which runs produced the most wins/losses of those result identifiers in the saved file.
.TP .TP
.B workload-topology [Test Result] .B workload-topology [Test Result]
This option will read a saved test results file and print the test profiles contained within and their arrangement within different test suites for getting an idea as to the workload topology/make-up / logical groupings of the benchmarks being run. This option will read a saved test results file and print the test profiles contained within and their arrangement within different test suites for getting an idea as to the workload topology / make-up / logical groupings of the benchmarks being run.
.TP .TP
.SH MODULES .SH MODULES
.B auto-load-module .B auto-load-module
@@ -364,13 +367,13 @@ This option can be used for easily removing a module from the AutoLoadModules li
.TP .TP
.SH DEBUGGING .SH DEBUGGING
.B check-tests [Test] .B check-tests [Test]
This option will perform a check on one or more test profiles to determine if there have been any vendor changes to the filename, filesize, url location, md5 and sha256 checksums. This option will perform a check on one or more test profiles to determine if there have been any vendor changes to the filename, filesize, URL location, MD5 and SHA256 checksums.
.TP .TP
.B diagnostics .B diagnostics
This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites. This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites.
.TP .TP
.B dump-file-info .B dump-file-info
This option will dump the MD5 / SHA256 hashes and file size for a given file. This option will dump the MD5 / SHA256 checksums and file size for a given file.
.TP .TP
.B dump-openbenchmarking-indexes .B dump-openbenchmarking-indexes
This option is used for dumping the parsed output of OpenBenchmarking.org index files (metadata). This option is used for dumping the parsed output of OpenBenchmarking.org index files (metadata).
@@ -395,7 +398,7 @@ This option will list all available test profiles that are available from the en
.TP .TP
.SH USER CONFIGURATION .SH USER CONFIGURATION
.B enterprise-setup .B enterprise-setup
This option can be run by enterprise users immediately after package installation or as part of an in-house setup script. Running this command will ensure the phoronix-test-suite program is never interrupted on new runs to accept user agreement changes and defaults the anonymous usage reporting to being disabled and other conservative defaults. This option can be run by enterprise users immediately after package installation or as part of an in-house setup script. Running this command will ensure the phoronix-test-suite program is never interrupted on new runs to accept user agreement changes. It also defaults the anonymous usage reporting to being disabled, along with other conservative settings.
.TP .TP
.B network-info .B network-info
This option will print information detected by the Phoronix Test Suite around the system's network configuration. This option will print information detected by the Phoronix Test Suite around the system's network configuration.
@@ -417,7 +420,7 @@ This option will print all of the official environment variables supported by th
This option will read a saved test results file and output the raw result file run data to a CSV file. This raw (individual) result file output is intended for data analytic purposes where the result-file-to-csv is more end-user-ready. This option will read a saved test results file and output the raw result file run data to a CSV file. This raw (individual) result file output is intended for data analytic purposes where the result-file-to-csv is more end-user-ready.
.TP .TP
.B result-file-to-csv [Test Result] .B result-file-to-csv [Test Result]
This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output. The CSV (Comma Separated Values) output can then be loaded into a spreadsheet for easy viewing. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables. This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output (Comma Separated Values) file. This file can then be loaded into a spreadsheet for easy viewing. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.
.TP .TP
.B result-file-to-html [Test Result] .B result-file-to-html [Test Result]
This option will read a saved test results file and output the system hardware and software information along with the results to pure HTML file. No external files are required for CSS/JavaScript or other assets. The graphs are rendered as inline SVG. This is a pure HTML-only representation of the results for emailing or other easy analysis outside of the Phoronix Test Suite. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables. This option will read a saved test results file and output the system hardware and software information along with the results to pure HTML file. No external files are required for CSS/JavaScript or other assets. The graphs are rendered as inline SVG. This is a pure HTML-only representation of the results for emailing or other easy analysis outside of the Phoronix Test Suite. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.

29
documentation/phoronix-test-suite.html
View File

@@ -426,7 +426,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<p>This option is used if you wish to automatically attempt to sort the results by their result identifier string. Alternatively, if using the environment variable "SORT_BY" other sort modes can be used, such as SORT_BY=date / SORT_BY=date-desc for sorting by the test run-time/date.</p> <p>This option is used if you wish to automatically attempt to sort the results by their result identifier string. Alternatively, if using the environment variable "SORT_BY" other sort modes can be used, such as SORT_BY=date / SORT_BY=date-desc for sorting by the test run-time/date.</p>
<h3>compare-results-to-baseline<em> [Test Result] [Test Result]</em> <h3>compare-results-to-baseline<em> [Test Result] [Test Result]</em>
</h3> </h3>
<p>This option will allows you to specify a result as a baseline (first parameter) and a second result file (second parameter) that will offer some analysis for showing how the second result compares to the first in matching tests.</p> <p>This option allows you to specify a result as a baseline (first parameter) and a second result file (second parameter) that will offer some analysis for showing how the second result compares to the first in matching tests.</p>
<h3>compare-results-two-way<em> [Test Result]</em> <h3>compare-results-two-way<em> [Test Result]</em>
</h3> </h3>
<p>This option will allows you to specify a result file and from there to compare two individual runs within that result file for looking at wins/losses and other metrics in a head-to-head type comparison.</p> <p>This option will allows you to specify a result file and from there to compare two individual runs within that result file for looking at wins/losses and other metrics in a head-to-head type comparison.</p>
@@ -435,7 +435,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<p>This option is used if you wish to edit the title and description of an existing result file.</p> <p>This option is used if you wish to edit the title and description of an existing result file.</p>
<h3>extract-from-result-file<em> [Test Result]</em> <h3>extract-from-result-file<em> [Test Result]</em>
</h3> </h3>
<p>This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is the prompted to specify a new result file name and select which result identifier to extract.</p> <p>This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is then prompted to specify a new result file name and select which result identifier to extract.</p>
<h3>keep-results-in-result-file<em> [Test Result]</em> <h3>keep-results-in-result-file<em> [Test Result]</em>
</h3> </h3>
<p>This option is the inverse of the remove-results-from-result-file sub-command. If you wish to remove all results but those listed from a given result file, this option can be used. The user must specify a saved results file and then they will be prompted to provide a string to search for in keeping those results in that given result file but removing all other data.</p> <p>This option is the inverse of the remove-results-from-result-file sub-command. If you wish to remove all results but those listed from a given result file, this option can be used. The user must specify a saved results file and then they will be prompted to provide a string to search for in keeping those results in that given result file but removing all other data.</p>
@@ -445,6 +445,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<h3>prune-empty-results<em> [Test Result]</em> <h3>prune-empty-results<em> [Test Result]</em>
</h3> </h3>
<p>This option is used if there are test results (benchmarks) to be dropped from a given result file that had no successful runs. I.e. if any run attempt(s) only errored out without producing any result for any of the test run(s) saved in that file. The user must specify a saved results file.</p> <p>This option is used if there are test results (benchmarks) to be dropped from a given result file that had no successful runs. I.e. if any run attempt(s) only errored out without producing any result for any of the test run(s) saved in that file. The user must specify a saved results file.</p>
<h3>prune-zero-data<em> [Test Result]</em>
</h3>
<p>This option is used if there are test results (benchmarks) to be where there is line graph data that currently has zero values (e.g. inaccurate/invalid sensor readings) and you wish to just drop those zero reading values from the result file.</p>
<h3>remove-incomplete-results-from-result-file<em> [Test Result]</em> <h3>remove-incomplete-results-from-result-file<em> [Test Result]</em>
</h3> </h3>
<p>This option is used if there are test results (benchmarks) to be dropped from a given result file for having incomplete data, either a test run did not attempt to run that benchmark or failed to properly run. The user must specify a saved results file and the command will then attempt to find any results with incomplete/missing data and prompt the user with confirmation to remove them.</p> <p>This option is used if there are test results (benchmarks) to be dropped from a given result file for having incomplete data, either a test run did not attempt to run that benchmark or failed to properly run. The user must specify a saved results file and the command will then attempt to find any results with incomplete/missing data and prompt the user with confirmation to remove them.</p>
@@ -478,9 +481,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<h3>debug-dependency-handler</h3> <h3>debug-dependency-handler</h3>
<p>This option is used for testing the distribution-specific dependency handler for external dependencies.</p> <p>This option is used for testing the distribution-specific dependency handler for external dependencies.</p>
<h3>debug-render-test</h3> <h3>debug-render-test</h3>
<p>This option is used during the development of the Phoronix Test Suite software for testing of the result and graph rendering code-paths This option will download a large number of reference test results from LinuxBenchmarking.com.</p> <p>This option is used during the development of the Phoronix Test Suite software for testing of the result and graph rendering code paths. This option will download a large number of reference test results from LinuxBenchmarking.com.</p>
<h3>debug-self-test</h3> <h3>debug-self-test</h3>
<p>This option is used during the development of the Phoronix Test Suite software for testing of internal interfaces, commands, and other common code-paths. The produced numbers should only be comparable for the same version of the Phoronix Test Suite, on the same hardware/software system, conducted on the same day of testing. This isn't intended as any scientific benchmark but simply to stress common PHP code-paths and looking for hot areas to optimize, etc.</p> <p>This option is used during the development of the Phoronix Test Suite software for testing of internal interfaces, commands, and other common code paths. The produced numbers should only be comparable for the same version of the Phoronix Test Suite, on the same hardware/software system, conducted on the same day of testing. This isn't intended as any scientific benchmark but simply to stress common PHP code paths and looking for hot areas to optimize, etc.</p>
<h3>help</h3> <h3>help</h3>
<p>This option will display a list of available Phoronix Test Suite commands and possible parameter types.</p> <p>This option will display a list of available Phoronix Test Suite commands and possible parameter types.</p>
<h3>version</h3> <h3>version</h3>
@@ -503,7 +506,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<p>This option is used if you wish to analyze a result file to see which runs produced the most wins/losses of those result identifiers in the saved file.</p> <p>This option is used if you wish to analyze a result file to see which runs produced the most wins/losses of those result identifiers in the saved file.</p>
<h3>workload-topology<em> [Test Result]</em> <h3>workload-topology<em> [Test Result]</em>
</h3> </h3>
<p>This option will read a saved test results file and print the test profiles contained within and their arrangement within different test suites for getting an idea as to the workload topology/make-up / logical groupings of the benchmarks being run.</p> <p>This option will read a saved test results file and print the test profiles contained within and their arrangement within different test suites for getting an idea as to the workload topology / make-up / logical groupings of the benchmarks being run.</p>
<h1>Modules</h1> <h1>Modules</h1>
<h3>auto-load-module</h3> <h3>auto-load-module</h3>
<p>This option can be used for easily adding a module to the AutoLoadModules list in the Phoronix Test Suite user configuration file. That list controls what PTS modules are automatically loaded on start-up of the Phoronix Test Suite.</p> <p>This option can be used for easily adding a module to the AutoLoadModules list in the Phoronix Test Suite user configuration file. That list controls what PTS modules are automatically loaded on start-up of the Phoronix Test Suite.</p>
@@ -523,11 +526,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<h1>Debugging</h1> <h1>Debugging</h1>
<h3>check-tests<em> [Test]</em> <h3>check-tests<em> [Test]</em>
</h3> </h3>
<p>This option will perform a check on one or more test profiles to determine if there have been any vendor changes to the filename, filesize, url location, md5 and sha256 checksums.</p> <p>This option will perform a check on one or more test profiles to determine if there have been any vendor changes to the filename, filesize, URL location, MD5 and SHA256 checksums.</p>
<h3>diagnostics</h3> <h3>diagnostics</h3>
<p>This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites.</p> <p>This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites.</p>
<h3>dump-file-info</h3> <h3>dump-file-info</h3>
<p>This option will dump the MD5 / SHA256 hashes and file size for a given file.</p> <p>This option will dump the MD5 / SHA256 checksums and file size for a given file.</p>
<h3>dump-openbenchmarking-indexes</h3> <h3>dump-openbenchmarking-indexes</h3>
<p>This option is used for dumping the parsed output of OpenBenchmarking.org index files (metadata).</p> <p>This option is used for dumping the parsed output of OpenBenchmarking.org index files (metadata).</p>
<h3>dump-phodevi-smart-cache</h3> <h3>dump-phodevi-smart-cache</h3>
@@ -544,7 +547,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<p>This option will list all available test profiles that are available from the enabled OpenBenchmarking.org repositories but are NOT SUPPORTED on the given hardware/software platform. This is mainly a debugging option for those looking for test profiles to potentially port to new platforms, etc.</p> <p>This option will list all available test profiles that are available from the enabled OpenBenchmarking.org repositories but are NOT SUPPORTED on the given hardware/software platform. This is mainly a debugging option for those looking for test profiles to potentially port to new platforms, etc.</p>
<h1>User Configuration</h1> <h1>User Configuration</h1>
<h3>enterprise-setup</h3> <h3>enterprise-setup</h3>
<p>This option can be run by enterprise users immediately after package installation or as part of an in-house setup script. Running this command will ensure the phoronix-test-suite program is never interrupted on new runs to accept user agreement changes and defaults the anonymous usage reporting to being disabled and other conservative defaults.</p> <p>This option can be run by enterprise users immediately after package installation or as part of an in-house setup script. Running this command will ensure the phoronix-test-suite program is never interrupted on new runs to accept user agreement changes. It also defaults the anonymous usage reporting to being disabled, along with other conservative settings.</p>
<h3>network-info</h3> <h3>network-info</h3>
<p>This option will print information detected by the Phoronix Test Suite around the system's network configuration.</p> <p>This option will print information detected by the Phoronix Test Suite around the system's network configuration.</p>
<h3>network-setup</h3> <h3>network-setup</h3>
@@ -561,7 +564,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<p>This option will read a saved test results file and output the raw result file run data to a CSV file. This raw (individual) result file output is intended for data analytic purposes where the result-file-to-csv is more end-user-ready.</p> <p>This option will read a saved test results file and output the raw result file run data to a CSV file. This raw (individual) result file output is intended for data analytic purposes where the result-file-to-csv is more end-user-ready.</p>
<h3>result-file-to-csv<em> [Test Result]</em> <h3>result-file-to-csv<em> [Test Result]</em>
</h3> </h3>
<p>This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output. The CSV (Comma Separated Values) output can then be loaded into a spreadsheet for easy viewing. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.</p> <p>This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output (Comma Separated Values) file. This file can then be loaded into a spreadsheet for easy viewing. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.</p>
<h3>result-file-to-html<em> [Test Result]</em> <h3>result-file-to-html<em> [Test Result]</em>
</h3> </h3>
<p>This option will read a saved test results file and output the system hardware and software information along with the results to pure HTML file. No external files are required for CSS/JavaScript or other assets. The graphs are rendered as inline SVG. This is a pure HTML-only representation of the results for emailing or other easy analysis outside of the Phoronix Test Suite. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.</p> <p>This option will read a saved test results file and output the system hardware and software information along with the results to pure HTML file. No external files are required for CSS/JavaScript or other assets. The graphs are rendered as inline SVG. This is a pure HTML-only representation of the results for emailing or other easy analysis outside of the Phoronix Test Suite. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.</p>
@@ -586,7 +589,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<hr style="height: 50px; border: 0;"><a name="ModuleOptions"></a><h1>Module Options</h1> <hr style="height: 50px; border: 0;"><a name="ModuleOptions"></a><h1>Module Options</h1>
<p>The following list is the modules included with the Phoronix Test Suite that are intended to extend the functionality of pts-core. Some of these options have commands that can be run directly in a similar manner to the other Phoronix Test Suite user commands. Some modules are just meant to be loaded directly by adding the module name to the AutoLoadModules tag in ~/.phoronix-test-suite/user-config.xml or via the PTS_MODULES environment variable. A list of available modules is also available by running <em>phoronix-test-suite list-modules.</em></p><hr> <p>The following list is the modules included with the Phoronix Test Suite that are intended to extend the functionality of pts-core. Some of these options have commands that can be run directly in a similar manner to the other Phoronix Test Suite user commands. Some modules are just meant to be loaded directly by adding the module name to the AutoLoadModules tag in ~/.phoronix-test-suite/user-config.xml or via the PTS_MODULES environment variable. A list of available modules is also available by running <em>phoronix-test-suite list-modules.</em></p><hr>
<h2>Backup Creation + Restore</h2> <h2>Backup Creation + Restore</h2>
<p>This is a module for creating backups of the Phoronix Test Suite / Phoromatic and allows for restoring of created backups. The backup will be in ZIP or TAR format. If only a path is specified, the file-name will be auto-generated with a current time-stamp.</p> <p>This is a module for creating backups of the Phoronix Test Suite / Phoromatic and allows for restoring of created backups. The backup will be in ZIP or TAR format. If only a path is specified, the filename will be auto-generated with a current timestamp.</p>
<p><strong>phoronix-test-suite backup.create</strong></p> <p><strong>phoronix-test-suite backup.create</strong></p>
<p><strong>phoronix-test-suite backup.restore</strong></p> <p><strong>phoronix-test-suite backup.restore</strong></p>
<h2>System Maintenance / Cleanup</h2> <h2>System Maintenance / Cleanup</h2>
@@ -1544,6 +1547,12 @@ In the event that a test profile fails to install or run, the following general
<h3>Smp Tests<em> system/smp</em> <h3>Smp Tests<em> system/smp</em>
</h3> </h3>
<p>This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing smp.</p> <p>This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing smp.</p>
<h3>Openmp Tests<em> system/openmp</em>
</h3>
<p>This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing openmp.</p>
<h3>Mpi Tests<em> system/mpi</em>
</h3>
<p>This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing mpi.</p>
<h3>64-bit Arm / AArch64 Tests In git<em> git/aarch64</em> <h3>64-bit Arm / AArch64 Tests In git<em> git/aarch64</em>
</h3> </h3>
<p>This is a collection of test profiles where there have been successful benchmark results submitted to OpenBenchmarking.org from 64-bit Arm / AArch64 CPU architecture hardware, i.e. these tests are proven to be 64-bit Arm / AArch64 compatible though not necessarily all compatible test profiles for the given architecture - just those with submitted public results previously on OpenBenchmarking.org.</p> <p>This is a collection of test profiles where there have been successful benchmark results submitted to OpenBenchmarking.org from 64-bit Arm / AArch64 CPU architecture hardware, i.e. these tests are proven to be 64-bit Arm / AArch64 compatible though not necessarily all compatible test profiles for the given architecture - just those with submitted public results previously on OpenBenchmarking.org.</p>

29
documentation/phoronix-test-suite.md
View File

@@ -287,7 +287,7 @@ This option can be used for validating a Phoronix Test Suite test suite as being
This option is used if you wish to automatically attempt to sort the results by their result identifier string. Alternatively, if using the environment variable "SORT_BY" other sort modes can be used, such as SORT_BY=date / SORT_BY=date-desc for sorting by the test run-time/date. This option is used if you wish to automatically attempt to sort the results by their result identifier string. Alternatively, if using the environment variable "SORT_BY" other sort modes can be used, such as SORT_BY=date / SORT_BY=date-desc for sorting by the test run-time/date.
#### compare-results-to-baseline [Test Result] [Test Result] #### compare-results-to-baseline [Test Result] [Test Result]
This option will allows you to specify a result as a baseline (first parameter) and a second result file (second parameter) that will offer some analysis for showing how the second result compares to the first in matching tests. This option allows you to specify a result as a baseline (first parameter) and a second result file (second parameter) that will offer some analysis for showing how the second result compares to the first in matching tests.
#### compare-results-two-way [Test Result] #### compare-results-two-way [Test Result]
This option will allows you to specify a result file and from there to compare two individual runs within that result file for looking at wins/losses and other metrics in a head-to-head type comparison. This option will allows you to specify a result file and from there to compare two individual runs within that result file for looking at wins/losses and other metrics in a head-to-head type comparison.
@@ -296,7 +296,7 @@ This option will allows you to specify a result file and from there to compare t
This option is used if you wish to edit the title and description of an existing result file. This option is used if you wish to edit the title and description of an existing result file.
#### extract-from-result-file [Test Result] #### extract-from-result-file [Test Result]
This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is the prompted to specify a new result file name and select which result identifier to extract. This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is then prompted to specify a new result file name and select which result identifier to extract.
#### keep-results-in-result-file [Test Result] #### keep-results-in-result-file [Test Result]
This option is the inverse of the remove-results-from-result-file sub-command. If you wish to remove all results but those listed from a given result file, this option can be used. The user must specify a saved results file and then they will be prompted to provide a string to search for in keeping those results in that given result file but removing all other data. This option is the inverse of the remove-results-from-result-file sub-command. If you wish to remove all results but those listed from a given result file, this option can be used. The user must specify a saved results file and then they will be prompted to provide a string to search for in keeping those results in that given result file but removing all other data.
@@ -307,6 +307,9 @@ This option will manually merge multiple sets of test results generated by the P
#### prune-empty-results [Test Result] #### prune-empty-results [Test Result]
This option is used if there are test results (benchmarks) to be dropped from a given result file that had no successful runs. I.e. if any run attempt(s) only errored out without producing any result for any of the test run(s) saved in that file. The user must specify a saved results file. This option is used if there are test results (benchmarks) to be dropped from a given result file that had no successful runs. I.e. if any run attempt(s) only errored out without producing any result for any of the test run(s) saved in that file. The user must specify a saved results file.
#### prune-zero-data [Test Result]
This option is used if there are test results (benchmarks) to be where there is line graph data that currently has zero values (e.g. inaccurate/invalid sensor readings) and you wish to just drop those zero reading values from the result file.
#### remove-incomplete-results-from-result-file [Test Result] #### remove-incomplete-results-from-result-file [Test Result]
This option is used if there are test results (benchmarks) to be dropped from a given result file for having incomplete data, either a test run did not attempt to run that benchmark or failed to properly run. The user must specify a saved results file and the command will then attempt to find any results with incomplete/missing data and prompt the user with confirmation to remove them. This option is used if there are test results (benchmarks) to be dropped from a given result file for having incomplete data, either a test run did not attempt to run that benchmark or failed to properly run. The user must specify a saved results file and the command will then attempt to find any results with incomplete/missing data and prompt the user with confirmation to remove them.
@@ -343,10 +346,10 @@ This option will display a short list of possible Phoronix Test Suite commands.
This option is used for testing the distribution-specific dependency handler for external dependencies. This option is used for testing the distribution-specific dependency handler for external dependencies.
#### debug-render-test #### debug-render-test
This option is used during the development of the Phoronix Test Suite software for testing of the result and graph rendering code-paths This option will download a large number of reference test results from LinuxBenchmarking.com. This option is used during the development of the Phoronix Test Suite software for testing of the result and graph rendering code paths. This option will download a large number of reference test results from LinuxBenchmarking.com.
#### debug-self-test #### debug-self-test
This option is used during the development of the Phoronix Test Suite software for testing of internal interfaces, commands, and other common code-paths. The produced numbers should only be comparable for the same version of the Phoronix Test Suite, on the same hardware/software system, conducted on the same day of testing. This isn't intended as any scientific benchmark but simply to stress common PHP code-paths and looking for hot areas to optimize, etc. This option is used during the development of the Phoronix Test Suite software for testing of internal interfaces, commands, and other common code paths. The produced numbers should only be comparable for the same version of the Phoronix Test Suite, on the same hardware/software system, conducted on the same day of testing. This isn't intended as any scientific benchmark but simply to stress common PHP code paths and looking for hot areas to optimize, etc.
#### help #### help
This option will display a list of available Phoronix Test Suite commands and possible parameter types. This option will display a list of available Phoronix Test Suite commands and possible parameter types.
@@ -372,7 +375,7 @@ This option is used if you wish to analyze a result file by seeing various stati
This option is used if you wish to analyze a result file to see which runs produced the most wins/losses of those result identifiers in the saved file. This option is used if you wish to analyze a result file to see which runs produced the most wins/losses of those result identifiers in the saved file.
#### workload-topology [Test Result] #### workload-topology [Test Result]
This option will read a saved test results file and print the test profiles contained within and their arrangement within different test suites for getting an idea as to the workload topology/make-up / logical groupings of the benchmarks being run. This option will read a saved test results file and print the test profiles contained within and their arrangement within different test suites for getting an idea as to the workload topology / make-up / logical groupings of the benchmarks being run.
## Modules ## Modules
@@ -397,13 +400,13 @@ This option can be used for easily removing a module from the AutoLoadModules li
## Debugging ## Debugging
#### check-tests [Test] #### check-tests [Test]
This option will perform a check on one or more test profiles to determine if there have been any vendor changes to the filename, filesize, url location, md5 and sha256 checksums. This option will perform a check on one or more test profiles to determine if there have been any vendor changes to the filename, filesize, URL location, MD5 and SHA256 checksums.
#### diagnostics #### diagnostics
This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites. This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites.
#### dump-file-info #### dump-file-info
This option will dump the MD5 / SHA256 hashes and file size for a given file. This option will dump the MD5 / SHA256 checksums and file size for a given file.
#### dump-openbenchmarking-indexes #### dump-openbenchmarking-indexes
This option is used for dumping the parsed output of OpenBenchmarking.org index files (metadata). This option is used for dumping the parsed output of OpenBenchmarking.org index files (metadata).
@@ -429,7 +432,7 @@ This option will list all available test profiles that are available from the en
## User Configuration ## User Configuration
#### enterprise-setup #### enterprise-setup
This option can be run by enterprise users immediately after package installation or as part of an in-house setup script. Running this command will ensure the phoronix-test-suite program is never interrupted on new runs to accept user agreement changes and defaults the anonymous usage reporting to being disabled and other conservative defaults. This option can be run by enterprise users immediately after package installation or as part of an in-house setup script. Running this command will ensure the phoronix-test-suite program is never interrupted on new runs to accept user agreement changes. It also defaults the anonymous usage reporting to being disabled, along with other conservative settings.
#### network-info #### network-info
This option will print information detected by the Phoronix Test Suite around the system's network configuration. This option will print information detected by the Phoronix Test Suite around the system's network configuration.
@@ -452,7 +455,7 @@ This option will print all of the official environment variables supported by th
This option will read a saved test results file and output the raw result file run data to a CSV file. This raw (individual) result file output is intended for data analytic purposes where the result-file-to-csv is more end-user-ready. This option will read a saved test results file and output the raw result file run data to a CSV file. This raw (individual) result file output is intended for data analytic purposes where the result-file-to-csv is more end-user-ready.
#### result-file-to-csv [Test Result] #### result-file-to-csv [Test Result]
This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output. The CSV (Comma Separated Values) output can then be loaded into a spreadsheet for easy viewing. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables. This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output (Comma Separated Values) file. This file can then be loaded into a spreadsheet for easy viewing. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.
#### result-file-to-html [Test Result] #### result-file-to-html [Test Result]
This option will read a saved test results file and output the system hardware and software information along with the results to pure HTML file. No external files are required for CSS/JavaScript or other assets. The graphs are rendered as inline SVG. This is a pure HTML-only representation of the results for emailing or other easy analysis outside of the Phoronix Test Suite. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables. This option will read a saved test results file and output the system hardware and software information along with the results to pure HTML file. No external files are required for CSS/JavaScript or other assets. The graphs are rendered as inline SVG. This is a pure HTML-only representation of the results for emailing or other easy analysis outside of the Phoronix Test Suite. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.
@@ -487,7 +490,7 @@ The following list is the modules included with the Phoronix Test Suite that are
--- ---
### Backup Creation + Restore ### Backup Creation + Restore
This is a module for creating backups of the Phoronix Test Suite / Phoromatic and allows for restoring of created backups. The backup will be in ZIP or TAR format. If only a path is specified, the file-name will be auto-generated with a current time-stamp. This is a module for creating backups of the Phoronix Test Suite / Phoromatic and allows for restoring of created backups. The backup will be in ZIP or TAR format. If only a path is specified, the filename will be auto-generated with a current timestamp.
**phoronix-test-suite backup.create** **phoronix-test-suite backup.create**
@@ -1827,6 +1830,12 @@ This is a collection of test profiles found within the specified OpenBenchmarkin
#### Smp Tests system/smp #### Smp Tests system/smp
This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing smp. This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing smp.
#### Openmp Tests system/openmp
This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing openmp.
#### Mpi Tests system/mpi
This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing mpi.
#### 64-bit Arm / AArch64 Tests In git git/aarch64 #### 64-bit Arm / AArch64 Tests In git git/aarch64
This is a collection of test profiles where there have been successful benchmark results submitted to OpenBenchmarking.org from 64-bit Arm / AArch64 CPU architecture hardware, i.e. these tests are proven to be 64-bit Arm / AArch64 compatible though not necessarily all compatible test profiles for the given architecture - just those with submitted public results previously on OpenBenchmarking.org. This is a collection of test profiles where there have been successful benchmark results submitted to OpenBenchmarking.org from 64-bit Arm / AArch64 CPU architecture hardware, i.e. these tests are proven to be 64-bit Arm / AArch64 compatible though not necessarily all compatible test profiles for the given architecture - just those with submitted public results previously on OpenBenchmarking.org.

1365
documentation/phoronix-test-suite.pdf
View File

File diff suppressed because it is too large Load Diff

21
documentation/stubs/00_user_options.html
View File

@@ -213,7 +213,7 @@
<p>This option is used if you wish to automatically attempt to sort the results by their result identifier string. Alternatively, if using the environment variable "SORT_BY" other sort modes can be used, such as SORT_BY=date / SORT_BY=date-desc for sorting by the test run-time/date.</p> <p>This option is used if you wish to automatically attempt to sort the results by their result identifier string. Alternatively, if using the environment variable "SORT_BY" other sort modes can be used, such as SORT_BY=date / SORT_BY=date-desc for sorting by the test run-time/date.</p>
<h3>compare-results-to-baseline<em> [Test Result] [Test Result]</em> <h3>compare-results-to-baseline<em> [Test Result] [Test Result]</em>
</h3> </h3>
<p>This option will allows you to specify a result as a baseline (first parameter) and a second result file (second parameter) that will offer some analysis for showing how the second result compares to the first in matching tests.</p> <p>This option allows you to specify a result as a baseline (first parameter) and a second result file (second parameter) that will offer some analysis for showing how the second result compares to the first in matching tests.</p>
<h3>compare-results-two-way<em> [Test Result]</em> <h3>compare-results-two-way<em> [Test Result]</em>
</h3> </h3>
<p>This option will allows you to specify a result file and from there to compare two individual runs within that result file for looking at wins/losses and other metrics in a head-to-head type comparison.</p> <p>This option will allows you to specify a result file and from there to compare two individual runs within that result file for looking at wins/losses and other metrics in a head-to-head type comparison.</p>
@@ -222,7 +222,7 @@
<p>This option is used if you wish to edit the title and description of an existing result file.</p> <p>This option is used if you wish to edit the title and description of an existing result file.</p>
<h3>extract-from-result-file<em> [Test Result]</em> <h3>extract-from-result-file<em> [Test Result]</em>
</h3> </h3>
<p>This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is the prompted to specify a new result file name and select which result identifier to extract.</p> <p>This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is then prompted to specify a new result file name and select which result identifier to extract.</p>
<h3>keep-results-in-result-file<em> [Test Result]</em> <h3>keep-results-in-result-file<em> [Test Result]</em>
</h3> </h3>
<p>This option is the inverse of the remove-results-from-result-file sub-command. If you wish to remove all results but those listed from a given result file, this option can be used. The user must specify a saved results file and then they will be prompted to provide a string to search for in keeping those results in that given result file but removing all other data.</p> <p>This option is the inverse of the remove-results-from-result-file sub-command. If you wish to remove all results but those listed from a given result file, this option can be used. The user must specify a saved results file and then they will be prompted to provide a string to search for in keeping those results in that given result file but removing all other data.</p>
@@ -232,6 +232,9 @@
<h3>prune-empty-results<em> [Test Result]</em> <h3>prune-empty-results<em> [Test Result]</em>
</h3> </h3>
<p>This option is used if there are test results (benchmarks) to be dropped from a given result file that had no successful runs. I.e. if any run attempt(s) only errored out without producing any result for any of the test run(s) saved in that file. The user must specify a saved results file.</p> <p>This option is used if there are test results (benchmarks) to be dropped from a given result file that had no successful runs. I.e. if any run attempt(s) only errored out without producing any result for any of the test run(s) saved in that file. The user must specify a saved results file.</p>
<h3>prune-zero-data<em> [Test Result]</em>
</h3>
<p>This option is used if there are test results (benchmarks) to be where there is line graph data that currently has zero values (e.g. inaccurate/invalid sensor readings) and you wish to just drop those zero reading values from the result file.</p>
<h3>remove-incomplete-results-from-result-file<em> [Test Result]</em> <h3>remove-incomplete-results-from-result-file<em> [Test Result]</em>
</h3> </h3>
<p>This option is used if there are test results (benchmarks) to be dropped from a given result file for having incomplete data, either a test run did not attempt to run that benchmark or failed to properly run. The user must specify a saved results file and the command will then attempt to find any results with incomplete/missing data and prompt the user with confirmation to remove them.</p> <p>This option is used if there are test results (benchmarks) to be dropped from a given result file for having incomplete data, either a test run did not attempt to run that benchmark or failed to properly run. The user must specify a saved results file and the command will then attempt to find any results with incomplete/missing data and prompt the user with confirmation to remove them.</p>
@@ -265,9 +268,9 @@
<h3>debug-dependency-handler</h3> <h3>debug-dependency-handler</h3>
<p>This option is used for testing the distribution-specific dependency handler for external dependencies.</p> <p>This option is used for testing the distribution-specific dependency handler for external dependencies.</p>
<h3>debug-render-test</h3> <h3>debug-render-test</h3>
<p>This option is used during the development of the Phoronix Test Suite software for testing of the result and graph rendering code-paths This option will download a large number of reference test results from LinuxBenchmarking.com.</p> <p>This option is used during the development of the Phoronix Test Suite software for testing of the result and graph rendering code paths. This option will download a large number of reference test results from LinuxBenchmarking.com.</p>
<h3>debug-self-test</h3> <h3>debug-self-test</h3>
<p>This option is used during the development of the Phoronix Test Suite software for testing of internal interfaces, commands, and other common code-paths. The produced numbers should only be comparable for the same version of the Phoronix Test Suite, on the same hardware/software system, conducted on the same day of testing. This isn't intended as any scientific benchmark but simply to stress common PHP code-paths and looking for hot areas to optimize, etc.</p> <p>This option is used during the development of the Phoronix Test Suite software for testing of internal interfaces, commands, and other common code paths. The produced numbers should only be comparable for the same version of the Phoronix Test Suite, on the same hardware/software system, conducted on the same day of testing. This isn't intended as any scientific benchmark but simply to stress common PHP code paths and looking for hot areas to optimize, etc.</p>
<h3>help</h3> <h3>help</h3>
<p>This option will display a list of available Phoronix Test Suite commands and possible parameter types.</p> <p>This option will display a list of available Phoronix Test Suite commands and possible parameter types.</p>
<h3>version</h3> <h3>version</h3>
@@ -290,7 +293,7 @@
<p>This option is used if you wish to analyze a result file to see which runs produced the most wins/losses of those result identifiers in the saved file.</p> <p>This option is used if you wish to analyze a result file to see which runs produced the most wins/losses of those result identifiers in the saved file.</p>
<h3>workload-topology<em> [Test Result]</em> <h3>workload-topology<em> [Test Result]</em>
</h3> </h3>
<p>This option will read a saved test results file and print the test profiles contained within and their arrangement within different test suites for getting an idea as to the workload topology/make-up / logical groupings of the benchmarks being run.</p> <p>This option will read a saved test results file and print the test profiles contained within and their arrangement within different test suites for getting an idea as to the workload topology / make-up / logical groupings of the benchmarks being run.</p>
<h1>Modules</h1> <h1>Modules</h1>
<h3>auto-load-module</h3> <h3>auto-load-module</h3>
<p>This option can be used for easily adding a module to the AutoLoadModules list in the Phoronix Test Suite user configuration file. That list controls what PTS modules are automatically loaded on start-up of the Phoronix Test Suite.</p> <p>This option can be used for easily adding a module to the AutoLoadModules list in the Phoronix Test Suite user configuration file. That list controls what PTS modules are automatically loaded on start-up of the Phoronix Test Suite.</p>
@@ -310,11 +313,11 @@
<h1>Debugging</h1> <h1>Debugging</h1>
<h3>check-tests<em> [Test]</em> <h3>check-tests<em> [Test]</em>
</h3> </h3>
<p>This option will perform a check on one or more test profiles to determine if there have been any vendor changes to the filename, filesize, url location, md5 and sha256 checksums.</p> <p>This option will perform a check on one or more test profiles to determine if there have been any vendor changes to the filename, filesize, URL location, MD5 and SHA256 checksums.</p>
<h3>diagnostics</h3> <h3>diagnostics</h3>
<p>This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites.</p> <p>This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites.</p>
<h3>dump-file-info</h3> <h3>dump-file-info</h3>
<p>This option will dump the MD5 / SHA256 hashes and file size for a given file.</p> <p>This option will dump the MD5 / SHA256 checksums and file size for a given file.</p>
<h3>dump-openbenchmarking-indexes</h3> <h3>dump-openbenchmarking-indexes</h3>
<p>This option is used for dumping the parsed output of OpenBenchmarking.org index files (metadata).</p> <p>This option is used for dumping the parsed output of OpenBenchmarking.org index files (metadata).</p>
<h3>dump-phodevi-smart-cache</h3> <h3>dump-phodevi-smart-cache</h3>
@@ -331,7 +334,7 @@
<p>This option will list all available test profiles that are available from the enabled OpenBenchmarking.org repositories but are NOT SUPPORTED on the given hardware/software platform. This is mainly a debugging option for those looking for test profiles to potentially port to new platforms, etc.</p> <p>This option will list all available test profiles that are available from the enabled OpenBenchmarking.org repositories but are NOT SUPPORTED on the given hardware/software platform. This is mainly a debugging option for those looking for test profiles to potentially port to new platforms, etc.</p>
<h1>User Configuration</h1> <h1>User Configuration</h1>
<h3>enterprise-setup</h3> <h3>enterprise-setup</h3>
<p>This option can be run by enterprise users immediately after package installation or as part of an in-house setup script. Running this command will ensure the phoronix-test-suite program is never interrupted on new runs to accept user agreement changes and defaults the anonymous usage reporting to being disabled and other conservative defaults.</p> <p>This option can be run by enterprise users immediately after package installation or as part of an in-house setup script. Running this command will ensure the phoronix-test-suite program is never interrupted on new runs to accept user agreement changes. It also defaults the anonymous usage reporting to being disabled, along with other conservative settings.</p>
<h3>network-info</h3> <h3>network-info</h3>
<p>This option will print information detected by the Phoronix Test Suite around the system's network configuration.</p> <p>This option will print information detected by the Phoronix Test Suite around the system's network configuration.</p>
<h3>network-setup</h3> <h3>network-setup</h3>
@@ -348,7 +351,7 @@
<p>This option will read a saved test results file and output the raw result file run data to a CSV file. This raw (individual) result file output is intended for data analytic purposes where the result-file-to-csv is more end-user-ready.</p> <p>This option will read a saved test results file and output the raw result file run data to a CSV file. This raw (individual) result file output is intended for data analytic purposes where the result-file-to-csv is more end-user-ready.</p>
<h3>result-file-to-csv<em> [Test Result]</em> <h3>result-file-to-csv<em> [Test Result]</em>
</h3> </h3>
<p>This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output. The CSV (Comma Separated Values) output can then be loaded into a spreadsheet for easy viewing. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.</p> <p>This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output (Comma Separated Values) file. This file can then be loaded into a spreadsheet for easy viewing. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.</p>
<h3>result-file-to-html<em> [Test Result]</em> <h3>result-file-to-html<em> [Test Result]</em>
</h3> </h3>
<p>This option will read a saved test results file and output the system hardware and software information along with the results to pure HTML file. No external files are required for CSS/JavaScript or other assets. The graphs are rendered as inline SVG. This is a pure HTML-only representation of the results for emailing or other easy analysis outside of the Phoronix Test Suite. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.</p> <p>This option will read a saved test results file and output the system hardware and software information along with the results to pure HTML file. No external files are required for CSS/JavaScript or other assets. The graphs are rendered as inline SVG. This is a pure HTML-only representation of the results for emailing or other easy analysis outside of the Phoronix Test Suite. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.</p>

2
documentation/stubs/00_zmodule_options.html
View File

@@ -6,7 +6,7 @@
<body> <body>
<p>The following list is the modules included with the Phoronix Test Suite that are intended to extend the functionality of pts-core. Some of these options have commands that can be run directly in a similar manner to the other Phoronix Test Suite user commands. Some modules are just meant to be loaded directly by adding the module name to the AutoLoadModules tag in ~/.phoronix-test-suite/user-config.xml or via the PTS_MODULES environment variable. A list of available modules is also available by running <em>phoronix-test-suite list-modules.</em><hr></p> <p>The following list is the modules included with the Phoronix Test Suite that are intended to extend the functionality of pts-core. Some of these options have commands that can be run directly in a similar manner to the other Phoronix Test Suite user commands. Some modules are just meant to be loaded directly by adding the module name to the AutoLoadModules tag in ~/.phoronix-test-suite/user-config.xml or via the PTS_MODULES environment variable. A list of available modules is also available by running <em>phoronix-test-suite list-modules.</em><hr></p>
<h2>Backup Creation + Restore</h2> <h2>Backup Creation + Restore</h2>
<p>This is a module for creating backups of the Phoronix Test Suite / Phoromatic and allows for restoring of created backups. The backup will be in ZIP or TAR format. If only a path is specified, the file-name will be auto-generated with a current time-stamp.</p> <p>This is a module for creating backups of the Phoronix Test Suite / Phoromatic and allows for restoring of created backups. The backup will be in ZIP or TAR format. If only a path is specified, the filename will be auto-generated with a current timestamp.</p>
<p><strong>phoronix-test-suite backup.create</strong></p> <p><strong>phoronix-test-suite backup.create</strong></p>
<p><strong>phoronix-test-suite backup.restore</strong></p> <p><strong>phoronix-test-suite backup.restore</strong></p>
<h2>System Maintenance / Cleanup</h2> <h2>System Maintenance / Cleanup</h2>

6
documentation/stubs/55_virtual_suites.html
View File

@@ -243,6 +243,12 @@
<h3>Smp Tests<em> system/smp</em> <h3>Smp Tests<em> system/smp</em>
</h3> </h3>
<p>This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing smp.</p> <p>This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing smp.</p>
<h3>Openmp Tests<em> system/openmp</em>
</h3>
<p>This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing openmp.</p>
<h3>Mpi Tests<em> system/mpi</em>
</h3>
<p>This is a collection of test profiles found within the specified OpenBenchmarking.org repository where the test profile is specified via an internal tag as testing mpi.</p>
<h3>64-bit Arm / AArch64 Tests In git<em> git/aarch64</em> <h3>64-bit Arm / AArch64 Tests In git<em> git/aarch64</em>
</h3> </h3>
<p>This is a collection of test profiles where there have been successful benchmark results submitted to OpenBenchmarking.org from 64-bit Arm / AArch64 CPU architecture hardware, i.e. these tests are proven to be 64-bit Arm / AArch64 compatible though not necessarily all compatible test profiles for the given architecture - just those with submitted public results previously on OpenBenchmarking.org.</p> <p>This is a collection of test profiles where there have been successful benchmark results submitted to OpenBenchmarking.org from 64-bit Arm / AArch64 CPU architecture hardware, i.e. these tests are proven to be 64-bit Arm / AArch64 compatible though not necessarily all compatible test profiles for the given architecture - just those with submitted public results previously on OpenBenchmarking.org.</p>

2
pts-core/commands/check_tests.php
View File

@@ -41,7 +41,7 @@
class check_tests implements pts_option_interface class check_tests implements pts_option_interface
{ {
const doc_section = 'Debugging'; const doc_section = 'Debugging';
const doc_description = 'This option will perform a check on one or more test profiles to determine if there have been any vendor changes to the filename, filesize, url location, md5 and sha256 checksums.'; const doc_description = 'This option will perform a check on one or more test profiles to determine if there have been any vendor changes to the filename, filesize, URL location, MD5 and SHA256 checksums.';
// Delimiter in the TESTED_FILES // Delimiter in the TESTED_FILES
const DELIMITER = ":::"; const DELIMITER = ":::";

2
pts-core/commands/compare_results_to_baseline.php
View File

@@ -23,7 +23,7 @@
class compare_results_to_baseline implements pts_option_interface class compare_results_to_baseline implements pts_option_interface
{ {
const doc_section = 'Result Management'; const doc_section = 'Result Management';
const doc_description = 'This option will allows you to specify a result as a baseline (first parameter) and a second result file (second parameter) that will offer some analysis for showing how the second result compares to the first in matching tests.'; const doc_description = 'This option allows you to specify a result as a baseline (first parameter) and a second result file (second parameter) that will offer some analysis for showing how the second result compares to the first in matching tests.';
public static function argument_checks() public static function argument_checks()
{ {

2
pts-core/commands/debug_render_test.php
View File

@@ -23,7 +23,7 @@
class debug_render_test implements pts_option_interface class debug_render_test implements pts_option_interface
{ {
const doc_section = 'Other'; const doc_section = 'Other';
const doc_description = 'This option is used during the development of the Phoronix Test Suite software for testing of the result and graph rendering code-paths This option will download a large number of reference test results from LinuxBenchmarking.com.'; const doc_description = 'This option is used during the development of the Phoronix Test Suite software for testing of the result and graph rendering code paths. This option will download a large number of reference test results from LinuxBenchmarking.com.';
public static function run($r) public static function run($r)
{ {

2
pts-core/commands/debug_self_test.php
View File

@@ -23,7 +23,7 @@
class debug_self_test implements pts_option_interface class debug_self_test implements pts_option_interface
{ {
const doc_section = 'Other'; const doc_section = 'Other';
const doc_description = 'This option is used during the development of the Phoronix Test Suite software for testing of internal interfaces, commands, and other common code-paths. The produced numbers should only be comparable for the same version of the Phoronix Test Suite, on the same hardware/software system, conducted on the same day of testing. This isn\'t intended as any scientific benchmark but simply to stress common PHP code-paths and looking for hot areas to optimize, etc.'; const doc_description = 'This option is used during the development of the Phoronix Test Suite software for testing of internal interfaces, commands, and other common code paths. The produced numbers should only be comparable for the same version of the Phoronix Test Suite, on the same hardware/software system, conducted on the same day of testing. This isn\'t intended as any scientific benchmark but simply to stress common PHP code paths and looking for hot areas to optimize, etc.';
public static function run($r) public static function run($r)
{ {

2
pts-core/commands/dump_file_info.php
View File

@@ -23,7 +23,7 @@
class dump_file_info implements pts_option_interface class dump_file_info implements pts_option_interface
{ {
const doc_section = 'Debugging'; const doc_section = 'Debugging';
const doc_description = 'This option will dump the MD5 / SHA256 hashes and file size for a given file.'; const doc_description = 'This option will dump the MD5 / SHA256 checksums and file size for a given file.';
public static function run($r) public static function run($r)
{ {
pts_client::$display->generic_heading('File Information'); pts_client::$display->generic_heading('File Information');

2
pts-core/commands/enterprise_setup.php
View File

@@ -23,7 +23,7 @@
class enterprise_setup implements pts_option_interface class enterprise_setup implements pts_option_interface
{ {
const doc_section = 'User Configuration'; const doc_section = 'User Configuration';
const doc_description = 'This option can be run by enterprise users immediately after package installation or as part of an in-house setup script. Running this command will ensure the phoronix-test-suite program is never interrupted on new runs to accept user agreement changes and defaults the anonymous usage reporting to being disabled and other conservative defaults.'; const doc_description = 'This option can be run by enterprise users immediately after package installation or as part of an in-house setup script. Running this command will ensure the phoronix-test-suite program is never interrupted on new runs to accept user agreement changes. It also defaults the anonymous usage reporting to being disabled, along with other conservative settings.';
public static function run($r) public static function run($r)
{ {

2
pts-core/commands/extract_from_result_file.php
View File

@@ -23,7 +23,7 @@
class extract_from_result_file implements pts_option_interface class extract_from_result_file implements pts_option_interface
{ {
const doc_section = 'Result Management'; const doc_section = 'Result Management';
const doc_description = 'This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is the prompted to specify a new result file name and select which result identifier to extract.'; const doc_description = 'This option will extract a single set of test results from a saved results file that contains multiple test results that have been merged. The user is then prompted to specify a new result file name and select which result identifier to extract.';
public static function argument_checks() public static function argument_checks()
{ {

2
pts-core/commands/result_file_to_csv.php
View File

@@ -23,7 +23,7 @@
class result_file_to_csv implements pts_option_interface class result_file_to_csv implements pts_option_interface
{ {
const doc_section = 'Result Export'; const doc_section = 'Result Export';
const doc_description = 'This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output. The CSV (Comma Separated Values) output can then be loaded into a spreadsheet for easy viewing. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.'; const doc_description = 'This option will read a saved test results file and output the system hardware and software information along with the results to a CSV output (Comma Separated Values) file. This file can then be loaded into a spreadsheet for easy viewing. The outputted file appears in the user home directory or can otherwise be controlled via the OUTPUT_DIR and OUTPUT_FILE environment variables.';
public static function argument_checks() public static function argument_checks()
{ {

2
pts-core/commands/workload_topology.php
View File

@@ -23,7 +23,7 @@
class workload_topology implements pts_option_interface class workload_topology implements pts_option_interface
{ {
const doc_section = 'Result Analysis'; const doc_section = 'Result Analysis';
const doc_description = 'This option will read a saved test results file and print the test profiles contained within and their arrangement within different test suites for getting an idea as to the workload topology/make-up / logical groupings of the benchmarks being run.'; const doc_description = 'This option will read a saved test results file and print the test profiles contained within and their arrangement within different test suites for getting an idea as to the workload topology / make-up / logical groupings of the benchmarks being run.';
public static function argument_checks() public static function argument_checks()
{ {

2
pts-core/modules/backup.php
View File

@@ -24,7 +24,7 @@ class backup extends pts_module_interface
{ {
const module_name = 'Backup Creation + Restore'; const module_name = 'Backup Creation + Restore';
const module_version = '1.0.0'; const module_version = '1.0.0';
const module_description = 'This is a module for creating backups of the Phoronix Test Suite / Phoromatic and allows for restoring of created backups. The backup will be in ZIP or TAR format. If only a path is specified, the file-name will be auto-generated with a current time-stamp.'; const module_description = 'This is a module for creating backups of the Phoronix Test Suite / Phoromatic and allows for restoring of created backups. The backup will be in ZIP or TAR format. If only a path is specified, the filename will be auto-generated with a current timestamp.';
const module_author = 'Phoronix Media'; const module_author = 'Phoronix Media';
public static function user_commands() public static function user_commands()