diff --git a/docs/source/CLI.rst b/docs/source/CLI.rst index 8d19fd21df852465bba06e7b4cd112653468df36..ee41541e1a445669a563e61d7ee6087b3a2aacd0 100644 --- a/docs/source/CLI.rst +++ b/docs/source/CLI.rst @@ -27,7 +27,7 @@ Install **Description:** It install the dependencies for the SPBench benchmarks. - See :doc:`installation` for more information. + See :doc:`docs/source/installation` for more information. **Optional arguments:** - ``-app `` @@ -209,11 +209,11 @@ Exec .. warning:: - - ``-debug`` + - ``-debug`` By default, SPBench captures the benchmark output while it is running and prints all the output at once at the end of the execution. SPBench does this so that it can compute some additional metrics based on the output of the benchmarks. If you want it to print the output on-the-fly (e.g. to print debug info added by you, or any print message), you must use the -debug argument in the execution command. Notice that, if this option is enabled, some advanced SPBench features may not work properly. It will not show the standard deviation of the metrics or store the result in the general log file, for instance. -- ``-nthreads `` + - ``-nthreads `` Number of threads. It can be used inside the benchmarks as a global variable. You can insert a single number or a range using the ':' character (e.g. ``-nthreads 1:10``). You can also define iteration step of the range (e.g. ``-nthreads 4:4:16`` would run the benchmarks with 4, 8, 12, and 16 threads). Default value: 1. - ``-batch `` @@ -320,7 +320,7 @@ Exec **Usage example:** - ``./spbench exec -bench ferret_ff_farm -input test -latency -throughput -nthreads 1:2:10 -repeat 3`` - You can find the resulting log file for this usage case in the ``log/ferret_ff_farm_1-2-10.dat`` file. + You can find the resulting log file for this usage case in the ``log/ferret_ff_farm_1-2-10.dat`` file. --------- @@ -475,6 +475,7 @@ Download-inputs - ``./spbench download-inputs -app bzip2 -class small -force`` Bzip2 has some large files to download, so users can use this option to avoid downloading everything. + --------- Edit-operator @@ -580,4 +581,3 @@ Clean - ``./spbench clean -logs -outputs`` Delete all SPBench logs and the outputs from all benchmarks. ----------