From nobody Sun Feb 8 17:42:06 2026 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 593292309B9 for ; Fri, 23 Jan 2026 18:37:50 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1769193475; cv=none; b=DrmmxI1f4L8sF+rSR3W++mcH92CHAwPNiuoEGPBuCsauuQ/JK1STqDUAF59Z5EOg6lTkC5MZ1o30pjCYEa3T6d+R8GONYxUfiz38BmBTifiVsggYHEu8MPoMhcMkHoosw3MOIdG6zXyRVU845JCnR0u1c3xcBPnMhg96smJ/cPQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1769193475; c=relaxed/simple; bh=9zF8LppLfrS+LoF26xfB7kCzg7smiQ7apJ78PLqHy+k=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=lu83mzkYi9T+EsCm5MUOWWsjQFaRTmWMIE3WEXVwp2ffDxpf3kzt1x0Z1iVFjBHARtCr/2+4t1VOJd3hOTP/ulFLUpy/h+UWw1DV97KgXtkLesoHARFE30ZD4fLT3rp8sDIP7uA5/d2ooMt5IMAwhutma8NRY8d4quOpkj01nFc= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=WuWolNSg; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="WuWolNSg" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=claSPzbNdk/g7uR7pYa6wi1yp5+C/AxIhzlAGXT3PZU=; b=WuWolNSg+n86TwGSP0O72Z9keb KrCQ/Hom5kpU+B1HSr4xDjap8BVfg9xd9/DOBv5fieKAJ/xW5EUohBQChoSISAxH5QKPR37VlaR6k Nxt4BJT/mot4Tng284ibgRXdmAulgTemY93WrhUb50ZDKLWSuIXZ3h0k0DfymiCgoouSCsE05pw3E SFBMOKFYAHgp5aYsyCyXGW2L7qlzo8WpjsgHSquGwWlv7wfWA+mMvGYmS++eHe1kKFSHhrtuW8bKw u3Vatu10ZykS62xaJdiPTszPSX49IkvOwZ97HzBV1S6bLH7nGzcRifzZiuF9kCl8e4dejlgbWsfh1 s0zjpM1Q==; Received: from [50.53.43.113] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.98.2 #2 (Red Hat Linux)) id 1vjM2X-00000009MOO-3HAr; Fri, 23 Jan 2026 18:37:49 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Peter Zijlstra , Ingo Molnar , Will Deacon Subject: [PATCH v2] seqlock: fix scoped_seqlock_read kernel-doc Date: Fri, 23 Jan 2026 10:37:49 -0800 Message-ID: <20260123183749.3997533-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.52.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Eliminate all kernel-doc warnings in seqlock.h: - correct the macro to have "()" immediately following the macro name - don't include the macro parameters in the short description (first line) - make the parameter names in the comments match the actual macro parameter names. - use "::" for the Example WARNING: include/linux/seqlock.h:1341 This comment starts with '/**', but i= sn't a kernel-doc comment. * scoped_seqlock_read (lock, ss_state) - execute the read side critical Documentation/locking/seqlock:242: include/linux/seqlock.h:1351: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils] Warning: include/linux/seqlock.h:1357 function parameter '_seqlock' not des= cribed in 'scoped_seqlock_read' Warning: include/linux/seqlock.h:1357 function parameter '_target' not desc= ribed in 'scoped_seqlock_read' Fixes: cc39f3872c08 ("seqlock: Introduce scoped_seqlock_read()") Signed-off-by: Randy Dunlap --- v2: use "::" on the Example Cc: Peter Zijlstra Cc: Ingo Molnar Cc: Will Deacon include/linux/seqlock.h | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) --- linux-next-20260121.orig/include/linux/seqlock.h +++ linux-next-20260121/include/linux/seqlock.h @@ -1339,15 +1339,14 @@ static __always_inline void __scoped_seq __scoped_seqlock_next(&_s, _seqlock, _target)) =20 /** - * scoped_seqlock_read (lock, ss_state) - execute the read side critical - * section without manual sequence - * counter handling or calls to oth= er - * helpers - * @lock: pointer to seqlock_t protecting the data - * @ss_state: one of {ss_lock, ss_lock_irqsave, ss_lockless} indicating - * the type of critical read section + * scoped_seqlock_read() - execute the read-side critical section + * without manual sequence counter handling + * or calls to other helpers + * @_seqlock: pointer to seqlock_t protecting the data + * @_target: an enum ss_state: one of {ss_lock, ss_lock_irqsave, ss_lockle= ss} + * indicating the type of critical read section * - * Example: + * Example:: * * scoped_seqlock_read (&lock, ss_lock) { * // read-side critical section