linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Randy Dunlap <rdunlap@infradead.org>, linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Dmitry Baryshkov <dmitry.baryshkov@linaro.org>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH] doc-guide: kernel-doc: document Returns: spelling
Date: Thu, 30 May 2024 13:35:42 -0600	[thread overview]
Message-ID: <87ed9jcctt.fsf@meer.lwn.net> (raw)
In-Reply-To: <20240522224726.10498-1-rdunlap@infradead.org>

Randy Dunlap <rdunlap@infradead.org> writes:

> scripts/kernel-doc accepts "Return:" or "Returns:" for describing the
> return value of a function or function-like macro, so document this
> alternative spelling and use it in an example.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Suggested-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> ---
>  Documentation/doc-guide/kernel-doc.rst |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Applied, thanks.

jon

      parent reply	other threads:[~2024-05-30 19:35 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-22 22:47 [PATCH] doc-guide: kernel-doc: document Returns: spelling Randy Dunlap
2024-05-23  7:40 ` Jani Nikula
2024-05-30 19:35 ` 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=87ed9jcctt.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=dmitry.baryshkov@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).