From nobody Tue Apr 7 16:16:02 2026 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (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 D6D9136E46C; Thu, 12 Mar 2026 14:54:57 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1773327297; cv=none; b=EoSGXO3pqb3t+t9b2FwCA+5Gz3cYvSQL4DJkoHYrsASCpZoag+pxUDFmoAIKuG8eQ+6qwD2k9kk4e+nL1tCFj4MWLA8UL4MpfZ/GoZ28+SXyENoMq8KwRDJi4CNLCEYTnMUCHjw4SQJJ2H4j652zf70l6AobyLma3zWfwsy0VME= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1773327297; c=relaxed/simple; bh=xUBIjCPiqikLumDJV0/ro119OoQ7PDq8BR8ypLrh5DM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=qn55OpmDzesH0mJNjzjvr0LMI8TIbAq8k4Heai6Di6JLUAi0njaP+6jR2rW034xYattDSOR2WuOx6sRvBh6g04sdhdfhF0TTR7xUgKpDzUFwrViGSPLn1Q3a85ucTfyGbze4dwvjxDb1sk0BjYkspJolWfMnmk1on5zQ8PcfKDU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=JTF21tnz; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="JTF21tnz" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 9CB6FC2BC87; Thu, 12 Mar 2026 14:54:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1773327297; bh=xUBIjCPiqikLumDJV0/ro119OoQ7PDq8BR8ypLrh5DM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=JTF21tnzAGWmtxzbqh8d8uO4V7XvbZqmfPZVn0yG3aL6+BG+8DVhfbwuiQZCIDyWT e7wljT5cfYivsEcqfTJN7dOqHhX7MZ3c6tRoWaH/z0gJZltCXrvWN9I5zScS4zRYsG WPpuryfJbFbl3RY03EykPRX0Jer+cihEALlzd70jHT9ClSPwgH51OJJpNm7d4VQyHM x5uHzJAmCequQvb0AEyfkV25sBLa9aZwvBl/mC28pzI/FrhgXA58qrbqSH3Hi+OzUi DMqggT9uQ6VPJOsO11sr5OLWl1WINgwcHPoUtaHTt9Le3e3hxqr6OMt05hwop52xJe nEx0T01HWmUTg== Received: from mchehab by mail.kernel.org with local (Exim 4.99.1) (envelope-from ) id 1w0hR9-00000008xoP-3gC3; Thu, 12 Mar 2026 15:54:55 +0100 From: Mauro Carvalho Chehab To: Jonathan Corbet , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-hardening@vger.kernel.org, linux-kernel@vger.kernel.org, Aleksandr Loktionov , Randy Dunlap Subject: [PATCH v2 03/28] docs: kdoc: don't add broken comments inside prototypes Date: Thu, 12 Mar 2026 15:54:23 +0100 Message-ID: <2b957decdb6cedab4268f71a166c25b7abdb9a61.1773326442.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.52.0 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Sender: Mauro Carvalho Chehab Parsing a file like drivers/scsi/isci/host.h, which contains broken kernel-doc markups makes it create a prototype that contains unmatched end comments. That causes, for instance, struct sci_power_control to be shown this this prototype: struct sci_power_control { * it is not. */ bool timer_started; */ struct sci_timer timer; * requesters field. */ u8 phys_waiting; */ u8 phys_granted_power; * mapped into requesters via struct sci_phy.phy_index */ struct isc= i_phy *requesters[SCI_MAX_PHYS]; }; as comments won't start with "/*" anymore. Fix the logic to detect such cases, and keep adding the comments inside it. Signed-off-by: Mauro Carvalho Chehab Message-ID: <18e577dbbd538dcc22945ff139fe3638344e14f0.1773074166.git.mcheha= b+huawei@kernel.org> --- tools/lib/python/kdoc/kdoc_parser.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/tools/lib/python/kdoc/kdoc_parser.py b/tools/lib/python/kdoc/k= doc_parser.py index edf70ba139a5..086579d00b5c 100644 --- a/tools/lib/python/kdoc/kdoc_parser.py +++ b/tools/lib/python/kdoc/kdoc_parser.py @@ -1355,6 +1355,12 @@ class KernelDoc: elif doc_content.search(line): self.emit_msg(ln, f"Incorrect use of kernel-doc format: {line}= ") self.state =3D state.PROTO + + # + # Don't let it add partial comments at the code, as breaks the + # logic meant to remove comments from prototypes. + # + self.process_proto_type(ln, "/**\n" + line) # else ... ?? =20 def process_inline_text(self, ln, line): --=20 2.52.0