Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Mathieu Malaterre and committed by
James Hogan
cdf93470 8d2b6f1f

+1 -1
+1 -1
arch/mips/kernel/branch.c
··· 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 *