Skip to contentSkip to conversation

MIPS: Use proper @return keyword

PATCH Superseded Mathieu Malaterre 3 participants 4 messages Dec 26, 2017 – Feb 1, 2018 MIPS

lore
Share & tools
lore

Mathieu Malaterre

author
#0 lore raw

PATCH 1/1 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(-)
arch/mips/kernel/branch.c +1 -1
index b79ed9af9886..e0d3a432e1e3 100644
@@ -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.
  *
Signature · 1 line
2.11.0
#1 lore raw
Quoted 14 lines · Mathieu Malaterre

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(-)
arch/mips/kernel/branch.c +0 -0
index b79ed9af9886..e0d3a432e1e3 100644

arch/mips/kernel/branch.c int __MIPS16e_compute_return_epc(struct pt_regs *regs) · line 402

Quoted 5 lines
arch/mips/kernel/branch.c +1 -1
@@ -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>

Quoted 4 lines
arch/mips/kernel/branch.c +0 -0
  *		returns 0 or BRANCH_LIKELY_TAKEN as appropriate after
  *		evaluating the branch.
  *
Signature · 1 line
~Randy
author
#2 lore raw

PATCH v2 1/1 MIPS: Use proper Return keyword

In reply to Mathieu Malaterre

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(-)
arch/mips/kernel/branch.c +1 -1
index b79ed9af9886..e48f6c0a9e4a 100644
@@ -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.
  *
Signature · 1 line
2.11.0
Applied
#3 lore raw

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

Quoted 8 lines · Mathieu Malaterre

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

Quoted 23 lines

---
v2: Actually use the correct keyword

 arch/mips/kernel/branch.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/mips/kernel/branch.c +1 -1
index b79ed9af9886..e48f6c0a9e4a 100644
@@ -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.
  *
Signature · 1 line
2.11.0