From: Matthew Wilcox <willy@infradead.org>
To: Joe Perches <joe@perches.com>
Cc: linux-doc@vger.kernel.org
Subject: Return: vs Returns:
Date: Thu, 7 Feb 2019 05:59:24 -0800 [thread overview]
Message-ID: <20190207135924.GV21860@bombadil.infradead.org> (raw)
This seems to be an extremely common mistake to make (indeed, almost
3000 occurrences of 'Returns:' vs 5300 occurrences of 'Return:'). Could
we have a checkpatch warning for it?
----- Forwarded message from Matthew Wilcox <willy@infradead.org> -----
On Wed, Jan 16, 2019 at 04:59:27PM +0000, Christophe Leroy wrote:
> v3: Moved 'Returns:" comment after description.
> Explained in the commit log why the function is defined static inline
>
> v2: Added "Returns:" comment and removed probe_user_address()
The correct spelling is 'Return:', not 'Returns:':
Return values
~~~~~~~~~~~~
The return value, if any, should be described in a dedicated section
named ``Return``.
----- End forwarded message -----
next reply other threads:[~2019-02-07 13:59 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-07 13:59 Matthew Wilcox [this message]
2019-02-07 15:30 ` Return: vs Returns: Mike Rapoport
2019-02-07 15:58 ` Markus Heiser
2019-02-07 16:18 ` Mike Rapoport
2019-02-07 17:31 ` Joe Perches
2019-02-07 17:34 ` Matthew Wilcox
2019-02-07 17:50 ` Joe Perches
2019-02-07 17:58 ` Markus Heiser
2019-02-07 18:03 ` Joe Perches
2019-02-08 7:31 ` Jani Nikula
2019-02-07 18:03 ` Markus Heiser
2019-02-07 17:33 ` Markus Heiser
2019-02-08 10:55 ` Mike Rapoport
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=20190207135924.GV21860@bombadil.infradead.org \
--to=willy@infradead.org \
--cc=joe@perches.com \
--cc=linux-doc@vger.kernel.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).