2017-12-26 10:55:49

by Mathieu Malaterre

[permalink] [raw]
Subject: [PATCH] MIPS: Use proper @return keyword

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 <[email protected]>
---
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..e0d3a432e1e3 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


2017-12-26 16:29:21

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] MIPS: Use proper @return keyword

On 12/26/2017 02:55 AM, Mathieu Malaterre wrote:
> 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 <[email protected]>
> ---
> 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..e0d3a432e1e3 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

No @, just
return: <text>

> * returns 0 or BRANCH_LIKELY_TAKEN as appropriate after
> * evaluating the branch.
> *
>


--
~Randy

2017-12-27 11:08:04

by Mathieu Malaterre

[permalink] [raw]
Subject: [PATCH v2] MIPS: Use proper Return keyword

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 <[email protected]>
---
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

2018-02-01 16:04:43

by James Hogan

[permalink] [raw]
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 <[email protected]>

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

Attachments:
(No filename) (1.16 kB)
 signature.asc (849.00 B)
Digital signature Download all attachments