From nobody Sat Oct 4 22:37:55 2025 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) (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 049D82FF179; Tue, 12 Aug 2025 19:57:59 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=45.79.88.28 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1755028681; cv=none; b=LfCurcgshPT2uMabYjn+VfY1g9Oql2xtMOkbi23ERPRq7YJzH/pqrsQrN/C3VNz/SE0UVY7/wbsaEJ2VGu35g1UPGwpbVKW6x7rcikVyuMZH9JXw555XC4M8vAe7SLxDRdozbMgH9gq/atdhaBSOGqdquTTElIG37Iz4JhLrIFo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1755028681; c=relaxed/simple; bh=rjJmmU5S7TbIUqYY/JAO40jGyx07vxve6fsT45iwmjI=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=iwa9QInoa/7/1WxBV8QgKvs4o1qTM8jtQviAaUHL1jjSmtNEKeP+wis1TjgyE5RAV17lSssbnuXJ1uTLiXQQVg5nLhKdMCZyfWVZdTHhU0XrXclW5Vch0F0gCd11iFoR9o5P+laZ4teZML2s2p/23v4wWcquSyd3VkfzarwTJaE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net; spf=pass smtp.mailfrom=lwn.net; dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b=kNgdjhMu; arc=none smtp.client-ip=45.79.88.28 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=lwn.net Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b="kNgdjhMu" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 267D640AF4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1755028679; bh=J57bzfXmOD2R1gP/y/AesBfePH55ilhwvePByC8Qo94=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=kNgdjhMuC+5IoejMTX1/jr4wwxBXkZYm6lDQfJqWB3hI2thoNbBSRc0etNjYmlMX2 x2KUuArH3y59ymvQmmqmyvf0W0YP9J9ftiLxOFNqQaFYXgk5n/yyibnEY0VOwW6Pai BJfrr02cVuLTp/pfbzIepR5NRh26qhxIfk81EGP65JB2wGbW4mp2yOXpMh9OL77yRW Lf8hafbT1Ty52/ev++N7cPV6OnzT2eNanQMqw1+BgZ9Jpo7sno6OFNjxC2RsYqSSJI pKZjFTvs4MElqfFKi1vIx2DVnP1zpHwC0RicI+o5lermwfJeh0OHRCga6uCmTqQGpG 4ef1sdcEUKffw== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id 267D640AF4; Tue, 12 Aug 2025 19:57:59 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Jonathan Corbet Subject: [PATCH 4/7] docs: kdoc: add a couple more comments in create_parameter_list() Date: Tue, 12 Aug 2025 13:57:45 -0600 Message-ID: <20250812195748.124402-5-corbet@lwn.net> X-Mailer: git-send-email 2.50.1 In-Reply-To: <20250812195748.124402-1-corbet@lwn.net> References: <20250812195748.124402-1-corbet@lwn.net> 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" Make what the final code is doing a bit more clear to slow readers like me. Signed-off-by: Jonathan Corbet Reviewed-by: Mauro Carvalho Chehab --- scripts/lib/kdoc/kdoc_parser.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/scripts/lib/kdoc/kdoc_parser.py b/scripts/lib/kdoc/kdoc_parser= .py index 47f7ea01ed10..36c4035343dc 100644 --- a/scripts/lib/kdoc/kdoc_parser.py +++ b/scripts/lib/kdoc/kdoc_parser.py @@ -568,12 +568,18 @@ class KernelDoc: =20 bitfield_re =3D KernRe(r'(.*?):(\w+)') for param in args: + # + # For pointers, shift the star(s) from the variable na= me to the + # type declaration. + # r =3D KernRe(r'^(\*+)\s*(.*)') if r.match(param): self.push_parameter(ln, decl_type, r.group(2), f"{dtype} {r.group(1)}", arg, declaration_name) - + # + # Perform a similar shift for bitfields. + # elif bitfield_re.search(param): if dtype !=3D "": # Skip unnamed bit-fields self.push_parameter(ln, decl_type, bitfield_re= .group(1), --=20 2.50.1