All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Costa Shulyupin <costa.shul@redhat.com>,
	Steven Rostedt <rostedt@goodmis.org>,
	linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Cc: Tomas Glozar <tglozar@redhat.com>,
	Costa Shulyupin <costa.shul@redhat.com>
Subject: Re: [PATCH] Documentation/rtla: Describe exit status
Date: Thu, 17 Jul 2025 14:26:35 -0600	[thread overview]
Message-ID: <87bjpia7ic.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20250608105531.758809-2-costa.shul@redhat.com>

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

      parent reply	other threads:[~2025-07-17 20:26 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-08 10:55 [PATCH] Documentation/rtla: Describe exit status Costa Shulyupin
2025-07-01 21:44 ` Steven Rostedt
2025-07-17 20:26 ` Jonathan Corbet [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87bjpia7ic.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=costa.shul@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-trace-kernel@vger.kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=tglozar@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.