lkml.org 
[lkml]   [2021]   [Jun]   [28]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
Subjectselftest/ftrace: Add test results to "-h" help text to ftracetest
Peter Zijlstra recently had to debug jump labels that were failing in
the ftracetest script. He became frustrated as there was no easily
available documentation on what the meanings of UNSUPPORTED and
UNRESOLVED were. The only place they are documented is in the code.

At the very least, add the results to the help text, as I find that I
also sometimes need to figure out what those terms mean.

Now "./ftracetest -h" produces:

Usage: ftracetest [options] [testcase(s)] [testcase-directory(s)]
Options:
-h|--help Show help message
-k|--keep Keep passed test logs
-v|--verbose Increase verbosity of test messages
-vv Alias of -v -v (Show all results in stdout)
-vvv Alias of -v -v -v (Show all commands immediately)
--fail-unsupported Treat UNSUPPORTED as a failure
--fail-unresolved Treat UNRESOLVED as a failure
-d|--debug Debug mode (trace all shell commands)
-l|--logdir <dir> Save logs on the <dir>
If <dir> is -, all logs output in console only

Test results:
PASS The test succeeded
FAIL The test failed, but was expected to succeed.
UNRESOLVED The test produced indeterminate results. (e.g. interrupted)
UNTESTED The test was not run, currently just a placeholder.
UNSUPPORTED The test failed because of lack of feature.
XFAIL The test failed, and was expected to fail.

Link: https://lore.kernel.org/lkml/YNmflj%2FWpFG5Ivmb@hirez.programming.kicks-ass.net/

Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
---
diff --git a/tools/testing/selftests/ftrace/ftracetest b/tools/testing/selftests/ftrace/ftracetest
index 8ec1922e974e..f34580c70650 100755
--- a/tools/testing/selftests/ftrace/ftracetest
+++ b/tools/testing/selftests/ftrace/ftracetest
@@ -21,6 +21,14 @@ echo " --fail-unresolved Treat UNRESOLVED as a failure"
echo " -d|--debug Debug mode (trace all shell commands)"
echo " -l|--logdir <dir> Save logs on the <dir>"
echo " If <dir> is -, all logs output in console only"
+echo ""
+echo " Test results:"
+echo " PASS The test succeeded"
+echo " FAIL The test failed, but was expected to succeed."
+echo " UNRESOLVED The test produced indeterminate results. (e.g. interrupted)"
+echo " UNTESTED The test was not run, currently just a placeholder."
+echo " UNSUPPORTED The test failed because of lack of feature."
+echo " XFAIL The test failed, and was expected to fail."
exit $1
}

\
 
 \ /
  Last update: 2021-06-28 15:51    [W:0.087 / U:0.004 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site