Skip to contentSkip to conversation

Documentation/rtla: Describe exit status

PATCH In review Costa Shulyupin 3 participants 3 messages Jun 8, 2025 – Jul 17, 2025

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation/rtla: Describe exit status

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.

---
 Documentation/tools/rtla/common_appendix.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)
Documentation/tools/rtla/common_appendix.rst +10 -0
index b5cf2dc223df..a6233ca8e6d6 100644
@@ -1,3 +1,13 @@
+.. 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 <[email protected]>
Signature · 1 line
2.48.1
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 7 lines · On Sun, 8 Jun 2025 13:55:30 +0300 Costa Shulyupin <[email protected]>…

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.

-- Steve

Quoted 22 lines
---
 Documentation/tools/rtla/common_appendix.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)
Documentation/tools/rtla/common_appendix.rst +10 -0
index b5cf2dc223df..a6233ca8e6d6 100644
@@ -1,3 +1,13 @@
+.. 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 <[email protected]>
maintainer
#2 lore raw
In reply to Costa Shulyupin
Quoted 10 lines · Costa Shulyupin

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.

---
 Documentation/tools/rtla/common_appendix.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

So I have to apologize ... I just stumbled across your two docs patches deep in an email folder; I had clearly let them fall through the cracks. That said...

Documentation/tools/rtla/common_appendix.rst line 3

Quoted 8 lines
Documentation/tools/rtla/common_appendix.rst +3 -0
index b5cf2dc223df..a6233ca8e6d6 100644
@@ -1,3 +1,13 @@
+.. SPDX-License-Identifier: GPL-2.0
+EXIT STATUS
+===========

There has to be a blank line after the SPDX line, or you get warnings like this:

Quoted 1 line

Documentation/tools/rtla/common_appendix.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils]

To atone for my dropping this, I went in and amended the patch with the obvious - no need to resend. In the future, though, please always build the docs after making changes to be sure that all is well.

Thanks,

jon