From: Matthew Wilcox <willy@infradead.org>
To: Kees Cook <keescook@chromium.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Akira Yokosawa <akiyks@gmail.com>,
linux-doc@vger.kernel.org, linux-hardening@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] overflow: Fix kern-doc markup for functions
Date: Mon, 26 Sep 2022 22:06:19 +0100 [thread overview]
Message-ID: <YzIUS/+H2YA7RBvA@casper.infradead.org> (raw)
In-Reply-To: <20220926194713.1806917-1-keescook@chromium.org>
On Mon, Sep 26, 2022 at 12:47:13PM -0700, Kees Cook wrote:
> -/** check_add_overflow() - Calculate addition with overflow checking
> +/**
> + * check_add_overflow - Calculate addition with overflow checking
> *
> * @a: first addend
> * @b: second addend
Why did you remove the ()? And why didn't you delete the blank line?
According to our documentation, the canonical form is:
/**
* function_name() - Brief description of function.
* @arg1: Describe the first argument.
* @arg2: Describe the second argument.
* One can provide multiple line descriptions
* for arguments.
I don't usually complain about people getting that wrong, but when
people correct it to be wrong ...
next prev parent reply other threads:[~2022-09-26 21:06 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-26 19:47 Kees Cook
2022-09-26 21:06 ` Matthew Wilcox [this message]
2022-09-26 21:09 ` Kees Cook
2022-09-27 2:53 ` Akira Yokosawa
2022-09-27 3:02 ` Kees Cook
2022-09-27 10:35 ` Akira Yokosawa
2022-09-27 8:32 ` Bagas Sanjaya
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=YzIUS/+H2YA7RBvA@casper.infradead.org \
--to=willy@infradead.org \
--cc=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=keescook@chromium.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hardening@vger.kernel.org \
--cc=linux-kernel@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
all inboxes | Powered by JetHome®