framework: document return value of ExecTest::run()

1 files changed, 9 insertions, 0 deletions

diff --git a/framework/exectest.py b/framework/exectest.py
index e96b5baa..b8d97b83 100644
--- a/framework/exectest.py
+++ b/framework/exectest.py
@@ -56,6 +56,15 @@ class ExecTest(Test):
 		return out
 
 	def run(self, valgrind):
+		"""
+		Run a test.  The return value will be a dictionary with keys
+		including 'result', 'info', 'returncode' and 'command'.
+		* For 'result', the value may be one of 'pass', 'fail', 'skip',
+		  'crash', or 'warn'.
+		* For 'info', the value will include stderr/out text.
+		* For 'returncode', the value will be the numeric exit code/value.
+		* For 'command', the value will be command line program and arguments.
+		"""
 		fullenv = os.environ.copy()
 		for e in self.env:
 			fullenv[e] = str(self.env[e])