linux-kernel - selftest/ftrace: Add test results to "-h" help text to ftracetest

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20210628095015.4b8b1cb9@oasis.local.home>
Date:   Mon, 28 Jun 2021 09:50:15 -0400
From:   Steven Rostedt <rostedt@...dmis.org>
To:     Masami Hiramatsu <mhiramat@...nel.org>
Cc:     LKML <linux-kernel@...r.kernel.org>, Shuah Khan <shuah@...nel.org>,
        Shuah Khan <skhan@...uxfoundation.org>,
        Peter Zijlstra <peterz@...radead.org>
Subject: selftest/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@...dmis.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
 }