diff options
author | Mathieu Malaterre <malat@debian.org> | 2017-12-27 06:07:53 -0500 |
---|---|---|
committer | James Hogan <jhogan@kernel.org> | 2018-01-18 17:29:02 -0500 |
commit | cdf93470a065de6366f92b144ac48236ddfb1315 (patch) | |
tree | f79e9be124dc2341878e5278e9681c8a1b5090c5 | |
parent | 8d2b6f1ff4606a8d426397a4d14b653bda0babd9 (diff) |
MIPS: Use proper kernel-doc 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 <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>
-rw-r--r-- | arch/mips/kernel/branch.c | 2 |
1 files changed, 1 insertions, 1 deletions
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) | |||
399 | * | 399 | * |
400 | * @regs: Pointer to pt_regs | 400 | * @regs: Pointer to pt_regs |
401 | * @insn: branch instruction to decode | 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 | * returns 0 or BRANCH_LIKELY_TAKEN as appropriate after | 403 | * returns 0 or BRANCH_LIKELY_TAKEN as appropriate after |
404 | * evaluating the branch. | 404 | * evaluating the branch. |
405 | * | 405 | * |