diff --git a/docs/source/CLI.rst b/docs/source/CLI.rst index 1af82f0aba7e16d9c8295d9732cfb77efce0023e..6a11d76b0e7a5fd9dad6cc0250b6635c5673f83d 100644 --- a/docs/source/CLI.rst +++ b/docs/source/CLI.rst @@ -317,6 +317,26 @@ Delete --------- +Rename +------ + +``./spbench rename -h`` + +**Description:** + This command can be used to change the name of a given benchmark inside SPBench. + +**Required arguments:** + - ``-old-name `` + Insert the old and existent benchmark ID. + + - ``-new-name `` + Insert the new ID. + +**Usage example:** + - ``./spbench -old my_certainly_working_bench -new my_doubtfully_working_bench`` + +--------- + New-input --------- @@ -349,6 +369,23 @@ New-input **Usage example:** - ``./spbench new-input -id immensely_huge -app bzip2 -input "/home/me/awesome_songs/never_gonna_give_you_up-remix.mp3"`` +----------- + +List-inputs +----------- + +``./spbench list-inputs -h`` + +**Description:** + This command lists all application's inputs provided by SPBench, including users custom ones. + +**Optional arguments:** + - ``-app `` + Lists only inputs based on the given application. + +**Usage example:** + - ``./spbench list-inputs`` + --------- Delete-input @@ -372,66 +409,119 @@ Delete-input --------- -Rename ------- +Download-inputs +--------------- -``./spbench rename -h`` +``./spbench download-inputs -h`` **Description:** - This command can be used to change the name of a given benchmark inside SPBench. + Download the inputs for the SPBench benchmarks. + +**Optional arguments:** + - ``-app `` + Use this option for downloading inputs for a specific application. + + - ``-class `` (It applies only for Bzip2) + You can insert the class of workload you want to download (leave it empty to download all classes). + Possible options: all, test, small, medium, large, and huge. + + - ``-force`` + Use this option to delete any respective input file and download it again. + + +**Usage example:** + - ``./spbench download-inputs`` (recommended) + It will download everything. + + - ``./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 +------------- + +``./spbench edit-op -h`` + +**Description:** + Open an operator of a given benchmark to edit its source code. **Required arguments:** - - ``-old-name `` - Insert the old and existent benchmark ID. + - ``-benchmark `` + Enter the name of an application benchmark to edit (mandatory) - - ``-new-name `` - Insert the new ID. + - ``-operator `` + Enter the name of the benchmark's operator to edit (mandatory) + +**Optional arguments:** + - ``-editor `` + Enter the name of a text editor available in your machine, e.g. "vim", "nano", etc. (default: nano) **Usage example:** - - ``./spbench -old my_certainly_working_bench -new my_doubtfully_working_bench`` + - ``./spbench edit-op -bench ferret_sequential -op segmentation -editor vi`` --------- -List-inputs ------------ +List-operators +-------------- -``./spbench list-inputs -h`` +``./spbench edit-op -h`` **Description:** - This command lists all application's inputs provided by SPBench, including users custom ones. + List all available operators for a given benchmark. -**Optional arguments:** - - ``-app `` - Lists only inputs based on the given application. +**Required arguments:** + - ``-benchmark `` + You must give the name of the respective benchmark you want to see the operators list (mandatory). **Usage example:** - - ``./spbench list-inputs`` + - ``./spbench list-op -bench my_awesome_bench`` --------- -Download-inputs +Reset-operators --------------- -``./spbench download-inputs -h`` +``./spbench reset-op -h`` **Description:** - Download the inputs for the SPBench benchmarks. + Reset to default the source code of all operators for a given benchmark + (it still keeps the old operators as backup until this command is executed again). -**Optional arguments:** - - ``-app `` - Use this option for downloading inputs for a specific application. +**Required arguments (at least one of them must be used):** + - ``-benchmark `` + Insert the name of a benchmark to reset its operators. Caution: It will remove any current modifications on the operators. You can use [-bench all] to reset the operators for all benchmarks. - - ``-class `` (It applies only for Bzip2) - You can insert the class of workload you want to download (leave it empty to download all classes). - Possible options: all, test, small, medium, large, and huge. + - ``-app `` + Reset operators for all benchmarks based on a specific given application. - - ``-force`` - Use this option to delete any respective input file and download it again. + - ``-ppi `` + Reset operators for all benchmarks implemented using a specific given PPI. + +**Usage example:** + - ``./spbench reset-op -bench my_awesome_bench`` + +--------- + +Clean +----- + +``./spbench clean -h`` + +**Description:** + Clean a benchmark (similar to make clean). + It also removes old operators. + +**Required arguments (at least one of them must be used):** + - ``-benchmark `` + Insert the name of a benchmark to clean (make clean) (optional). You can use 'all' to clean all benchmarks. + + - ``-app `` + Clean all benchmarks based on a specific given application. + - ``-ppi `` + Clean all benchmarks implemented using a specific given PPI. **Usage example:** - - ``./spbench download-inputs`` (recommended) - It will download everything. - - - ``./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. + - ``./spbench clean -bench all`` + +---------