]> git.baikalelectronics.ru Git - kernel.git/commitdiff
MIPS: Use proper kernel-doc Return keyword
authorMathieu Malaterre <malat@debian.org>
Wed, 27 Dec 2017 11:07:53 +0000 (12:07 +0100)
committerJames Hogan <jhogan@kernel.org>
Thu, 18 Jan 2018 22:29:02 +0000 (22:29 +0000)
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>
arch/mips/kernel/branch.c

index b79ed9af98860f09e7b9691bd1ccd9b0ec95546b..e48f6c0a9e4a39522f5925cb9716065232cc2de0 100644 (file)
@@ -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.
  *