From nobody Wed Dec 3 02:20:14 2025 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 C415C1C860A; Sat, 22 Nov 2025 12:38:07 +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=1763815087; cv=none; b=iVNDw0h7jD5uOS9YnjBj7L2MyL/Xw8KSXPNFKRPQtloh3tkLak5V7dtK7K8RwQ0k/ZtCJZn4mZXUhz/+oVguMzx5vawiALfW9RQSTj8sBPYC+Un0x7EVP4bTipoHnHxx6pU0/Bd6RzD1qSqJJGyc7gmL80R/6b6CvCiCDuvtQdk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763815087; c=relaxed/simple; bh=TwvR1MbqOEr/NW02G9o73v7ORLVCV0/ulknx4UAlhb0=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=lVt+I7uOL5ZB44NYSFbfGhwKPcpP+JlOwdqV1M/So3CBb3U3kTLCrFybZlDqRAD+3z3lkCkLdoWHoxeMqpn57dx6J8/M2aaRp1bt56bSKoS9FQ4GxdG4+yJDTFnuyqKSbcS8KVTiChQ5oxwjLPiOFfYAeWleldzuyC69F2h+SpA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=E+AWUPS1; 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="E+AWUPS1" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 62448C4AF0B; Sat, 22 Nov 2025 12:38:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1763815087; bh=TwvR1MbqOEr/NW02G9o73v7ORLVCV0/ulknx4UAlhb0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=E+AWUPS1wGziNemDvPZjmKNauSGUQ3/KOrSSb1l+VVECKpUpu/eAN71sbW0BdxPkv WFY0SjTK5qGLy48+16c2FBE1ZGi2WyRc9EdQaxf50Vu/PpiREB/xDgTqRHP6NsUhvS 6/6m0WAjd4bvglUePdcY91t99I0yuHDHf6uVmKPlgtwBBundmveL8OlY8tmwFzyz6Z YfM6sTBm3RfSgiN0bey74N3H9iS0TmQFrOA+pj+1fsJ0Yl1+GBRAs/gDd3oCFnNOYX SXypDhz9NwDnRjk6qwU0yxzyNZrGtGVo4gVq3poEE9XzIOtHKFjjKUavG9auOctQEA sofz3cxlbEvaw== Received: from mchehab by mail.kernel.org with local (Exim 4.99) (envelope-from ) id 1vMmsP-00000004pm9-2894; Sat, 22 Nov 2025 13:38:05 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , "Jonathan Corbet" Cc: Mauro Carvalho Chehab , "Mauro Carvalho Chehab" , "Randy Dunlap" , linux-kernel@vger.kernel.org Subject: [PATCH v4 2/5] kernel-doc: add support to handle DEFINE_ variables Date: Sat, 22 Nov 2025 13:37:56 +0100 Message-ID: X-Mailer: git-send-email 2.51.1 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-Transfer-Encoding: quoted-printable Sender: Mauro Carvalho Chehab Content-Type: text/plain; charset="utf-8" Improve the parser and output plugin to work with macros, adding support for the common pattern of using DEFINE_* to create variables. Signed-off-by: Mauro Carvalho Chehab --- tools/lib/python/kdoc/kdoc_output.py | 3 +-- tools/lib/python/kdoc/kdoc_parser.py | 25 +++++++++++++++++++++---- 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/tools/lib/python/kdoc/kdoc_output.py b/tools/lib/python/kdoc/k= doc_output.py index 8d811c2afaab..afb3f6d633fd 100644 --- a/tools/lib/python/kdoc/kdoc_output.py +++ b/tools/lib/python/kdoc/kdoc_output.py @@ -801,13 +801,12 @@ class ManFormat(OutputFormat): =20 def out_var(self, fname, name, args): out_name =3D self.arg_name(args, name) - prototype =3D args.other_stuff["var_type"] full_proto =3D args.other_stuff["full_proto"] =20 self.data +=3D f'.TH "{self.modulename}" 9 "{out_name}" "{self.man= _date}" "API Manual" LINUX' + "\n" =20 self.data +=3D ".SH NAME\n" - self.data +=3D f"{prototype} \\- {args['purpose']}\n" + self.data +=3D f"{name} \\- {args['purpose']}\n" =20 self.data +=3D ".SH SYNOPSIS\n" self.data +=3D f"{full_proto}\n" diff --git a/tools/lib/python/kdoc/kdoc_parser.py b/tools/lib/python/kdoc/k= doc_parser.py index edb0fb5330e0..a3cd1bb0c8e7 100644 --- a/tools/lib/python/kdoc/kdoc_parser.py +++ b/tools/lib/python/kdoc/kdoc_parser.py @@ -946,12 +946,27 @@ class KernelDoc: # Store the full prototype before modifying it # full_proto =3D proto + declaration_name =3D None + + # + # Handle macro definitions + # + macro_prefixes =3D [ + KernRe(r"DEFINE_[\w_]+\s*\(([\w_]+)\)"), + ] + + for r in macro_prefixes: + match =3D r.search(proto) + if match: + declaration_name =3D match.group(1) + break =20 # # Drop comments and macros to have a pure C prototype # - for search, sub in sub_prefixes: - proto =3D search.sub(sub, proto) + if not declaration_name: + for r, sub in sub_prefixes: + proto =3D r.sub(sub, proto) =20 proto =3D proto.rstrip() =20 @@ -965,14 +980,16 @@ class KernelDoc: return =20 var_type =3D r.group(0) - declaration_name =3D r.group(1) + + if not declaration_name: + declaration_name =3D r.group(1) + default_val =3D r.group(2) if default_val: default_val =3D default_val.lstrip("=3D").strip() =20 self.output_declaration("var", declaration_name, full_proto=3Dfull_proto, - var_type=3Dvar_type, default_val=3Ddefault_val, purpose=3Dself.entry.declaration_purpose) =20 --=20 2.51.1