[SWDEV-514182] Update amd-smi help with sudo requirement (#142)

To execute set and reset commands, amd-smi needs sudo
privileges. Updated the subcommand help text to show
'sudo' requirement for these commands.

Signed-off-by: Bindhiya Kanangot Balakrishnan <Bindhiya.KanangotBalakrishnan@amd.com>
Co-authored-by: Arif, Maisam <Maisam.Arif@amd.com>

[ROCm/amdsmi commit: 2141e0336c]
This commit is contained in:
Kanangot Balakrishnan, Bindhiya
2025-03-03 14:53:30 -06:00
committed by GitHub
parent 69e01afd2d
commit 31cb0526cf
2 changed files with 8 additions and 4 deletions
+4 -2
View File
@@ -1082,7 +1082,8 @@ class AMDSMIParser(argparse.ArgumentParser):
# Subparser help text
set_value_help = "Set options for devices"
set_value_subcommand_help = "If no GPU is specified, will select all GPUs on the system.\
\nA set argument must be provided; Multiple set arguments are accepted"
\nA set argument must be provided; Multiple set arguments are accepted.\
\nRequires 'sudo' privileges."
set_value_optionals_title = "Set Arguments"
# Help text for Arguments only on BM platforms
@@ -1190,7 +1191,8 @@ class AMDSMIParser(argparse.ArgumentParser):
# Subparser help text
reset_help = "Reset options for devices"
reset_subcommand_help = "If no GPU is specified, will select all GPUs on the system.\
\nA reset argument must be provided; Multiple reset arguments are accepted"
\nA reset argument must be provided; Multiple reset arguments are accepted.\
\nRequires 'sudo' privileges."
reset_optionals_title = "Reset Arguments"
# Help text for Arguments only on Guest and BM platforms
@@ -510,7 +510,8 @@ usage: amd-smi set [-h] (-g GPU [GPU ...] | -U CPU [CPU ...] | -O CORE [CORE ...
[--loglevel LEVEL]
If no GPU is specified, will select all GPUs on the system.
A set argument must be provided; Multiple set arguments are accepted
A set argument must be provided; Multiple set arguments are accepted.
Requires 'sudo' privileges.
Set Arguments:
-h, --help show this help message and exit
@@ -589,7 +590,8 @@ usage: amd-smi reset [-h] [--json | --csv] [--file FILE] [--loglevel LEVEL]
[-f] [-p] [-x] [-d] [-C] [-M] [-o] [-l]
If no GPU is specified, will select all GPUs on the system.
A reset argument must be provided; Multiple reset arguments are accepted
A reset argument must be provided; Multiple reset arguments are accepted.
Requires 'sudo' privileges.
Reset Arguments:
-h, --help show this help message and exit