linux-kernel - Re: [PATCH] Documentation/rtla: Describe exit status

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-prev] [day] [month] [year] [list]

Message-ID: <87bjpia7ic.fsf@trenco.lwn.net>
Date: Thu, 17 Jul 2025 14:26:35 -0600
From: Jonathan Corbet <corbet@....net>
To: Costa Shulyupin <costa.shul@...hat.com>, Steven Rostedt
 <rostedt@...dmis.org>, linux-trace-kernel@...r.kernel.org,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Cc: Tomas Glozar <tglozar@...hat.com>, Costa Shulyupin <costa.shul@...hat.com>
Subject: Re: [PATCH] Documentation/rtla: Describe exit status

Costa Shulyupin <costa.shul@...hat.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@...hat.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