linux-kernel - Re: [PATCH v2] MIPS: Use proper Return keyword

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20180201160346.GK7637@saruman>
Date:   Thu, 1 Feb 2018 16:03:47 +0000
From:   James Hogan <jhogan@...nel.org>
To:     Mathieu Malaterre <malat@...ian.org>
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Ralf Baechle <ralf@...ux-mips.org>,
        "Maciej W. Rozycki" <macro@...s.com>,
        Ingo Molnar <mingo@...nel.org>,
        Paul Burton <paul.burton@...s.com>, linux-mips@...ux-mips.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] MIPS: Use proper Return keyword

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@...ian.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
> 
> 

Download attachment "signature.asc" of type "application/pgp-signature" (834 bytes)