From: Steven Rostedt <rostedt@goodmis.org>
To: Masami Hiramatsu <mhiramat@kernel.org>
Cc: LKML <linux-kernel@vger.kernel.org>,
Shuah Khan <shuah@kernel.org>,
Shuah Khan <skhan@linuxfoundation.org>,
Peter Zijlstra <peterz@infradead.org>
Subject: selftest/ftrace: Add test results to "-h" help text to ftracetest
Date: Mon, 28 Jun 2021 09:50:15 -0400 [thread overview]
Message-ID: <20210628095015.4b8b1cb9@oasis.local.home> (raw)
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
}
next reply other threads:[~2021-06-28 13:50 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-28 13:50 Steven Rostedt [this message]
2021-06-28 14:51 ` selftest/ftrace: Add test results to "-h" help text to ftracetest Masami Hiramatsu
2021-06-28 15:08 ` Peter Zijlstra
2021-06-28 23:59 ` Masami Hiramatsu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210628095015.4b8b1cb9@oasis.local.home \
--to=rostedt@goodmis.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mhiramat@kernel.org \
--cc=peterz@infradead.org \
--cc=shuah@kernel.org \
--cc=skhan@linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.