MIPS: Use proper kernel-doc Return keyword

malaterre · amalon · commit cdf93470a065 · 2018-01-18T22:29:02.000Z
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> Cc: Ralf Baechle <ralf@linux-mips.org> Cc: Randy Dunlap <rdunlap@infradead.org> Cc: Maciej W. Rozycki <macro@mips.com> Cc: Ingo Molnar <mingo@kernel.org> Cc: Paul Burton <paul.burton@mips.com> Cc: linux-mips@linux-mips.org Patchwork: https://patchwork.linux-mips.org/patch/18031/ [jhogan@kernel.org: Expand subject slightly] Signed-off-by: James Hogan <jhogan@kernel.org>
diff --git 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.
  *

Original file line number	Diff line number	Diff line change
`@@ -399,7 +399,7 @@ int __MIPS16e_compute_return_epc(struct pt_regs *regs)`
`399`	`399`	`*`
`400`	`400`	`* @regs: Pointer to pt_regs`
`401`	`401`	`* @insn: branch instruction to decode`
`402`		`- * @returns: -EFAULT on error and forces SIGILL, and on success`
	`402`	`+ * Return: -EFAULT on error and forces SIGILL, and on success`
`403`	`403`	`* returns 0 or BRANCH_LIKELY_TAKEN as appropriate after`
`404`	`404`	`* evaluating the branch.`
`405`	`405`	`*`