Fix documentatin for system command
Signed-off-by: Martin J. Bligh <mbligh@google.com>
git-svn-id: http://test.kernel.org/svn/autotest/trunk@4180 592f7852-d20e-0410-864c-8624ca9c26a4
diff --git a/client/common_lib/utils.py b/client/common_lib/utils.py
index bda72e2..12e66c6 100644
--- a/client/common_lib/utils.py
+++ b/client/common_lib/utils.py
@@ -613,7 +613,17 @@
def system(command, timeout=None, ignore_status=False):
- """This function returns the exit status of command."""
+ """
+ Run a command
+
+ @param timeout: timeout in seconds
+ @param ignore_status: if ignore_status=False, throw an exception if the
+ command's exit code is non-zero
+ if ignore_stauts=True, return the exit code.
+
+ @return exit status of command
+ (note, this will always be zero unless ignore_status=True)
+ """
return run(command, timeout=timeout, ignore_status=ignore_status,
stdout_tee=TEE_TO_LOGS, stderr_tee=TEE_TO_LOGS).exit_status