[PATCH] Documentation/rtla: Describe exit status

[PATCH] Documentation/rtla: Describe exit status

[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.

Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
---
 Documentation/tools/rtla/common_appendix.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/tools/rtla/common_appendix.rst b/Documentation/tools/rtla/common_appendix.rst
index b5cf2dc223df..a6233ca8e6d6 100644
--- a/Documentation/tools/rtla/common_appendix.rst
+++ b/Documentation/tools/rtla/common_appendix.rst
@@ -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 <linux-kernel@vger.kernel.org>
-- 
2.48.1

Re: [PATCH] Documentation/rtla: Describe exit status

[Steven Rostedt]

On Sun,  8 Jun 2025 13:55:30 +0300
Costa Shulyupin <costa.shul@redhat.com> wrote:

> 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>

-- Steve

> ---
>  Documentation/tools/rtla/common_appendix.rst | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/Documentation/tools/rtla/common_appendix.rst b/Documentation/tools/rtla/common_appendix.rst
> index b5cf2dc223df..a6233ca8e6d6 100644
> --- a/Documentation/tools/rtla/common_appendix.rst
> +++ b/Documentation/tools/rtla/common_appendix.rst
> @@ -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 <linux-kernel@vger.kernel.org>

Re: [PATCH] Documentation/rtla: Describe exit status

[Jonathan Corbet]

Costa Shulyupin <costa.shul@redhat.com> writes:

> 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>
> ---
>  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...

> diff --git a/Documentation/tools/rtla/common_appendix.rst b/Documentation/tools/rtla/common_appendix.rst
> index b5cf2dc223df..a6233ca8e6d6 100644
> --- a/Documentation/tools/rtla/common_appendix.rst
> +++ b/Documentation/tools/rtla/common_appendix.rst
> @@ -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:

> 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