Skip to content

Commit

Permalink
Merge pull request #821 from ROCm/json-mem-module
Browse files Browse the repository at this point in the history
cleanup readme and other docs to remove reference to rvs.conf file
  • Loading branch information
manoj-freyr authored Oct 14, 2024
2 parents 3f084ef + 84e17bd commit a71e949
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 165 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,6 @@ SUSE :
Command examples
./rvs --help ; Lists all options to run RVS test suite
./rvs -g ; Lists supported GPUs available in the machine
./rvs -d 3 ; Run set of RVS default sanity tests (in rvs.conf) with verbose level 3
./rvs -c conf/gst_single.conf ; Run GST module default test configuration

### Run version pre-compiled and packaged with ROCm release
Expand All @@ -146,7 +145,6 @@ SUSE :
Command examples
./rvs --help ; Lists all options to run RVS test suite
./rvs -g ; Lists supported GPUs available in the machine
./rvs -d 3 ; Run set of RVS sanity tests (in rvs.conf) with verbose level 3
./rvs -c ../share/rocm-validation-suite/conf/gst_single.conf ; Run GST default test configuration

To run GPU specific test configuration, use configuration files from GPU folders in "/opt/rocm/share/rocm-validation-suite/conf"
Expand Down
8 changes: 2 additions & 6 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@
-a --appendLog When generating a debug logfile, do not overwrite the contents
of a current log. Used in conjuction with the -d and -l options
-c --config Specify the configuration file to be used.
The default is <install base>/conf/RVS.conf
--configless Run RVS in a configless mode. Executes a "long" test on all
supported GPUs.
This is Mandatory field.
-d --debugLevel Specify the debug level for the output log. The range is
0 to 5 with 5 being the most verbose.
Used in conjunction with the -l flag.
Expand Down Expand Up @@ -51,11 +49,9 @@ non-zero - otherwise

## Examples

<b>rvs</b>
Runs rvs with the default test configuration file <i>[install_base]/conf/rvs.conf</i>

<b>rvs -c conf/gpup1.conf -d 3 -j -l mylog.txt</b>
Runs rvs with configuration file <i>conf/gpup1.conf</i> and writes output into log file <i>mylog.txt</i> using logging level 3 (INFO) in JSON format
Runs rvs with configuration file <i>conf/gpup1.conf</i> and writes text output into log file <i>mylog.txt</i> using logging level 3 (INFO) and writes to a file in /var/tmp/ folder in JSON format.Name of json log file will be printed to stdout/text log file

For more details consult the User Guide located in:
<i>[install_base]/userguide/html/index.html</i>
6 changes: 1 addition & 5 deletions docs/ug1main.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ RVS package components are installed in `/opt/rocm`. Package contains:
Command examples
./rvs --help ; Lists all options to run RVS test suite
./rvs -g ; Lists supported GPUs available in the machine
./rvs -d 3 ; Run set of RVS default sanity tests (in rvs.conf) with verbose level 3
./rvs -c conf/gst_single.conf ; Run GST module default test configuration

### Run version pre-compiled and packaged with ROCm release
Expand All @@ -62,7 +61,6 @@ RVS package components are installed in `/opt/rocm`. Package contains:
Command examples
./rvs --help ; Lists all options to run RVS test suite
./rvs -g ; Lists supported GPUs available in the machine
./rvs -d 3 ; Run set of RVS sanity tests (in rvs.conf) with verbose level 3
./rvs -c ../share/rocm-validation-suite/conf/gst_single.conf ; Run GST default test configuration

To run GPU specific test configuration, use configuration files from GPU folders in "/opt/rocm/share/rocm-validation-suite/conf"
Expand Down Expand Up @@ -247,11 +245,9 @@ of a current log. Used in conjunction with the -d and -l options.
</td></tr>

<tr><td>-c</td><td>\-\-config</td><td>Specify the configuration file to be used.
The default is \<installbase\>/RVS/conf/RVS.conf
This is mandatory field.
</td></tr>

<tr><td></td><td>\-\-configless</td><td>Run RVS in a configless mode.
Executes a "long" test on all supported GPUs.</td></tr>

<tr><td>-d</td><td>\-\-debugLevel</td><td>Specify the debug level for the output
log. The range is 0 to 5 with 5 being the most verbose.
Expand Down
140 changes: 0 additions & 140 deletions rvs/conf/rvs.conf

This file was deleted.

18 changes: 6 additions & 12 deletions rvs/src/rvsexec.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,11 @@ int rvs::exec::run() {
if (rvs::options::has_option("-c", &val)) {
config_file = val;
} else {
config_file = "../share/rocm-validation-suite/conf/rvs.conf";
// Check if pConfig file exist if not use old path for backward compatibility
std::ifstream file(path + config_file);
if (!file.good()) {
config_file = "conf/rvs.conf";
}
file.close();
config_file = path + config_file;
char buff[1024];
snprintf(buff, sizeof(buff),
"No config file specified . Please use -c <conf file path>:");
rvs::logger::Err(buff, MODULE_NAME_CAPS);
return -1;
}

// Check if pConfig file exists
Expand Down Expand Up @@ -431,10 +428,7 @@ void rvs::exec::do_help() {
cout << " of the current log. Used in conjuction with "
"-d and -l options.\n";
cout << "-c --config Specify the configuration file to be used.\n";
cout << " The default is <install base>/conf/rvs.conf\n";
cout << " --configless Run RVS in a configless mode. Executes a "
"\"long\" test on all\n";
cout << " supported GPUs.\n";
cout << " supported GPUs.This is Mandatory field\n";
cout << "-d --debugLevel Specify the debug level for the output log. "
"The range is\n";
cout << " 0 to 5 with 5 being the highest verbose level.\n";
Expand Down

0 comments on commit a71e949

Please sign in to comment.