* [PATCH] MIPS: Use proper @return keyword
@ 2017-12-26 10:55 Mathieu Malaterre
2017-12-26 10:55 ` Mathieu Malaterre
` (2 more replies)
0 siblings, 3 replies; 5+ messages in thread
From: Mathieu Malaterre @ 2017-12-26 10:55 UTC (permalink / raw)
Cc: Mathieu Malaterre, Ralf Baechle, Maciej W. Rozycki, Paul Burton,
Ingo Molnar, linux-mips, linux-kernel
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>
---
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
^ permalink raw reply related [flat|nested] 5+ messages in thread* [PATCH] MIPS: Use proper @return keyword
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
2 siblings, 0 replies; 5+ messages in thread
From: Mathieu Malaterre @ 2017-12-26 10:55 UTC (permalink / raw)
Cc: Mathieu Malaterre, Ralf Baechle, Maciej W. Rozycki, Paul Burton,
Ingo Molnar, linux-mips, linux-kernel
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>
---
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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] MIPS: Use proper @return keyword
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
2 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2017-12-26 16:29 UTC (permalink / raw)
To: Mathieu Malaterre
Cc: Ralf Baechle, Maciej W. Rozycki, Paul Burton, Ingo Molnar,
linux-mips, linux-kernel
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 <malat@debian.org>
> ---
> 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
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH v2] MIPS: Use proper Return keyword
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 ` Mathieu Malaterre
2018-02-01 16:03 ` James Hogan
2 siblings, 1 reply; 5+ messages in thread
From: Mathieu Malaterre @ 2017-12-27 11:07 UTC (permalink / raw)
To: Randy Dunlap
Cc: Mathieu Malaterre, Ralf Baechle, Maciej W. Rozycki, Ingo Molnar,
Paul Burton, linux-mips, linux-kernel
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>
---
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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH v2] MIPS: Use proper Return keyword
2017-12-27 11:07 ` [PATCH v2] MIPS: Use proper Return keyword Mathieu Malaterre
@ 2018-02-01 16:03 ` James Hogan
0 siblings, 0 replies; 5+ messages in thread
From: James Hogan @ 2018-02-01 16:03 UTC (permalink / raw)
To: Mathieu Malaterre
Cc: Randy Dunlap, Ralf Baechle, Maciej W. Rozycki, Ingo Molnar,
Paul Burton, linux-mips, linux-kernel
[-- 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 --]
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2018-02-01 16:04 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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 is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox