linux-mips
[Top] [All Lists]

[PATCH v2] MIPS: Use proper Return keyword

To: Randy Dunlap <rdunlap@infradead.org>
Subject: [PATCH v2] MIPS: Use proper Return keyword
From: Mathieu Malaterre <malat@debian.org>
Date: Wed, 27 Dec 2017 12:07:53 +0100
Cc: Mathieu Malaterre <malat@debian.org>, Ralf Baechle <ralf@linux-mips.org>, "Maciej W. Rozycki" <macro@mips.com>, Ingo Molnar <mingo@kernel.org>, Paul Burton <paul.burton@mips.com>, linux-mips@linux-mips.org, linux-kernel@vger.kernel.org
Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references; bh=AcKbrP3egxdDnfs24RPUz89WbnEB2bIB02HnlZnMxw8=; b=gIoMB0EAK04F/np//yYVubUAL6TergARfyIPlZSAW7lAaLzSXLJvKEMlFZYLo3R3Nt EvZ+uFj2ySR+raRHay/aodm3x3GWKPjy/XFioHc/dWnEiWop7Szr+sGp+LNjj4dJHKJ9 Y3LTCX/oen2HMUcYSvzre6n2lVbP9/HOF+/lUlWe2dO/p58JD+xfE8j5X0JMSU1/zu2c k7VpkE/P5uwVZsFlIV4aTVVc5KxC0Zd6yOUvDmV30SYP5m8IfyTkAaT87ozr1wuxdzxn GZo/+USp2kR6Q1RAQMcvTAvMPGYEIcZoMhC4499w3zLcxsi5YW/YPr5RSFYrU9EoC5j1 CueA==
In-reply-to: <20171226105532.23452-1-malat@debian.org>
List-archive: <http://www.linux-mips.org/archives/linux-mips/>
List-help: <mailto:ecartis@linux-mips.org?Subject=help>
List-id: linux-mips <linux-mips.eddie.linux-mips.org>
List-owner: <mailto:ralf@linux-mips.org>
List-post: <mailto:linux-mips@linux-mips.org>
List-software: Ecartis version 1.0.0
List-subscribe: <mailto:ecartis@linux-mips.org?subject=subscribe%20linux-mips>
List-unsubscribe: <mailto:ecartis@linux-mips.org?subject=unsubscribe%20linux-mips>
Original-recipient: rfc822;linux-mips@linux-mips.org
References: <20171226105532.23452-1-malat@debian.org>
Sender: linux-mips-bounce@linux-mips.org
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>
---
v2: Actually use the correct keyword

 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.
  *
-- 
2.11.0


<Prev in Thread] Current Thread [Next in Thread>