Re: [PATCH v2] MIPS: Use proper Return keyword

[James Hogan]

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@xxxxxxxxxx>

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: signature.asc
Description: Digital signature