linux-kernel - [PATCH 10/10] seqlock: kernel-doc: fix a prototype

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 for Android: free password hash cracker in your pocket

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

Date:   Thu, 14 Jan 2021 08:53:45 +0100
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     Ingo Molnar <mingo@...hat.com>,
        Peter Zijlstra <peterz@...radead.org>,
        Will Deacon <will@...nel.org>
Cc:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        "Jonathan Corbet" <corbet@....net>,
        "Linux Doc Mailing List" <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org
Subject: [PATCH 10/10] seqlock: kernel-doc: fix a prototype

Right now, kernel-doc produces a warning:

	./include/linux/seqlock.h:829: warning: wrong kernel-doc identifier on line:
	 * DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t

The issue is that Kernel-doc valid syntaxes for function/define
declarations are either:

	function_foo - description

or:

	function_foo() - description

The function parameters should be declared only afterwards.

So, replace it to:
	DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
---
 include/linux/seqlock.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/seqlock.h b/include/linux/seqlock.h
index 2f7bb92b4c9e..209454cedf61 100644
--- a/include/linux/seqlock.h
+++ b/include/linux/seqlock.h
@@ -826,7 +826,7 @@ typedef struct {
 	} while (0)
 
 /**
- * DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
+ * DEFINE_SEQLOCK() - Define a statically allocated seqlock_t
  * @sl: Name of the seqlock_t instance
  */
 #define DEFINE_SEQLOCK(sl) \
-- 
2.29.2