linux-kernel - [PATCH -next] kernel/notifier.c: fix doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Date:   Thu, 10 Jun 2021 19:37:06 +0800
From:   Baokun Li <libaokun1@...wei.com>
To:     <peterz@...radead.org>, <rafael.j.wysocki@...el.com>,
        <mingo@...nel.org>, <linux-kernel@...r.kernel.org>
CC:     <weiyongjun1@...wei.com>, <yuehaibing@...wei.com>,
        <yangjihong1@...wei.com>, <yukuai3@...wei.com>,
        <libaokun1@...wei.com>
Subject: [PATCH -next] kernel/notifier.c: fix doc warnings

Fixes the following W=1 kernel build warning(s):

 kernel/notifier.c:67: warning: Excess function
  parameter 'returns' description in 'notifier_call_chain'
 kernel/notifier.c:115: warning: Function parameter or
  member 'v' not described in 'notifier_call_chain_robust'

Signed-off-by: Baokun Li <libaokun1@...wei.com>
---
 kernel/notifier.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/kernel/notifier.c b/kernel/notifier.c
index 1b019cbca594..e776e65751c2 100644
--- a/kernel/notifier.c
+++ b/kernel/notifier.c
@@ -58,7 +58,7 @@ static int notifier_chain_unregister(struct notifier_block **nl,
  *			value of this parameter is -1.
  *	@nr_calls:	Records the number of notifications sent. Don't care
  *			value of this field is NULL.
- *	@returns:	notifier_call_chain returns the value returned by the
+ *	returns:	notifier_call_chain returns the value returned by the
  *			last notifier function called.
  */
 static int notifier_call_chain(struct notifier_block **nl,
@@ -101,7 +101,7 @@ NOKPROBE_SYMBOL(notifier_call_chain);
  * @val_up:	Value passed unmodified to the notifier function
  * @val_down:	Value passed unmodified to the notifier function when recovering
  *              from an error on @val_up
- * @v		Pointer passed unmodified to the notifier function
+ * @v:		Pointer passed unmodified to the notifier function
  *
  * NOTE:	It is important the @nl chain doesn't change between the two
  *		invocations of notifier_call_chain() such that we visit the
-- 
2.31.1