]> www.infradead.org Git - users/willy/linux.git/commitdiff
Documentation/rtla: Describe exit status
authorCosta Shulyupin <costa.shul@redhat.com>
Sun, 8 Jun 2025 10:55:30 +0000 (13:55 +0300)
committerJonathan Corbet <corbet@lwn.net>
Thu, 17 Jul 2025 21:29:53 +0000 (15:29 -0600)
Commit 18682166f61494072d58 ("rtla: Set distinctive exit value for failed
tests") expands exit status making it useful.

Add section 'EXIT STATUS' and required SPDX-License-Identifier
to the documentation.

Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>
[jc: fixed sphinx error caused by missing blank line]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250608105531.758809-2-costa.shul@redhat.com
Documentation/tools/rtla/common_appendix.rst

index b5cf2dc223df4240d5ec7e986596d4c7304e8d7f..53cae753753771191d6d31d37aa6cf1439960a66 100644 (file)
@@ -1,3 +1,14 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+EXIT STATUS
+===========
+
+::
+
+ 0  Passed: the test did not hit the stop tracing condition
+ 1  Error: invalid argument
+ 2  Failed: the test hit the stop tracing condition
+
 REPORTING BUGS
 ==============
 Report bugs to <linux-kernel@vger.kernel.org>