diff --git a/docs/source/CLI.rst b/docs/source/CLI.rst index 14cdbbe7e4b48a7e5c0264c5801e5a0bc8128aa9..3524caf7955cd32eef6018776a51d38b57bf43da 100644 --- a/docs/source/CLI.rst +++ b/docs/source/CLI.rst @@ -19,19 +19,11 @@ For each command there is also a "help" guide. You can access it using: ./spbench [command] -h -Basic concepts --------------- - -- Benchmark: In this context, it means any application version registered in SPBench. Benchmarks can be the sequential applications, the parallel versions pre-available within SPBench, or any new custom implementations registered latter by users. - -- PPI: It stands for Parallel Programming Interface, which means any library, framework, language, etc. that leverages parallelism. - - -SPBench CLI commands --------------------- Install -~~~~~~~ +------- + +``./spbench install -h`` **Description:** It install the dependencies for the SPBench benchmarks. @@ -44,7 +36,7 @@ Install --------- Register -~~~~~~~~ +-------- **Description:** It automatically sets the paths and generates new makefiles for all benchmarks. @@ -55,7 +47,9 @@ Register --------- New -~~~ +--- + +``./spbench new -h`` **Description:** It allows for creating a new benchmark based on a SPBench application. @@ -84,8 +78,10 @@ New --------- -``./spbench edit`` -~~~~~~~~~~~~~~ +Edit +---- + +``./spbench edit -h`` **Description:** It opens a choosen benchmark for editing the source code. @@ -103,7 +99,9 @@ New --------- Configure -~~~~~~~~~ +--------- + +``./spbench configure -h`` **Description:** It allows users to add compiling dependencies for a benchmark. @@ -122,7 +120,9 @@ Configure --------- Exec -~~~~ +---- + +``./spbench exec -h`` **Description:** This command runs a given benchmark. @@ -200,7 +200,9 @@ Exec --------- List -~~~~ +---- + +``./spbench list -h`` **Description:** This command lists all SPBench benchmarks, including user's custom benchmarks. @@ -215,7 +217,9 @@ List --------- Delete -~~~~~~ +------ + +``./spbench delete -h`` **Description:** It completely deletes a given benchmark. @@ -230,7 +234,9 @@ Delete --------- New-input -~~~~~~~~~ +--------- + +``./spbench new-input -h`` **Description:** It allows for adding an alias for a custom input. @@ -260,7 +266,9 @@ New-input --------- Delete-input -~~~~~~~~~~~~ +------------ + +``./spbench delete-input -h`` **Description:** Delete a given input ID from the SPBench inputs registry. @@ -279,7 +287,9 @@ Delete-input --------- Rename -~~~~~~ +------ + +``./spbench rename -h`` **Description:** This command can be used to change the name of a given benchmark inside SPBench. @@ -297,7 +307,9 @@ Rename --------- List-inputs -~~~~~~~~~~~ +----------- + +``./spbench list-inputs -h`` **Description:** This command lists all application's inputs provided by SPBench, including users custom ones. @@ -312,7 +324,9 @@ List-inputs --------- Download-inputs -~~~~~~~~~~~~~~~ +--------------- + +``./spbench download-inputs -h`` **Description:** Download the inputs for the SPBench benchmarks.