Improve openbmctool_execute_command documentation
Change-Id: I56ed1897288bf549bd5b288b9a10b4b7d6d084a1
Signed-off-by: Michael Walsh <micwalsh@us.ibm.com>
diff --git a/lib/openbmctool_utils.py b/lib/openbmctool_utils.py
index a34436b..eb6aacd 100755
--- a/lib/openbmctool_utils.py
+++ b/lib/openbmctool_utils.py
@@ -44,8 +44,11 @@
Description of arguments:
command_string The command string to be passed to the
openbmctool.py program.
- args/kwargs These are passed directly to shell_cmd. See the shell_cmd
- prolog for details.
+ All remaining arguments are passed directly to shell_cmd. See the
+ shell_cmd prolog for details on allowable arguments. The caller may code
+ them directly as in this example:
+ openbmctool_execute_command("my command", quiet=1, max_attempts=2).
+ Python will do the work of putting these values into args/kwargs.
"""
if not gv.valid_value(command_string):