MIPS: Use proper kernel-doc Return keyword

"Linux Kernel Mailing List" <[email protected]>
Newsgroups gmane.linux.kernel.commits.head
Message-ID <[email protected]>
Web:        https://git.kernel.org/torvalds/c/cdf93470a065de6366f92b144ac48236ddfb1315
Commit:     cdf93470a065de6366f92b144ac48236ddfb1315
Parent:     8d2b6f1ff4606a8d426397a4d14b653bda0babd9
Refname:    refs/heads/master
Author:     Mathieu Malaterre <[email protected]>
AuthorDate: Wed Dec 27 12:07:53 2017 +0100
Committer:  James Hogan <[email protected]>
CommitDate: Thu Jan 18 22:29:02 2018 +0000

    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 <[email protected]>
    Cc: Ralf Baechle <[email protected]>
    Cc: Randy Dunlap <[email protected]>
    Cc: Maciej W. Rozycki <[email protected]>
    Cc: Ingo Molnar <[email protected]>
    Cc: Paul Burton <[email protected]>
    Cc: [email protected]
    Patchwork: https://patchwork.linux-mips.org/patch/18031/
    [[email protected]: Expand subject slightly]
    Signed-off-by: James Hogan <[email protected]>
---
 arch/mips/kernel/branch.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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)
  *
  * @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.
  *
--
To unsubscribe from this list: send the line "unsubscribe git-commits-head" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.