linux-kernel - [PATCH] docs: Fix missing parameter description for raw_seqcount_try

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]

Message-Id: <20250125131734.36253-1-miguelgarciaroman8@gmail.com>
Date: Sat, 25 Jan 2025 14:17:34 +0100
From: Miguel García <miguelgarciaroman8@...il.com>
To: linux-kernel@...r.kernel.org
Cc: skhan@...uxfoundation.org,
	Miguel García <miguelgarciaroman8@...il.com>
Subject: [PATCH] docs: Fix missing parameter description for raw_seqcount_try_begin

Added proper documentation for the 'start' parameter in the macro
raw_seqcount_try_begin() to resolve a Sphinx warning during documentation
generation.

Signed-off-by: Miguel García <miguelgarciaroman8@...il.com>
---
 include/linux/seqlock.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/include/linux/seqlock.h b/include/linux/seqlock.h
index d1a2346cf0f8..0aa822e867ac 100644
--- a/include/linux/seqlock.h
+++ b/include/linux/seqlock.h
@@ -322,6 +322,7 @@ SEQCOUNT_LOCKNAME(mutex,        struct mutex,    true,     mutex)
  * raw_seqcount_try_begin() - begin a seqcount_t read critical section
  *                            w/o lockdep and w/o counter stabilization
  * @s: Pointer to seqcount_t or any of the seqcount_LOCKNAME_t variants
+ * @start: Variable to store the sequence count read from @s
  *
  * Similar to raw_seqcount_begin(), except it enables eliding the critical
  * section entirely if odd, instead of doing the speculation knowing it will
-- 
2.34.1