Update CLI.rst

docs/source/CLI.rst

@@ -42,7 +42,11 @@ Update
 
    It updates the Makefiles with new compiling configurations or create a new Makefile if there is no one.
 
-   You should run it every time you change the SPBench path or SPBench version, after a SPBench update, or after running the ``configure`` command.
+   You should run it every time you change the SPBench path or SPBench version, after a SPBench update, or after running the ``configure`` command or any similar case. If in doubt, run it!
+
+.. Note::
+
+   Do not forget to recompile the benchmarks for the command ``update`` to take effect.
 
 **Usage examples:**
    
@@ -226,7 +230,7 @@ Exec
     Usage example: ``-freq-pattern wave,10,5,80``
 
    - ``-nthreads <number_of_threads>``
-      A global variable that can be used to change the number of threads for the parallel benchmarks.
+      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.
 
    - ``-in-memory``
       It runs the application in in-memory mode. 
@@ -268,9 +272,12 @@ Exec
       When this parameter is added, the exec command will only print on the screen the execution command it would use to run the benchmark. 
       You may use it to manually change some specific aspect of the execution that is not supported by SPBench.
 
+   - ``-quiet``
+      Run it in quiet mode. If any metrics are selected, it shows the results in a short format.
+
    - ``executor <executor_name_and_parameters>``
       You can use this argument to change the way the benchmarks are executed. 
-      Usage example: [./spbench exec -executor "-my_executor my_executor_parameters" -bench ...]
+      Usage example: ``./spbench exec -executor "-my_executor my_executor_parameters" -bench ...``
 
    - ``-d`` (Bzip2 only)
       Enables decompress mode for Bzip2 benchmarks.
@@ -283,6 +290,9 @@ Exec
    - ``./spbench exec -bench lane_sequential -input medium -latency -throughput -resource-usage -test-result -repeat 5``
       Running with basic metrics, result testing, and repeating the execution 5 times.
 
+   - ``./spbench exec -bench ferret_grppi_farm -input test -latency -throughput -nthreads 8:2:16 -user-arg omp``
+      Running a Ferret GrPPI benchmark with 8, 10, 12, 14, and 16 threads, and selecting the OpenMP backend through a custom user argument.
+
    - ``./spbench exec -bench ferret_sequential -input test -executor "gdb"``
       Running a benchmark with GDB debugger as executor.
 
@@ -297,6 +307,12 @@ Exec
 
    - ``./spbench exec -bench my_custom_bench -input huge -batch-time 1.2 -freq-patt binary,7,10.5,70.8``
       Running a custom benchmark with the workload class huge, batch time interval = 1.2 sec., and a binary frequency pattern that oscilates the frequency between 10.5 and 70.8 every 7 seconds.
+
+.. Tip::
+
+   - ``./spbench exec -bench lane_sequential -input medium -latency -throughput -resource-usage -test-result -repeat 5``
+   If you use repetitions (``-repeat <n>``) and ``-nthreads <start:step:end>`` in range mode together in the exec command, a specific resulting log will be automatically generated inside the log folder. This log file will store average latency, throughput, and exec. time, with their respective std. deviation side by side.
+   It may be handy for running experiments and saving time gathering resulting data. The resulting log file is ready for users to draw charts over the results.
    
 ---------