From: James Hogan <jhogan@kernel.org>
To: Mathieu Malaterre <malat@debian.org>
Cc: Randy Dunlap <rdunlap@infradead.org>,
Ralf Baechle <ralf@linux-mips.org>,
"Maciej W. Rozycki" <macro@mips.com>,
Ingo Molnar <mingo@kernel.org>,
Paul Burton <paul.burton@mips.com>,
linux-mips@linux-mips.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] MIPS: Use proper Return keyword
Date: Thu, 1 Feb 2018 16:03:47 +0000 [thread overview]
Message-ID: <20180201160346.GK7637@saruman> (raw)
In-Reply-To: <20171227110755.25788-1-malat@debian.org>
[-- Attachment #1: Type: text/plain, Size: 1192 bytes --]
On Wed, Dec 27, 2017 at 12:07:53PM +0100, Mathieu Malaterre wrote:
> For reference:
> * https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#function-documentation
>
> Fix non-fatal warning:
>
> arch/mips/kernel/branch.c:418: warning: Excess function parameter 'returns' description in '__compute_return_epc_for_insn'
>
> Signed-off-by: Mathieu Malaterre <malat@debian.org>
Applied to my 4.16 branch,
Thanks
James
> ---
> v2: Actually use the correct keyword
>
> arch/mips/kernel/branch.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/arch/mips/kernel/branch.c b/arch/mips/kernel/branch.c
> index b79ed9af9886..e48f6c0a9e4a 100644
> --- a/arch/mips/kernel/branch.c
> +++ b/arch/mips/kernel/branch.c
> @@ -399,7 +399,7 @@ int __MIPS16e_compute_return_epc(struct pt_regs *regs)
> *
> * @regs: Pointer to pt_regs
> * @insn: branch instruction to decode
> - * @returns: -EFAULT on error and forces SIGILL, and on success
> + * Return: -EFAULT on error and forces SIGILL, and on success
> * returns 0 or BRANCH_LIKELY_TAKEN as appropriate after
> * evaluating the branch.
> *
> --
> 2.11.0
>
>
[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
prev parent reply other threads:[~2018-02-01 16:04 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-26 10:55 [PATCH] MIPS: Use proper @return keyword Mathieu Malaterre
2017-12-26 10:55 ` Mathieu Malaterre
2017-12-26 16:29 ` Randy Dunlap
2017-12-27 11:07 ` [PATCH v2] MIPS: Use proper Return keyword Mathieu Malaterre
2018-02-01 16:03 ` James Hogan [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=20180201160346.GK7637@saruman \
--to=jhogan@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mips@linux-mips.org \
--cc=macro@mips.com \
--cc=malat@debian.org \
--cc=mingo@kernel.org \
--cc=paul.burton@mips.com \
--cc=ralf@linux-mips.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 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.