From nobody Sun Feb 8 10:33:44 2026 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 0B42A2E1C63; Fri, 24 Oct 2025 20:08:51 +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=1761336533; cv=none; b=HNCjbr6S5tKJLbaz9niJqYl7Qqcd6VCJi+VU2ov+i3dzLxBz1tTez2+qyhpv6t3LG6FE/qTIRqO6HlQkL5oO7SpWJ56Aixn7+IWlt2YS3Xp3BqMPaI/GXeLCaXMcOy2qmFNALkLs3UkAmCy35uH6GqlZW1rmcp7N9ogGCvV/GDQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1761336533; c=relaxed/simple; bh=TdHXcDiNWao5l+MSzK2kBWUaJug8oDVRsNcOEnrV9QA=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=ZjWDsCXgJVyZ20HSFMMluglUV/IPWBeDsi5W1MELgv6OluFXrDkZ5KC2KrJEJIXfHiFTopiurqfk9pma4nDO8ZxWsXps1tEiCGvinDbBxsmvA+NjSEFplMAmeDx+8/NOETI9Ef3o2qTe/jn4S354/weUMB7GhRb0sdpFTGyGXEY= 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=HAXCuvIA; 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="HAXCuvIA" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 1F3EB40B38 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1761336524; bh=a07wvbJJF2Sphbu4YX87L2J5mPBdv/tkJJyhVfoX/G8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=HAXCuvIA4jJ3+oXl7FHzqrcMyyz2kOCedKHnh4Ur8+uyqNN9fvfDl7f22m+Jpzmgn sp16Xu6/hWumMuoM3MRAgYfft3C4AEY9e9QUjxMwQtfVNsd9Icjda8wY6LKoV59zAt l7Aoh2P2ab2YDfWLvp7dhTFcsl9ZaUkOQhodQmn1xTllZ9CPJPOsnx/1foSGtHBKw4 zRv/eGQiqAssoLr+tGuTVPRtzu+YKnIHThruX8tjqHMG10UHXcZNC4Vf2RhcR/EMld uWvqVKiR2+pQu/QEvwf3dilfUJ6aD3oXitaoRTvpni18kpL2ZGpJ/Gf0OUw1iK3GlY w9oA1TpfZiS+A== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id 1F3EB40B38; Fri, 24 Oct 2025 20:08:44 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Randy Dunlap , Jani Nikula , Jonathan Corbet , Jani Nikula Subject: [PATCH v3 1/8] docs: Move the "features" tools to tools/docs Date: Fri, 24 Oct 2025 14:08:22 -0600 Message-ID: <20251024200834.20644-2-corbet@lwn.net> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20251024200834.20644-1-corbet@lwn.net> References: <20251024200834.20644-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" The scripts for managing the features docs are found in three different directories; unite them all under tools/docs and update references as needed. Acked-by: Jani Nikula Signed-off-by: Jonathan Corbet Reviewed-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_feat.py | 4 ++-- .../features/scripts =3D> tools/docs}/features-refresh.sh | 0 {scripts =3D> tools/docs}/get_feat.pl | 2 +- {Documentation/features =3D> tools/docs}/list-arch.sh | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) rename {Documentation/features/scripts =3D> tools/docs}/features-refresh.s= h (100%) rename {scripts =3D> tools/docs}/get_feat.pl (99%) rename {Documentation/features =3D> tools/docs}/list-arch.sh (83%) diff --git a/Documentation/sphinx/kernel_feat.py b/Documentation/sphinx/ker= nel_feat.py index aaac76892ceb..81c67ef23d8d 100644 --- a/Documentation/sphinx/kernel_feat.py +++ b/Documentation/sphinx/kernel_feat.py @@ -13,7 +13,7 @@ :license: GPL Version 2, June 1991 see Linux/COPYING for details. =20 The ``kernel-feat`` (:py:class:`KernelFeat`) directive calls the - scripts/get_feat.pl script to parse the Kernel ABI files. + tools/docs/get_feat.pl script to parse the Kernel ABI files. =20 Overview of directive's argument and options. =20 @@ -85,7 +85,7 @@ class KernelFeat(Directive): srctree =3D os.path.abspath(os.environ["srctree"]) =20 args =3D [ - os.path.join(srctree, 'scripts/get_feat.pl'), + os.path.join(srctree, 'tools/docs/get_feat.pl'), 'rest', '--enable-fname', '--dir', diff --git a/Documentation/features/scripts/features-refresh.sh b/tools/doc= s/features-refresh.sh similarity index 100% rename from Documentation/features/scripts/features-refresh.sh rename to tools/docs/features-refresh.sh diff --git a/scripts/get_feat.pl b/tools/docs/get_feat.pl similarity index 99% rename from scripts/get_feat.pl rename to tools/docs/get_feat.pl index 40fb28c8424e..d75e7c85dc85 100755 --- a/scripts/get_feat.pl +++ b/tools/docs/get_feat.pl @@ -18,7 +18,7 @@ my $enable_fname; my $basename =3D abs_path($0); $basename =3D~ s,/[^/]+$,/,; =20 -my $prefix=3D$basename . "../Documentation/features"; +my $prefix=3D$basename . "../../Documentation/features"; =20 # Used only at for full features output. The script will auto-adjust # such values for the minimal possible values diff --git a/Documentation/features/list-arch.sh b/tools/docs/list-arch.sh similarity index 83% rename from Documentation/features/list-arch.sh rename to tools/docs/list-arch.sh index ac8ff7f6f859..96fe83b7058b 100755 --- a/Documentation/features/list-arch.sh +++ b/tools/docs/list-arch.sh @@ -8,4 +8,4 @@ =20 ARCH=3D${1:-$(uname -m | sed 's/x86_64/x86/' | sed 's/i386/x86/' | sed 's/= s390x/s390/')} =20 -$(dirname $0)/../../scripts/get_feat.pl list --arch $ARCH +$(dirname $0)/get_feat.pl list --arch $ARCH --=20 2.51.0 From nobody Sun Feb 8 10:33:44 2026 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 6E5662E284A; Fri, 24 Oct 2025 20:08:52 +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=1761336534; cv=none; b=TRzqTLfe61Fyn97o9JXaMRz59X3QjSmvYXKaQtC7Lh+KG0FgBju9IM1MPEtS4ndx9ojnPmYpLCha5aLQ+3MtYw5ondYQeI5xRqbXnqs0o3oZqMT8sha7Rc7yv07nJqkJH8N0lHVCT+1a859vAG4PynKHk+mW9EFvjlDrkC2RMt0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1761336534; c=relaxed/simple; bh=Xi7PnmCgDeF0XVcZ13rMAqwrSnfDBJa1e0ZLCU0kzpQ=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=OTfaoIM7wG58YIrkVFPBX5oFjDeg2wPb6QddVNJWm3dsjaSWGF4x9JiEPTJDx81sxnSifqc6bTIjBG0x43ewG1ION2wA5beD/xdlTq05FECIZr1Bmcj5XzHUWHfccoHUQuiMB92dtLCEL8eOyHj80kfCdTT5Yr1RUbTQiRxSn4E= 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=Hqw+gObQ; 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="Hqw+gObQ" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net D296F40BB6 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1761336525; bh=wSnIb2rgwHq5hyiKD7LUFy0BcoWQKfxQzqsaypFIVRY=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Hqw+gObQC8ww8uxH6mspIkcJCXp45HH4iOU/uixpyJix6V/UNOwlA35wXlCPWao1n OCekgHGz9VnK0Xli3JIRqdEAkT99IuV6jhT+zUsY4e1mjDQpoqdPbJKBLXmPFHJzzP GbOWs+0wbCzEiDDxkxs2zKYViB+yRbfFOWq0M+6EYA6zDe0H8v5dlK2WZPt9NxKdcO mZCzNUT4ZEY57sE7Lrptb+WOPtI4ka4CyiCSAcdaMS5Wy4+nR/iCUOHoXXaKjHGoUE SPWftJU11jXmCGi9JE3+nN7GbonFzy0un5VMmDD9RIgDuR9exf84KoPPB2HeD2FAIC hzWRDGT0nowxg== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id D296F40BB6; Fri, 24 Oct 2025 20:08:44 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Randy Dunlap , Jani Nikula , Jonathan Corbet , Alex Shi , Yanteng Si , Dongliang Mu , Jani Nikula Subject: [PATCH v3 2/8] docs: move checktransupdate.py to tools/docs Date: Fri, 24 Oct 2025 14:08:23 -0600 Message-ID: <20251024200834.20644-3-corbet@lwn.net> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20251024200834.20644-1-corbet@lwn.net> References: <20251024200834.20644-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-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable The checktranslate.py tool currently languishes in scripts/; move it to tools/docs and update references accordingly. Cc: Alex Shi Cc: Yanteng Si Cc: Dongliang Mu Acked-by: Jani Nikula Signed-off-by: Jonathan Corbet Reviewed-by: Mauro Carvalho Chehab --- Documentation/doc-guide/checktransupdate.rst | 6 +++--- .../translations/zh_CN/doc-guide/checktransupdate.rst | 6 +++--- Documentation/translations/zh_CN/how-to.rst | 2 +- MAINTAINERS | 1 - {scripts =3D> tools/docs}/checktransupdate.py | 8 ++++---- 5 files changed, 11 insertions(+), 12 deletions(-) rename {scripts =3D> tools/docs}/checktransupdate.py (97%) diff --git a/Documentation/doc-guide/checktransupdate.rst b/Documentation/d= oc-guide/checktransupdate.rst index dfaf9d373747..7b25375cc6d9 100644 --- a/Documentation/doc-guide/checktransupdate.rst +++ b/Documentation/doc-guide/checktransupdate.rst @@ -27,15 +27,15 @@ Usage =20 :: =20 - ./scripts/checktransupdate.py --help + tools/docs/checktransupdate.py --help =20 Please refer to the output of argument parser for usage details. =20 Samples =20 -- ``./scripts/checktransupdate.py -l zh_CN`` +- ``tools/docs/checktransupdate.py -l zh_CN`` This will print all the files that need to be updated in the zh_CN loca= le. -- ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-to= ols/testing-overview.rst`` +- ``tools/docs/checktransupdate.py Documentation/translations/zh_CN/dev-t= ools/testing-overview.rst`` This will only print the status of the specified file. =20 Then the output is something like: diff --git a/Documentation/translations/zh_CN/doc-guide/checktransupdate.rs= t b/Documentation/translations/zh_CN/doc-guide/checktransupdate.rst index d20b4ce66b9f..dbfd65398077 100644 --- a/Documentation/translations/zh_CN/doc-guide/checktransupdate.rst +++ b/Documentation/translations/zh_CN/doc-guide/checktransupdate.rst @@ -28,15 +28,15 @@ =20 :: =20 - ./scripts/checktransupdate.py --help + tools/docs/checktransupdate.py --help =20 =E5=85=B7=E4=BD=93=E7=94=A8=E6=B3=95=E8=AF=B7=E5=8F=82=E8=80=83=E5=8F=82= =E6=95=B0=E8=A7=A3=E6=9E=90=E5=99=A8=E7=9A=84=E8=BE=93=E5=87=BA =20 =E7=A4=BA=E4=BE=8B =20 -- ``./scripts/checktransupdate.py -l zh_CN`` +- ``tools/docs/checktransupdate.py -l zh_CN`` =E8=BF=99=E5=B0=86=E6=89=93=E5=8D=B0 zh_CN =E8=AF=AD=E8=A8=80=E4=B8=AD= =E9=9C=80=E8=A6=81=E6=9B=B4=E6=96=B0=E7=9A=84=E6=89=80=E6=9C=89=E6=96=87=E4= =BB=B6=E3=80=82 -- ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-to= ols/testing-overview.rst`` +- ``tools/docs/checktransupdate.py Documentation/translations/zh_CN/dev-t= ools/testing-overview.rst`` =E8=BF=99=E5=B0=86=E5=8F=AA=E6=89=93=E5=8D=B0=E6=8C=87=E5=AE=9A=E6=96= =87=E4=BB=B6=E7=9A=84=E7=8A=B6=E6=80=81=E3=80=82 =20 =E7=84=B6=E5=90=8E=E8=BE=93=E5=87=BA=E7=B1=BB=E4=BC=BC=E5=A6=82=E4=B8=8B= =E7=9A=84=E5=86=85=E5=AE=B9=EF=BC=9A diff --git a/Documentation/translations/zh_CN/how-to.rst b/Documentation/tr= anslations/zh_CN/how-to.rst index 714664fec308..7ae5d8765888 100644 --- a/Documentation/translations/zh_CN/how-to.rst +++ b/Documentation/translations/zh_CN/how-to.rst @@ -437,7 +437,7 @@ git email =E9=BB=98=E8=AE=A4=E4=BC=9A=E6=8A=84=E9=80=81= =E7=BB=99=E6=82=A8=E4=B8=80=E4=BB=BD=EF=BC=8C=E6=89=80=E4=BB=A5=E6=82=A8=E5= =8F=AF=E4=BB=A5=E5=88=87=E6=8D=A2=E4=B8=BA=E5=AE=A1=E9=98=85=E8=80=85=E7=9A= =84=E8=A7=92 =E5=AF=B9=E4=BA=8E=E9=A6=96=E6=AC=A1=E5=8F=82=E4=B8=8E Linux =E5=86=85=E6= =A0=B8=E4=B8=AD=E6=96=87=E6=96=87=E6=A1=A3=E7=BF=BB=E8=AF=91=E7=9A=84=E6=96= =B0=E6=89=8B=EF=BC=8C=E5=BB=BA=E8=AE=AE=E6=82=A8=E5=9C=A8 linux =E7=9B=AE= =E5=BD=95=E4=B8=AD=E8=BF=90=E8=A1=8C=E4=BB=A5=E4=B8=8B=E5=91=BD=E4=BB=A4=EF= =BC=9A :: =20 - ./script/checktransupdate.py -l zh_CN`` + tools/docs/checktransupdate.py -l zh_CN`` =20 =E8=AF=A5=E5=91=BD=E4=BB=A4=E4=BC=9A=E5=88=97=E5=87=BA=E9=9C=80=E8=A6=81= =E7=BF=BB=E8=AF=91=E6=88=96=E6=9B=B4=E6=96=B0=E7=9A=84=E8=8B=B1=E6=96=87=E6= =96=87=E6=A1=A3=EF=BC=8C=E7=BB=93=E6=9E=9C=E5=90=8C=E6=97=B6=E4=BF=9D=E5=AD= =98=E5=9C=A8 checktransupdate.log =E4=B8=AD=E3=80=82 =20 diff --git a/MAINTAINERS b/MAINTAINERS index 5aa6d769b254..cd187b9f1dc2 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7411,7 +7411,6 @@ S: Maintained P: Documentation/doc-guide/maintainer-profile.rst T: git git://git.lwn.net/linux.git docs-next F: Documentation/ -F: scripts/checktransupdate.py F: scripts/documentation-file-ref-check F: scripts/get_abi.py F: scripts/kernel-doc* diff --git a/scripts/checktransupdate.py b/tools/docs/checktransupdate.py similarity index 97% rename from scripts/checktransupdate.py rename to tools/docs/checktransupdate.py index e39529e46c3d..e894652369a5 100755 --- a/scripts/checktransupdate.py +++ b/tools/docs/checktransupdate.py @@ -9,9 +9,9 @@ commit to find the latest english commit from the translati= on commit differences occur, report the file and commits that need to be updated. =20 The usage is as follows: -- ./scripts/checktransupdate.py -l zh_CN +- tools/docs/checktransupdate.py -l zh_CN This will print all the files that need to be updated or translated in the= zh_CN locale. -- ./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools= /testing-overview.rst +- tools/docs/checktransupdate.py Documentation/translations/zh_CN/dev-tool= s/testing-overview.rst This will only print the status of the specified file. =20 The output is something like: @@ -168,7 +168,7 @@ def check_per_file(file_path): def valid_locales(locale): """Check if the locale is valid or not""" script_path =3D os.path.dirname(os.path.abspath(__file__)) - linux_path =3D os.path.join(script_path, "..") + linux_path =3D os.path.join(script_path, "../..") if not os.path.isdir(f"{linux_path}/Documentation/translations/{locale= }"): raise ArgumentTypeError("Invalid locale: {locale}") return locale @@ -232,7 +232,7 @@ def config_logging(log_level, log_file=3D"checktransupd= ate.log"): def main(): """Main function of the script""" script_path =3D os.path.dirname(os.path.abspath(__file__)) - linux_path =3D os.path.join(script_path, "..") + linux_path =3D os.path.join(script_path, "../..") =20 parser =3D ArgumentParser(description=3D"Check the translation update") parser.add_argument( --=20 2.51.0 From nobody Sun Feb 8 10:33:44 2026 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 6E4ED2E283A; Fri, 24 Oct 2025 20:08:52 +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=1761336533; cv=none; b=RLOjn6z1hFgsjzMbziwoZuSvsIKbHU5uE2si6WacDsJFvAd5lPXBRyYi24yeFpMLu+hhhB0xYjT2ouCyNsubGeDsQyA461rU+wemeHHXsvKIP5B1Xg1IBTj1ySEo2djR3UD6EQO9LgyqIgheT5TiL0Wf+Wcnvi36ccHIQqQoBHo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1761336533; c=relaxed/simple; bh=BJM6rksB/mI3U0nzwLElhOR5H27udwbWSIvyVXTQBeM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=WqjpV3j0cyEmB9vMaYJLfojv2rQLmdIitL2KSXKcDTahJ4+y0uW1zJoXTL8X8N1b3s6gA9tNMuOg5EEWL9GzxfUlXwoe48ycJ45VjRH650onDmjk7ZD0a5z97V51oytnbCbpWy76nc+R1kgh4OhTuM8DoZlL6/4d2+RT1StH2JI= 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=dMJGEN62; 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="dMJGEN62" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net E0A8D40C29 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1761336526; bh=OqcmgG5y5pz2b2qMWeVYfNKx46YGBJkCkE+Pc29vERk=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=dMJGEN62FvaP/mHFS4goEtAV6c9/Hi3Wcgku/ISUAAgQjcetxMXWz6g+E+WSyMxdp UASlaRM91q9zu6/uRXE9Uw9JPzSZ0AuMM+uzwDv5UByLP18MHesBjW4abvtqztuWhP b3gR/H44dusHjHYkLb83r6gb4aGyMPCSlAhn27pP2bvY9ldiU8cQmgZwml5O9VS/nn BCwMMbzISSokqqKTMfxoL6ewd1bTBbOVFP2luhGTP1Xte0sY2hHtxxiG0G2Q9U78+X 9cAoGGU5Ezxu1ki5jJqcP+shQtyAt4QP907rwvc241ujvk0RLEXkf7f+9Mmtplo9wE /li1HY1iTOKqQ== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id E0A8D40C29; Fri, 24 Oct 2025 20:08:45 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Randy Dunlap , Jani Nikula , Jonathan Corbet , Jani Nikula Subject: [PATCH v3 3/8] docs: move scripts/documentation-file-ref-check to tools/docs Date: Fri, 24 Oct 2025 14:08:24 -0600 Message-ID: <20251024200834.20644-4-corbet@lwn.net> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20251024200834.20644-1-corbet@lwn.net> References: <20251024200834.20644-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" Add this script to the growing collection of documentation tools. Acked-by: Jani Nikula Signed-off-by: Jonathan Corbet Reviewed-by: Mauro Carvalho Chehab --- Documentation/Makefile | 4 ++-- MAINTAINERS | 2 -- {scripts =3D> tools/docs}/documentation-file-ref-check | 2 +- tools/docs/sphinx-pre-install | 2 +- 4 files changed, 4 insertions(+), 6 deletions(-) rename {scripts =3D> tools/docs}/documentation-file-ref-check (99%) diff --git a/Documentation/Makefile b/Documentation/Makefile index 65d184eab739..1476aa1701ce 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -8,7 +8,7 @@ subdir- :=3D devicetree/bindings ifneq ($(MAKECMDGOALS),cleandocs) # Check for broken documentation file references ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y) -$(shell $(srctree)/scripts/documentation-file-ref-check --warn) +$(shell $(srctree)/tools/docs/documentation-file-ref-check --warn) endif =20 # Check for broken ABI files @@ -78,7 +78,7 @@ htmldocs-redirects: $(srctree)/Documentation/.renames.txt @tools/docs/gen-redirects.py --output $(BUILDDIR) < $< =20 refcheckdocs: - $(Q)cd $(srctree);scripts/documentation-file-ref-check + $(Q)cd $(srctree); tools/docs/documentation-file-ref-check =20 cleandocs: $(Q)rm -rf $(BUILDDIR) diff --git a/MAINTAINERS b/MAINTAINERS index cd187b9f1dc2..fc1da52433b6 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7411,7 +7411,6 @@ S: Maintained P: Documentation/doc-guide/maintainer-profile.rst T: git git://git.lwn.net/linux.git docs-next F: Documentation/ -F: scripts/documentation-file-ref-check F: scripts/get_abi.py F: scripts/kernel-doc* F: scripts/lib/abi/* @@ -7451,7 +7450,6 @@ M: Mauro Carvalho Chehab L: linux-doc@vger.kernel.org S: Maintained F: Documentation/sphinx/parse-headers.pl -F: scripts/documentation-file-ref-check F: tools/docs/sphinx-pre-install =20 DOCUMENTATION/ITALIAN diff --git a/scripts/documentation-file-ref-check b/tools/docs/documentatio= n-file-ref-check similarity index 99% rename from scripts/documentation-file-ref-check rename to tools/docs/documentation-file-ref-check index 408b1dbe7884..0cad42f6943b 100755 --- a/scripts/documentation-file-ref-check +++ b/tools/docs/documentation-file-ref-check @@ -17,7 +17,7 @@ my %false_positives =3D ( ); =20 my $scriptname =3D $0; -$scriptname =3D~ s,.*/([^/]+/),$1,; +$scriptname =3D~ s,tools/docs/([^/]+/),$1,; =20 # Parse arguments my $help =3D 0; diff --git a/tools/docs/sphinx-pre-install b/tools/docs/sphinx-pre-install index 698989584b6a..647e1f60357f 100755 --- a/tools/docs/sphinx-pre-install +++ b/tools/docs/sphinx-pre-install @@ -313,7 +313,7 @@ class MissingCheckers(AncillaryMethods): Right now, we still need Perl for doc build, as it is required by some tools called at docs or kernel build time, like: =20 - scripts/documentation-file-ref-check + tools/docs/documentation-file-ref-check =20 Also, checkpatch is on Perl. """ --=20 2.51.0 From nobody Sun Feb 8 10:33:44 2026 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 8807A2E6CC4; Fri, 24 Oct 2025 20:08:54 +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=1761336536; cv=none; b=vE0npviofCwILBzyuVhj2JzY5TMJ5xPzGgf8hjdDdPP+8CdS4DY0zTZrijzP48wskfxUNFJ0g59gV+MyOKH6K8JkH+aSkyhiOmMWn9GZU3V3X8ZVmPFJyDcNwzIepxJTiTdxjpvrvggp9LTwNP8Hg+qBmTyz/JceexDMAzocNfc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1761336536; c=relaxed/simple; bh=M67VoMxyAvaa3Q2G2y/IHqN7Ue15OSITp43jSgQUByA=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=kvytzQE24TUshtHvMjVKQ9GgDeNwAzUXM4eAiETBT0ueKqhLx/YwS12XM1I3WoDQo1cRhL12tybZ9CcvwdR7w35Bl5olQO8Z2vjV4SH5EK4Y0b/q+LhqCZ57DMrHHzAmbMVW/c52Strm1dT5vzuruZ93n2k0XgTiflH/vxf3F7U= 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=T87SBZgN; 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="T87SBZgN" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net F064D40C2A DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1761336527; bh=hWt5ftNAvpwXgRb0lngYloq1RnkyCYaqYr1EN/nuY5E=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=T87SBZgND2TSSiFZN3+D6MM/9bT/1oMZR6hxCFRb0RHJKVNDthsXGDXT7AjP89wBd 1d7K6FODGXgqUqPa3Wm76oN1buTcrf/K27q2PmIcK73XaTqCMkH/UMV9EmRwn6frZK 8zwY5/hTcXKtLSP5bQWf4MVxYtA0yG73TcWT3IFsikga3VkwVfVOpQA0dbZSwfMoGF Nlwl0Uqq9N5pLPHn4mkDPoq+LC1H1aWgVqNG4FbWWGgip6gL6Y8ElMGAZOJ94pZ3m0 NXU3mWQ+wcVuJCMhzWcr+kyDSwyZ66kf90j52l8nSzu0GAc3ES3mHoZ54Xng/01bo7 RwSZdt3CAl8gA== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id F064D40C2A; Fri, 24 Oct 2025 20:08:46 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Randy Dunlap , Jani Nikula , Jonathan Corbet , Jani Nikula Subject: [PATCH v3 4/8] docs: move get_abi.py to tools/docs Date: Fri, 24 Oct 2025 14:08:25 -0600 Message-ID: <20251024200834.20644-5-corbet@lwn.net> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20251024200834.20644-1-corbet@lwn.net> References: <20251024200834.20644-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" Move this tool out of scripts/ to join the other documentation tools; fix up a couple of erroneous references in the process. It's worth noting that this script will fail badly unless one has a PYTHONPATH referencing scripts/lib/abi. Acked-by: Jani Nikula Signed-off-by: Jonathan Corbet Reviewed-by: Mauro Carvalho Chehab --- Documentation/Kconfig | 2 +- Documentation/Makefile | 2 +- Documentation/sphinx/kernel_abi.py | 2 +- MAINTAINERS | 1 - {scripts =3D> tools/docs}/get_abi.py | 0 5 files changed, 3 insertions(+), 4 deletions(-) rename {scripts =3D> tools/docs}/get_abi.py (100%) diff --git a/Documentation/Kconfig b/Documentation/Kconfig index 3a0e7ac0c4e3..8b6c4b84b218 100644 --- a/Documentation/Kconfig +++ b/Documentation/Kconfig @@ -19,7 +19,7 @@ config WARN_ABI_ERRORS described at Documentation/ABI/README. Yet, as they're manually written, it would be possible that some of those files would have errors that would break them for being parsed by - scripts/get_abi.pl. Add a check to verify them. + tools/docs/get_abi.py. Add a check to verify them. =20 If unsure, select 'N'. =20 diff --git a/Documentation/Makefile b/Documentation/Makefile index 1476aa1701ce..734ec9c9a62c 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -13,7 +13,7 @@ endif =20 # Check for broken ABI files ifeq ($(CONFIG_WARN_ABI_ERRORS),y) -$(shell $(srctree)/scripts/get_abi.py --dir $(srctree)/Documentation/ABI v= alidate) +$(shell $(srctree)/tools/docs/get_abi.py --dir $(srctree)/Documentation/AB= I validate) endif endif =20 diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kern= el_abi.py index 4c4375201b9e..32e39fb8bc3b 100644 --- a/Documentation/sphinx/kernel_abi.py +++ b/Documentation/sphinx/kernel_abi.py @@ -14,7 +14,7 @@ :license: GPL Version 2, June 1991 see Linux/COPYING for details. =20 The ``kernel-abi`` (:py:class:`KernelCmd`) directive calls the - scripts/get_abi.py script to parse the Kernel ABI files. + AbiParser class to parse the Kernel ABI files. =20 Overview of directive's argument and options. =20 diff --git a/MAINTAINERS b/MAINTAINERS index fc1da52433b6..5c632cd3902c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7411,7 +7411,6 @@ S: Maintained P: Documentation/doc-guide/maintainer-profile.rst T: git git://git.lwn.net/linux.git docs-next F: Documentation/ -F: scripts/get_abi.py F: scripts/kernel-doc* F: scripts/lib/abi/* F: scripts/lib/kdoc/* diff --git a/scripts/get_abi.py b/tools/docs/get_abi.py similarity index 100% rename from scripts/get_abi.py rename to tools/docs/get_abi.py --=20 2.51.0 From nobody Sun Feb 8 10:33:44 2026 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 9E3EA2E2EF0; Fri, 24 Oct 2025 20:08:52 +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=1761336534; cv=none; b=WDyr0rnwIHdVDwrp2eh0f5GwLh2gfkBfZjtaHlotmCWDKV54IUFuU4dTVj9MCg5hN9BHzNJhP1lRKAauoMLtFv8IK7iUf/tgdBrAv/0L5B+E0Jl6eWJ+XAw0Af8u9uEmZ06mwLCz1VlN//UZT3UqKO2q+AQrYE8BzhiiYSFUGhA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1761336534; c=relaxed/simple; bh=qP9TR29vJ1KHeNs7La7g0B76CsfqLiT09uHO+4H2JWE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=h+pRxQzci9xaTLe+EniukR/9XDNKX1NKBJu1KnrOsNHwZRvlOI80HGcVCSiUoVOrS7/0FcFe4PCXF6q7Dx1J+xp8wdlbCRRQcT7fl/cCX1CKxWpzu4n00a0ztj2B0uM9N5bDj1ellg2dZzTvcuxqyUQWh9Tl3VIdylGIMPmIxZk= 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=G1bm2Oqk; 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="G1bm2Oqk" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 023BA40C2D DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1761336528; bh=OgfcJ4EgrQ+jyCcgSBx3PMKEUJYag0qgM4FJM9RfeAk=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=G1bm2OqkCg/fjPK375ui2GZCzBWWlgE74cc5mJ0T9uAfR10SeOUWd3ImyptaZpwvi E56rUrtkJATK8PIMi0L8b9GZ8gK5qfd7muIPO2xj7YRiRoqr5pseLIAJLpsyZ4FcjP SbNCgfjlFc5PAMgwBXPh5ez3WhZubth6Ws7NC3C0gfVMqkckgUm0U1H/vY8OePmZR2 FcIaShmlw7qpek6tAULoNBHp1O0Jc+BOZAJjsMzNlhW4SMtjjyPEGB6YQYlKxixWdI RxV4kxvmFfF6n6Cge6Es1c2r+e1c/fDQvF5AIGF6AH+z4HJmTbg1gZO9dG8Ow6cHPM s78sMwwEQRj7g== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id 023BA40C2D; Fri, 24 Oct 2025 20:08:47 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Randy Dunlap , Jani Nikula , Jonathan Corbet , Jani Nikula Subject: [PATCH v3 5/8] docs: move test_doc_build.py to tools/docs Date: Fri, 24 Oct 2025 14:08:26 -0600 Message-ID: <20251024200834.20644-6-corbet@lwn.net> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20251024200834.20644-1-corbet@lwn.net> References: <20251024200834.20644-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" Add this tool to tools/docs. Acked-by: Jani Nikula Signed-off-by: Jonathan Corbet Reviewed-by: Mauro Carvalho Chehab --- Documentation/doc-guide/sphinx.rst | 2 +- {scripts =3D> tools/docs}/test_doc_build.py | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename {scripts =3D> tools/docs}/test_doc_build.py (100%) diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/s= phinx.rst index 932f68c53075..51c370260f3b 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -149,7 +149,7 @@ a venv with it with, and install minimal requirements w= ith:: =20 A more comprehensive test can be done by using: =20 - scripts/test_doc_build.py + tools/docs/test_doc_build.py =20 Such script create one Python venv per supported version, optionally building documentation for a range of Sphinx versions. diff --git a/scripts/test_doc_build.py b/tools/docs/test_doc_build.py similarity index 100% rename from scripts/test_doc_build.py rename to tools/docs/test_doc_build.py --=20 2.51.0 From nobody Sun Feb 8 10:33:44 2026 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 A0E332E2EF3; Fri, 24 Oct 2025 20:08:52 +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=1761336534; cv=none; b=dAMFSSxwArT8JDaljKuKxnbfi77cmZF0nvk6lDM6B3OrZ0YtKjvuwunEi3zI8ZPZYX637rtENX9QslMgcsUR09TiZL/IfRBSU6DRj/F7Q3caELdgGxB1/nT2EcXAJTlL3poOW41I4BhTV5VpbO2qCJPXZJkveGWsjq+n1STPin0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1761336534; c=relaxed/simple; bh=EqGUkjNKW6nMqFCJpeeuYHEVpAAPp9UlGnZujXzLUQY=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=HakCdjDodyRWNwh55rr7gg/XCpZ3WDf6tQ2QumrcJIEaDZKMdk/6I5Tdoa45xgP1Ah+wmI3IfG0v81ZvDNAz+50h3vmX00MvOZS/Gs8N3gtfBTsJLXgY01mMNwoDGvAE9v87SLOXS6mEBLpI9HxHqN6jGZnszZUSCyvmP2dyRZk= 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=pc94/88w; 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="pc94/88w" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 2D33640C2E DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1761336529; bh=lXwC0bJdgB+byVdwujLIgSYwEHccv9FjWa8Zlkst3b0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=pc94/88wYRAyzBS5wKwuyLkI3GeuvuCoR16/7JM/W8AePo5fhEx9typz5/h4ZPke7 tmwBLMKaIvkxc3t7waY6OQnJvou2FTv+ESlpPUzrqWPMOdL676saat1FMs6HtXXKSY CUyz03z2vi01hXLf9eP2AYTQaPIYkVx/Egj87SW2v4SP7ho6dg5VUe1ARG12DhT3AP n+gYi6BKmrC68DYeHH8cXrlaLd2AWvpokz4IEVRABLl5y/6AaE4lQXUc+U7cV+kTqW rTZygxa9bSeEPJuF/MkfdcVSfb/LOYRlxxGCIeQWyL5Lcbdg9GxIYo/IEiwhQb4PJL 3bVXkslcRoeRw== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id 2D33640C2E; Fri, 24 Oct 2025 20:08:49 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Randy Dunlap , Jani Nikula , Jonathan Corbet , Jani Nikula Subject: [PATCH v3 6/8] docs: move kernel-doc to tools/docs Date: Fri, 24 Oct 2025 14:08:27 -0600 Message-ID: <20251024200834.20644-7-corbet@lwn.net> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20251024200834.20644-1-corbet@lwn.net> References: <20251024200834.20644-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-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Move kernel-doc to join the rest of the tools, and update references throughout the tree. Acked-by: Jani Nikula Signed-off-by: Jonathan Corbet Reviewed-by: Mauro Carvalho Chehab --- Documentation/conf.py | 2 +- Documentation/doc-guide/kernel-doc.rst | 6 +++--- Documentation/kbuild/kbuild.rst | 2 +- Documentation/process/coding-style.rst | 2 +- .../translations/it_IT/doc-guide/kernel-doc.rst | 8 ++++---- .../translations/sp_SP/process/coding-style.rst | 2 +- .../translations/zh_CN/doc-guide/kernel-doc.rst | 10 +++++----- Documentation/translations/zh_CN/kbuild/kbuild.rst | 2 +- .../translations/zh_CN/process/coding-style.rst | 2 +- .../translations/zh_TW/process/coding-style.rst | 2 +- MAINTAINERS | 1 - Makefile | 2 +- drivers/gpu/drm/i915/Makefile | 2 +- scripts/find-unused-docs.sh | 2 +- scripts/kernel-doc | 1 - scripts/kernel-doc.py =3D> tools/docs/kernel-doc | 0 16 files changed, 22 insertions(+), 24 deletions(-) delete mode 120000 scripts/kernel-doc rename scripts/kernel-doc.py =3D> tools/docs/kernel-doc (100%) diff --git a/Documentation/conf.py b/Documentation/conf.py index 1ea2ae5c6276..8e3df5db858e 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -582,7 +582,7 @@ pdf_documents =3D [ # kernel-doc extension configuration for running Sphinx directly (e.g. by = Read # the Docs). In a normal build, these are supplied from the Makefile via c= ommand # line arguments. -kerneldoc_bin =3D "../scripts/kernel-doc.py" +kerneldoc_bin =3D "../tools/docs/kernel-doc.py" kerneldoc_srctree =3D ".." =20 def setup(app): diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-gui= de/kernel-doc.rst index 4370cc8fbcf5..d754d52bee8c 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -54,7 +54,7 @@ Running the ``kernel-doc`` tool with increased verbosity = and without actual output generation may be used to verify proper formatting of the documentation comments. For example:: =20 - scripts/kernel-doc -v -none drivers/foo/bar.c + tools/docs/kernel-doc -v -none drivers/foo/bar.c =20 The documentation format is verified by the kernel build when it is requested to perform extra gcc checks:: @@ -349,7 +349,7 @@ differentiated by whether the macro name is immediately= followed by a left parenthesis ('(') for function-like macros or not followed by one for object-like macros. =20 -Function-like macros are handled like functions by ``scripts/kernel-doc``. +Function-like macros are handled like functions by ``tools/docs/kernel-doc= ``. They may have a parameter list. Object-like macros have do not have a parameter list. =20 @@ -571,7 +571,7 @@ from the source file. =20 The kernel-doc extension is included in the kernel source tree, at ``Documentation/sphinx/kerneldoc.py``. Internally, it uses the -``scripts/kernel-doc`` script to extract the documentation comments from t= he +``tools/docs/kernel-doc`` script to extract the documentation comments fro= m the source. =20 .. _kernel_doc: diff --git a/Documentation/kbuild/kbuild.rst b/Documentation/kbuild/kbuild.= rst index 3388a10f2dcc..32840878adbd 100644 --- a/Documentation/kbuild/kbuild.rst +++ b/Documentation/kbuild/kbuild.rst @@ -180,7 +180,7 @@ architecture. KDOCFLAGS --------- Specify extra (warning/error) flags for kernel-doc checks during the build, -see scripts/kernel-doc for which flags are supported. Note that this doesn= 't +see tools/docs/kernel-doc for which flags are supported. Note that this do= esn't (currently) apply to documentation builds. =20 ARCH diff --git a/Documentation/process/coding-style.rst b/Documentation/process= /coding-style.rst index d1a8e5465ed9..531ae288f3c3 100644 --- a/Documentation/process/coding-style.rst +++ b/Documentation/process/coding-style.rst @@ -614,7 +614,7 @@ it. =20 When commenting the kernel API functions, please use the kernel-doc format. See the files at :ref:`Documentation/doc-guide/ ` and -``scripts/kernel-doc`` for details. Note that the danger of over-commenting +``tools/docs/kernel-doc`` for details. Note that the danger of over-commen= ting applies to kernel-doc comments all the same. Do not add boilerplate kernel-doc which simply reiterates what's obvious from the signature of the function. diff --git a/Documentation/translations/it_IT/doc-guide/kernel-doc.rst b/Do= cumentation/translations/it_IT/doc-guide/kernel-doc.rst index aa0e31d353d6..bac959b8b7b9 100644 --- a/Documentation/translations/it_IT/doc-guide/kernel-doc.rst +++ b/Documentation/translations/it_IT/doc-guide/kernel-doc.rst @@ -80,7 +80,7 @@ Al fine di verificare che i commenti siano formattati cor= rettamente, potete eseguire il programma ``kernel-doc`` con un livello di verbosit=C3=A0 alto= e senza che questo produca alcuna documentazione. Per esempio:: =20 - scripts/kernel-doc -v -none drivers/foo/bar.c + tools/docs/kernel-doc -v -none drivers/foo/bar.c =20 Il formato della documentazione =C3=A8 verificato della procedura di gener= azione del kernel quando viene richiesto di effettuare dei controlli extra con GC= C:: @@ -378,7 +378,7 @@ distinguono in base al fatto che il nome della macro si= mile a funzione sia immediatamente seguito da una parentesi sinistra ('(') mentre in quelle si= mili a oggetti no. =20 -Le macro simili a funzioni sono gestite come funzioni da ``scripts/kernel-= doc``. +Le macro simili a funzioni sono gestite come funzioni da ``tools/docs/kern= el-doc``. Possono avere un elenco di parametri. Le macro simili a oggetti non hanno = un elenco di parametri. =20 @@ -595,7 +595,7 @@ documentazione presenti nel file sorgente (*source*). =20 L'estensione kernel-doc fa parte dei sorgenti del kernel, la si pu=C3=B2 t= rovare in ``Documentation/sphinx/kerneldoc.py``. Internamente, viene utilizzato -lo script ``scripts/kernel-doc`` per estrarre i commenti di documentazione +lo script ``tools/docs/kernel-doc`` per estrarre i commenti di documentazi= one dai file sorgenti. =20 Come utilizzare kernel-doc per generare pagine man @@ -604,4 +604,4 @@ Come utilizzare kernel-doc per generare pagine man Se volete utilizzare kernel-doc solo per generare delle pagine man, potete farlo direttamente dai sorgenti del kernel:: =20 - $ scripts/kernel-doc -man $(git grep -l '/\*\*' -- :^Documentation :^too= ls) | scripts/split-man.pl /tmp/man + $ tools/docs/kernel-doc -man $(git grep -l '/\*\*' -- :^Documentation :^= tools) | scripts/split-man.pl /tmp/man diff --git a/Documentation/translations/sp_SP/process/coding-style.rst b/Do= cumentation/translations/sp_SP/process/coding-style.rst index 025223be9706..7d63aa8426e6 100644 --- a/Documentation/translations/sp_SP/process/coding-style.rst +++ b/Documentation/translations/sp_SP/process/coding-style.rst @@ -633,7 +633,7 @@ posiblemente POR QU=C3=89 hace esto. =20 Al comentar las funciones de la API del kernel, utilice el formato kernel-doc. Consulte los archivos en :ref:`Documentation/doc-guide/ ` -y ``scripts/kernel-doc`` para m=C3=A1s detalles. +y ``tools/docs/kernel-doc`` para m=C3=A1s detalles. =20 El estilo preferido para comentarios largos (de varias l=C3=ADneas) es: =20 diff --git a/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst b/Do= cumentation/translations/zh_CN/doc-guide/kernel-doc.rst index ccfb9b8329c2..fb2bbaaa85c1 100644 --- a/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst +++ b/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst @@ -43,7 +43,7 @@ kernel-doc=E6=B3=A8=E9=87=8A=E7=94=A8 ``/**`` =E4=BD=9C= =E4=B8=BA=E5=BC=80=E5=A7=8B=E6=A0=87=E8=AE=B0=E3=80=82 ``kernel-doc`` =E5= =B7=A5=E5=85=B7=E5=B0=86=E6=8F=90=E5=8F=96 =E7=94=A8=E8=AF=A6=E7=BB=86=E6=A8=A1=E5=BC=8F=E5=92=8C=E4=B8=8D=E7=94=9F= =E6=88=90=E5=AE=9E=E9=99=85=E8=BE=93=E5=87=BA=E6=9D=A5=E8=BF=90=E8=A1=8C ``= kernel-doc`` =E5=B7=A5=E5=85=B7=EF=BC=8C=E5=8F=AF=E4=BB=A5=E9=AA=8C=E8=AF= =81=E6=96=87=E6=A1=A3=E6=B3=A8=E9=87=8A=E7=9A=84=E6=A0=BC=E5=BC=8F =E6=98=AF=E5=90=A6=E6=AD=A3=E7=A1=AE=E3=80=82=E4=BE=8B=E5=A6=82:: =20 - scripts/kernel-doc -v -none drivers/foo/bar.c + tools/docs/kernel-doc -v -none drivers/foo/bar.c =20 =E5=BD=93=E8=AF=B7=E6=B1=82=E6=89=A7=E8=A1=8C=E9=A2=9D=E5=A4=96=E7=9A=84gc= c=E6=A3=80=E6=9F=A5=E6=97=B6=EF=BC=8C=E5=86=85=E6=A0=B8=E6=9E=84=E5=BB=BA= =E5=B0=86=E9=AA=8C=E8=AF=81=E6=96=87=E6=A1=A3=E6=A0=BC=E5=BC=8F:: =20 @@ -473,7 +473,7 @@ doc: *title* =E5=A6=82=E6=9E=9C=E6=B2=A1=E6=9C=89=E9=80=89=E9=A1=B9=EF=BC=8Ckernel-doc= =E6=8C=87=E4=BB=A4=E5=B0=86=E5=8C=85=E5=90=AB=E6=BA=90=E6=96=87=E4=BB=B6=E4= =B8=AD=E7=9A=84=E6=89=80=E6=9C=89=E6=96=87=E6=A1=A3=E6=B3=A8=E9=87=8A=E3=80= =82 =20 kernel-doc=E6=89=A9=E5=B1=95=E5=8C=85=E5=90=AB=E5=9C=A8=E5=86=85=E6=A0=B8= =E6=BA=90=E4=BB=A3=E7=A0=81=E6=A0=91=E4=B8=AD=EF=BC=8C=E4=BD=8D=E4=BA=8E ``= Documentation/sphinx/kerneldoc.py`` =E3=80=82 -=E5=9C=A8=E5=86=85=E9=83=A8=EF=BC=8C=E5=AE=83=E4=BD=BF=E7=94=A8 ``scripts/= kernel-doc`` =E8=84=9A=E6=9C=AC=E4=BB=8E=E6=BA=90=E4=BB=A3=E7=A0=81=E4=B8= =AD=E6=8F=90=E5=8F=96=E6=96=87=E6=A1=A3=E6=B3=A8=E9=87=8A=E3=80=82 +=E5=9C=A8=E5=86=85=E9=83=A8=EF=BC=8C=E5=AE=83=E4=BD=BF=E7=94=A8 ``tools/do= cs/kernel-doc`` =E8=84=9A=E6=9C=AC=E4=BB=8E=E6=BA=90=E4=BB=A3=E7=A0=81=E4= =B8=AD=E6=8F=90=E5=8F=96=E6=96=87=E6=A1=A3=E6=B3=A8=E9=87=8A=E3=80=82 =20 .. _kernel_doc_zh: =20 @@ -482,18 +482,18 @@ kernel-doc=E6=89=A9=E5=B1=95=E5=8C=85=E5=90=AB=E5=9C= =A8=E5=86=85=E6=A0=B8=E6=BA=90=E4=BB=A3=E7=A0=81=E6=A0=91=E4=B8=AD=EF=BC=8C= =E4=BD=8D=E4=BA=8E ``Documentation/sphinx/k =20 =E5=A6=82=E6=9E=9C=E6=82=A8=E5=8F=AA=E6=83=B3=E4=BD=BF=E7=94=A8kernel-doc= =E7=94=9F=E6=88=90=E6=89=8B=E5=86=8C=E9=A1=B5=EF=BC=8C=E5=8F=AF=E4=BB=A5=E4= =BB=8E=E5=86=85=E6=A0=B8git=E6=A0=91=E8=BF=99=E6=A0=B7=E5=81=9A:: =20 - $ scripts/kernel-doc -man \ + $ tools/docs/kernel-doc -man \ $(git grep -l '/\*\*' -- :^Documentation :^tools) \ | scripts/split-man.pl /tmp/man =20 =E4=B8=80=E4=BA=9B=E6=97=A7=E7=89=88=E6=9C=AC=E7=9A=84git=E4=B8=8D=E6=94= =AF=E6=8C=81=E8=B7=AF=E5=BE=84=E6=8E=92=E9=99=A4=E8=AF=AD=E6=B3=95=E7=9A=84= =E6=9F=90=E4=BA=9B=E5=8F=98=E4=BD=93=E3=80=82 =E4=BB=A5=E4=B8=8B=E5=91=BD=E4=BB=A4=E4=B9=8B=E4=B8=80=E5=8F=AF=E8=83=BD= =E9=80=82=E7=94=A8=E4=BA=8E=E8=BF=99=E4=BA=9B=E7=89=88=E6=9C=AC:: =20 - $ scripts/kernel-doc -man \ + $ tools/docs/kernel-doc -man \ $(git grep -l '/\*\*' -- . ':!Documentation' ':!tools') \ | scripts/split-man.pl /tmp/man =20 - $ scripts/kernel-doc -man \ + $ tools/docs/kernel-doc -man \ $(git grep -l '/\*\*' -- . ":(exclude)Documentation" ":(exclude)tools"= ) \ | scripts/split-man.pl /tmp/man =20 diff --git a/Documentation/translations/zh_CN/kbuild/kbuild.rst b/Documenta= tion/translations/zh_CN/kbuild/kbuild.rst index e5e2aebe1ebc..9c7062b65a99 100644 --- a/Documentation/translations/zh_CN/kbuild/kbuild.rst +++ b/Documentation/translations/zh_CN/kbuild/kbuild.rst @@ -158,7 +158,7 @@ UTS_MACHINE =E5=8F=98=E9=87=8F=EF=BC=88=E5=9C=A8=E6=9F= =90=E4=BA=9B=E6=9E=B6=E6=9E=84=E4=B8=AD=E8=BF=98=E5=8C=85=E6=8B=AC=E5=86=85= =E6=A0=B8=E9=85=8D=E7=BD=AE=EF=BC=89=E6=9D=A5=E7=8C=9C=E6=B5=8B=E6=AD=A3=E7= =A1=AE KDOCFLAGS --------- =E6=8C=87=E5=AE=9A=E5=9C=A8=E6=9E=84=E5=BB=BA=E8=BF=87=E7=A8=8B=E4=B8=AD= =E7=94=A8=E4=BA=8E kernel-doc =E6=A3=80=E6=9F=A5=E7=9A=84=E9=A2=9D=E5=A4=96= =EF=BC=88=E8=AD=A6=E5=91=8A/=E9=94=99=E8=AF=AF=EF=BC=89=E6=A0=87=E5=BF=97= =EF=BC=8C=E6=9F=A5=E7=9C=8B -scripts/kernel-doc =E4=BA=86=E8=A7=A3=E6=94=AF=E6=8C=81=E7=9A=84=E6=A0=87= =E5=BF=97=E3=80=82=E8=AF=B7=E6=B3=A8=E6=84=8F=EF=BC=8C=E8=BF=99=E7=9B=AE=E5= =89=8D=E4=B8=8D=E9=80=82=E7=94=A8=E4=BA=8E=E6=96=87=E6=A1=A3=E6=9E=84=E5=BB= =BA=E3=80=82 +tools/docs/kernel-doc =E4=BA=86=E8=A7=A3=E6=94=AF=E6=8C=81=E7=9A=84=E6=A0= =87=E5=BF=97=E3=80=82=E8=AF=B7=E6=B3=A8=E6=84=8F=EF=BC=8C=E8=BF=99=E7=9B=AE= =E5=89=8D=E4=B8=8D=E9=80=82=E7=94=A8=E4=BA=8E=E6=96=87=E6=A1=A3=E6=9E=84=E5= =BB=BA=E3=80=82 =20 ARCH ---- diff --git a/Documentation/translations/zh_CN/process/coding-style.rst b/Do= cumentation/translations/zh_CN/process/coding-style.rst index 0484d0c65c25..5a342a024c01 100644 --- a/Documentation/translations/zh_CN/process/coding-style.rst +++ b/Documentation/translations/zh_CN/process/coding-style.rst @@ -545,7 +545,7 @@ Linux =E9=87=8C=E8=BF=99=E6=98=AF=E6=8F=90=E5=80=A1=E7= =9A=84=E5=81=9A=E6=B3=95=EF=BC=8C=E5=9B=A0=E4=B8=BA=E8=BF=99=E6=A0=B7=E5=8F= =AF=E4=BB=A5=E5=BE=88=E7=AE=80=E5=8D=95=E7=9A=84=E7=BB=99=E8=AF=BB=E8=80=85= =E6=8F=90=E4=BE=9B =E4=B9=9F=E5=8F=AF=E4=BB=A5=E5=8A=A0=E4=B8=8A=E5=AE=83=E5=81=9A=E8=BF=99= =E4=BA=9B=E4=BA=8B=E6=83=85=E7=9A=84=E5=8E=9F=E5=9B=A0=E3=80=82 =20 =E5=BD=93=E6=B3=A8=E9=87=8A=E5=86=85=E6=A0=B8 API =E5=87=BD=E6=95=B0=E6=97= =B6=EF=BC=8C=E8=AF=B7=E4=BD=BF=E7=94=A8 kernel-doc =E6=A0=BC=E5=BC=8F=E3=80= =82=E8=AF=A6=E8=A7=81 -Documentation/translations/zh_CN/doc-guide/index.rst =E5=92=8C scripts/ker= nel-doc =E3=80=82 +Documentation/translations/zh_CN/doc-guide/index.rst =E5=92=8C tools/docs/= kernel-doc =E3=80=82 =20 =E9=95=BF (=E5=A4=9A=E8=A1=8C) =E6=B3=A8=E9=87=8A=E7=9A=84=E9=A6=96=E9=80= =89=E9=A3=8E=E6=A0=BC=E6=98=AF=EF=BC=9A =20 diff --git a/Documentation/translations/zh_TW/process/coding-style.rst b/Do= cumentation/translations/zh_TW/process/coding-style.rst index 311c6f6bad0b..e2ba97b3d8bb 100644 --- a/Documentation/translations/zh_TW/process/coding-style.rst +++ b/Documentation/translations/zh_TW/process/coding-style.rst @@ -548,7 +548,7 @@ Linux =E8=A3=8F=E9=80=99=E6=98=AF=E6=8F=90=E5=80=A1=E7= =9A=84=E5=81=9A=E6=B3=95=EF=BC=8C=E5=9B=A0=E7=88=B2=E9=80=99=E6=A8=A3=E5=8F= =AF=E4=BB=A5=E5=BE=88=E7=B0=A1=E5=96=AE=E7=9A=84=E7=B5=A6=E8=AE=80=E8=80=85= =E6=8F=90=E4=BE=9B =E4=B9=9F=E5=8F=AF=E4=BB=A5=E5=8A=A0=E4=B8=8A=E5=AE=83=E5=81=9A=E9=80=99= =E4=BA=9B=E4=BA=8B=E6=83=85=E7=9A=84=E5=8E=9F=E5=9B=A0=E3=80=82 =20 =E7=95=B6=E8=A8=BB=E9=87=8B=E5=85=A7=E6=A0=B8 API =E5=87=BD=E6=95=B8=E6=99= =82=EF=BC=8C=E8=AB=8B=E4=BD=BF=E7=94=A8 kernel-doc =E6=A0=BC=E5=BC=8F=E3=80= =82=E8=A9=B3=E8=A6=8B -Documentation/translations/zh_CN/doc-guide/index.rst =E5=92=8C scripts/ker= nel-doc =E3=80=82 +Documentation/translations/zh_CN/doc-guide/index.rst =E5=92=8C tools/docs/= kernel-doc =E3=80=82 =20 =E9=95=B7 (=E5=A4=9A=E8=A1=8C) =E8=A8=BB=E9=87=8B=E7=9A=84=E9=A6=96=E9=81= =B8=E9=A2=A8=E6=A0=BC=E6=98=AF=EF=BC=9A =20 diff --git a/MAINTAINERS b/MAINTAINERS index 5c632cd3902c..3bd5a0647e94 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7411,7 +7411,6 @@ S: Maintained P: Documentation/doc-guide/maintainer-profile.rst T: git git://git.lwn.net/linux.git docs-next F: Documentation/ -F: scripts/kernel-doc* F: scripts/lib/abi/* F: scripts/lib/kdoc/* F: tools/docs/* diff --git a/Makefile b/Makefile index 9ce6f6f52ea8..d6ff0af5cca6 100644 --- a/Makefile +++ b/Makefile @@ -460,7 +460,7 @@ HOSTPKG_CONFIG =3D pkg-config =20 # the KERNELDOC macro needs to be exported, as scripts/Makefile.build # has a logic to call it -KERNELDOC =3D $(srctree)/scripts/kernel-doc.py +KERNELDOC =3D $(srctree)/tools/docs/kernel-doc.py export KERNELDOC =20 KBUILD_USERHOSTCFLAGS :=3D -Wall -Wmissing-prototypes -Wstrict-prototypes \ diff --git a/drivers/gpu/drm/i915/Makefile b/drivers/gpu/drm/i915/Makefile index e58c0c158b3a..4a339ffac9f3 100644 --- a/drivers/gpu/drm/i915/Makefile +++ b/drivers/gpu/drm/i915/Makefile @@ -428,7 +428,7 @@ always-$(CONFIG_DRM_I915_WERROR) +=3D \ =20 quiet_cmd_hdrtest =3D HDRTEST $(patsubst %.hdrtest,%.h,$@) cmd_hdrtest =3D $(CC) $(filter-out $(CFLAGS_GCOV), $(c_flags)) -S -o= /dev/null -x c /dev/null -include $<; \ - $(srctree)/scripts/kernel-doc -none -Werror $<; touch $@ + $(srctree)/tools/docs/kernel-doc -none -Werror $<; touch $@ =20 $(obj)/%.hdrtest: $(src)/%.h FORCE $(call if_changed_dep,hdrtest) diff --git a/scripts/find-unused-docs.sh b/scripts/find-unused-docs.sh index d6d397fbf917..1fb265a0ffd0 100755 --- a/scripts/find-unused-docs.sh +++ b/scripts/find-unused-docs.sh @@ -54,7 +54,7 @@ for file in `find $1 -name '*.c'`; do if [[ ${FILES_INCLUDED[$file]+_} ]]; then continue; fi - str=3D$(PYTHONDONTWRITEBYTECODE=3D1 scripts/kernel-doc -export "$file" 2>= /dev/null) + str=3D$(PYTHONDONTWRITEBYTECODE=3D1 tools/docs/kernel-doc -export "$file"= 2>/dev/null) if [[ -n "$str" ]]; then echo "$file" fi diff --git a/scripts/kernel-doc b/scripts/kernel-doc deleted file mode 120000 index 3b6ef807791a..000000000000 --- a/scripts/kernel-doc +++ /dev/null @@ -1 +0,0 @@ -kernel-doc.py \ No newline at end of file diff --git a/scripts/kernel-doc.py b/tools/docs/kernel-doc similarity index 100% rename from scripts/kernel-doc.py rename to tools/docs/kernel-doc --=20 2.51.0 From nobody Sun Feb 8 10:33:44 2026 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 CFAD02E5B1E; Fri, 24 Oct 2025 20:08:53 +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=1761336535; cv=none; b=g4kdCgmgsF9SrveKcjATE1gJbPnWKZSFPgQOteCE2zb3AMEJsY2C5RB5lcbrn9lV9TCuozc8EIza7f82aYoq1bB0T/YyBSuLJ4G1jkW2MZkS8X+3To5n6ECpyYMe3E2oKwZILfb5sH1uPoDLWohIE6LlVpAJDrHKdnrVJb7Md8E= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1761336535; c=relaxed/simple; bh=DkmdZD03tEDIYPmuNfn8kM14uyxWg/1xf0rJpDrJAZE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=NnZwE31ZaPo5s9Y5lu3ETRm6eML+Ip+BdxwKvFi65c9lmJDxkbOlxvHfESE2Ile/343E5TIWOEPT6UqHHRbOXn6wf5mo26cOKZvRNK0qFNL8e1hHsW2u8gwnD3knH+bVEVGqNJtqLWSYqFE7+bEGX5pblniS0tndhmtTwg+Wx0g= 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=swkkFI9P; 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="swkkFI9P" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 04FC440C2F DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1761336530; bh=SLXXvISie5635KSpolRaPdQrJTUSoEUf5MVXYGYQ9bg=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=swkkFI9PgR7iDm1m/zsmRbv8CrrY+JnJ9YybXTy4nUVVU63SdUC0gWl4GY2tfsif0 /6rZYMd7lGnionuxYX2COxgbJDMsBOh/IBzRmwLb1CvQiIu4Tuh3BKm94yqyGh837s o1zQfrcj1Zfmt4McfrTcPMmuxQobo2/sPjdhDrnO0vxpcUu/x+2hysyrCDFIC6gh4O nLnHF09J1UD81o8QP9xUIJbeHeqdNS1WIEFlpSLni3rtgpsrYRZyNzvo3NaY8EgiC4 7UYDvXDKLPP9q/QXPR9mf4w8PkO8L8PPwoJkhYHYllU8MQ4d0QJ3waaIZhiYKnRUPI E2orZjmfUkQYQ== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id 04FC440C2F; Fri, 24 Oct 2025 20:08:49 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Randy Dunlap , Jani Nikula , Jonathan Corbet , Jani Nikula Subject: [PATCH v3 7/8] docs: move find-unused-docs.sh to tools/docs Date: Fri, 24 Oct 2025 14:08:28 -0600 Message-ID: <20251024200834.20644-8-corbet@lwn.net> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20251024200834.20644-1-corbet@lwn.net> References: <20251024200834.20644-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-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable ...and update references accordingly. Acked-by: Jani Nikula Signed-off-by: Jonathan Corbet Reviewed-by: Mauro Carvalho Chehab --- Documentation/doc-guide/contributing.rst | 2 +- Documentation/translations/zh_CN/doc-guide/contributing.rst | 2 +- {scripts =3D> tools/docs}/find-unused-docs.sh | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) rename {scripts =3D> tools/docs}/find-unused-docs.sh (85%) diff --git a/Documentation/doc-guide/contributing.rst b/Documentation/doc-g= uide/contributing.rst index 662c7a840cd5..f8047e633113 100644 --- a/Documentation/doc-guide/contributing.rst +++ b/Documentation/doc-guide/contributing.rst @@ -152,7 +152,7 @@ generate links to that documentation. Adding ``kernel-= doc`` directives to the documentation to bring those comments in can help the community derive the full value of the work that has gone into creating them. =20 -The ``scripts/find-unused-docs.sh`` tool can be used to find these +The ``tools/docs/find-unused-docs.sh`` tool can be used to find these overlooked comments. =20 Note that the most value comes from pulling in the documentation for diff --git a/Documentation/translations/zh_CN/doc-guide/contributing.rst b/= Documentation/translations/zh_CN/doc-guide/contributing.rst index 394a13b438b0..b0c8ba782b16 100644 --- a/Documentation/translations/zh_CN/doc-guide/contributing.rst +++ b/Documentation/translations/zh_CN/doc-guide/contributing.rst @@ -124,7 +124,7 @@ C=E4=BB=A3=E7=A0=81=E7=BC=96=E8=AF=91=E5=99=A8=E5=8F=91= =E5=87=BA=E7=9A=84=E8=AD=A6=E5=91=8A=E5=B8=B8=E5=B8=B8=E4=BC=9A=E8=A2=AB=E8= =A7=86=E4=B8=BA=E8=AF=AF=E6=8A=A5=EF=BC=8C=E4=BB=8E=E8=80=8C=E5=AF=BC=E8=87= =B4=E5=87=BA=E7=8E=B0=E4=BA=86 =E8=BF=99=E4=BD=BF=E5=BE=97=E8=BF=99=E4=BA=9B=E4=BF=A1=E6=81=AF=E6=9B=B4= =E9=9A=BE=E6=89=BE=E5=88=B0=EF=BC=8C=E4=BE=8B=E5=A6=82=E4=BD=BFSphinx=E6=97= =A0=E6=B3=95=E7=94=9F=E6=88=90=E6=8C=87=E5=90=91=E8=AF=A5=E6=96=87=E6=A1=A3= =E7=9A=84=E9=93=BE=E6=8E=A5=E3=80=82=E5=B0=86 ``kernel-doc`` =E6=8C=87=E4=BB=A4=E6=B7=BB=E5=8A=A0=E5=88=B0=E6=96=87=E6=A1=A3=E4=B8=AD= =E4=BB=A5=E5=BC=95=E5=85=A5=E8=BF=99=E4=BA=9B=E6=B3=A8=E9=87=8A=E5=8F=AF=E4= =BB=A5=E5=B8=AE=E5=8A=A9=E7=A4=BE=E5=8C=BA=E8=8E=B7=E5=BE=97=E4=B8=BA=E7=BC= =96=E5=86=99=E6=B3=A8=E9=87=8A=E6=89=80=E5=81=9A=E5=B7=A5=E4=BD=9C=E7=9A=84= =E5=85=A8=E9=83=A8=E4=BB=B7=E5=80=BC=E3=80=82 =20 -``scripts/find-unused-docs.sh`` =E5=B7=A5=E5=85=B7=E5=8F=AF=E4=BB=A5=E7=94= =A8=E6=9D=A5=E6=89=BE=E5=88=B0=E8=BF=99=E4=BA=9B=E8=A2=AB=E5=BF=BD=E7=95=A5= =E7=9A=84=E8=AF=84=E8=AE=BA=E3=80=82 +``tools/docs/find-unused-docs.sh`` =E5=B7=A5=E5=85=B7=E5=8F=AF=E4=BB=A5=E7= =94=A8=E6=9D=A5=E6=89=BE=E5=88=B0=E8=BF=99=E4=BA=9B=E8=A2=AB=E5=BF=BD=E7=95= =A5=E7=9A=84=E8=AF=84=E8=AE=BA=E3=80=82 =20 =E8=AF=B7=E6=B3=A8=E6=84=8F=EF=BC=8C=E5=B0=86=E5=AF=BC=E5=87=BA=E7=9A=84= =E5=87=BD=E6=95=B0=E5=92=8C=E6=95=B0=E6=8D=AE=E7=BB=93=E6=9E=84=E5=BC=95=E5= =85=A5=E6=96=87=E6=A1=A3=E6=98=AF=E6=9C=80=E6=9C=89=E4=BB=B7=E5=80=BC=E7=9A= =84=E3=80=82=E8=AE=B8=E5=A4=9A=E5=AD=90=E7=B3=BB=E7=BB=9F=E8=BF=98=E5=85=B7= =E6=9C=89=E4=BE=9B=E5=86=85=E9=83=A8 =E4=BD=BF=E7=94=A8=E7=9A=84kernel-doc=E6=B3=A8=E9=87=8A=EF=BC=9B=E9=99=A4= =E9=9D=9E=E8=BF=99=E4=BA=9B=E6=B3=A8=E9=87=8A=E6=94=BE=E5=9C=A8=E4=B8=93=E9= =97=A8=E9=92=88=E5=AF=B9=E7=9B=B8=E5=85=B3=E5=AD=90=E7=B3=BB=E7=BB=9F=E5=BC= =80=E5=8F=91=E4=BA=BA=E5=91=98=E7=9A=84=E6=96=87=E6=A1=A3=E4=B8=AD=EF=BC=8C diff --git a/scripts/find-unused-docs.sh b/tools/docs/find-unused-docs.sh similarity index 85% rename from scripts/find-unused-docs.sh rename to tools/docs/find-unused-docs.sh index 1fb265a0ffd0..2f2195a77c60 100755 --- a/scripts/find-unused-docs.sh +++ b/tools/docs/find-unused-docs.sh @@ -5,10 +5,10 @@ # This script detects files with kernel-doc comments for exported functions # that are not included in documentation. # -# usage: Run 'scripts/find-unused-docs.sh directory' from top level of ker= nel +# usage: Run 'tools/docs/find-unused-docs.sh directory' from top level of = kernel # tree. # -# example: $scripts/find-unused-docs.sh drivers/scsi +# example: $tools/docs/find-unused-docs.sh drivers/scsi # # Licensed under the terms of the GNU GPL License =20 @@ -18,7 +18,7 @@ if ! [ -d "Documentation" ]; then fi =20 if [ "$#" -ne 1 ]; then - echo "Usage: scripts/find-unused-docs.sh directory" + echo "Usage: tools/docs/find-unused-docs.sh directory" exit 1 fi =20 --=20 2.51.0 From nobody Sun Feb 8 10:33:44 2026 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 1744B2E62A2; Fri, 24 Oct 2025 20:08:53 +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=1761336539; cv=none; b=BgPdA9R6g5P8FAICGB9Sx/Id3JqS+1kq8K+gQJI9xLVqnp3q5nzrwZQ3YwsfCFfw1z9esVBznmDKSjKT+IBiGItXl64Ygc28Hi3zDsgoJw8bJZfc8Icd13hwfP8//gttRwAl6xZmVkPCeiKWXbOcVkvsbHiVWJTod44Y5ET06Xc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1761336539; c=relaxed/simple; bh=EjRSmLomQF5tZavKTVXND+09edll9BIAYr435r/jzzg=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=MsLxNXz2IE0KlvHfwvuWcIAniIBWe36IPer0zXkjMKQ5AGXI8m4zq/cS2gZQKasg/LkWtEXLmhhJRC2F8MS4H053Csp30eSA7USTG2if/op/37UEztYDKZW6W5x+pkzT/WlFhAuLhONNp5/VBxRvoCYC2+gc7HA4X82btJ5zLQg= 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=j3+Bua1v; 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="j3+Bua1v" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net D089B40C31 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1761336531; bh=kVny+Ha0gv7c32BN+/lj24cMlhjnLlzcwmkeIBhy+WY=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=j3+Bua1vG4iE2/XrB51ziilXTNqW7UF10Lh/NsJNfMw0WjLq3N9WIJ9n8nhgngBMG 4kNdDWZ0cdV53bohFjFRvkMXGaH+lVLLx7uEwcuu/h2U0xG1M6CUqEKYGZ3jHJ3tCo p/wiamX9ar6uM90/N7Q8HbNLK4eHniVxlL3wKRMHF8iyw6WGkVSQ/PY5wM3IMlmkJG ZjmNAe4hRLea4/AweRB3SAjKVEbkZlDk2SHIiiK8FWkGk5rX+WlJ8VY2Beuxkq+H9e aCRZVgCMj7Pls2U1Uxxt0WJRJUq+OFdAcpBFRbi3xAUt5irsceHTpFd+58GxSe+4cB cLLq6xqJGv2xA== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id D089B40C31; Fri, 24 Oct 2025 20:08:50 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Randy Dunlap , Jani Nikula , Jonathan Corbet , Jani Nikula Subject: [PATCH v3 8/8] docs: remove kernel-doc.pl Date: Fri, 24 Oct 2025 14:08:29 -0600 Message-ID: <20251024200834.20644-9-corbet@lwn.net> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20251024200834.20644-1-corbet@lwn.net> References: <20251024200834.20644-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-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable We've been using the Python version and nobody has missed this one. All credit goes to Mauro Carvalho Chehab for creating the replacement. Acked-by: Jani Nikula Signed-off-by: Jonathan Corbet Reviewed-by: Mauro Carvalho Chehab --- scripts/kernel-doc.pl | 2439 ----------------------------------------- 1 file changed, 2439 deletions(-) delete mode 100755 scripts/kernel-doc.pl diff --git a/scripts/kernel-doc.pl b/scripts/kernel-doc.pl deleted file mode 100755 index 5db23cbf4eb2..000000000000 --- a/scripts/kernel-doc.pl +++ /dev/null @@ -1,2439 +0,0 @@ -#!/usr/bin/env perl -# SPDX-License-Identifier: GPL-2.0 -# vim: softtabstop=3D4 - -use warnings; -use strict; - -## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## -## Copyright (C) 2000, 1 Tim Waugh ## -## Copyright (C) 2001 Simon Huggins ## -## Copyright (C) 2005-2012 Randy Dunlap ## -## Copyright (C) 2012 Dan Luedtke ## -## ## -## #define enhancements by Armin Kuster ## -## Copyright (c) 2000 MontaVista Software, Inc. ## -# -# Copyright (C) 2022 Tomasz Warnie=C5=82=C5=82o (POD) - -use Pod::Usage qw/pod2usage/; - -=3Dhead1 NAME - -kernel-doc - Print formatted kernel documentation to stdout - -=3Dhead1 SYNOPSIS - - kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-desc[ription]]= [-Wcontents-before-sections] - [ -man | - -rst [-enable-lineno] | - -none - ] - [ - -export | - -internal | - [-function NAME] ... | - [-nosymbol NAME] ... - ] - [-no-doc-sections] - [-export-file FILE] ... - FILE ... - -Run `kernel-doc -h` for details. - -=3Dhead1 DESCRIPTION - -Read C language source or header FILEs, extract embedded documentation com= ments, -and print formatted documentation to standard output. - -The documentation comments are identified by the "/**" opening comment mar= k. - -See Documentation/doc-guide/kernel-doc.rst for the documentation comment s= yntax. - -=3Dcut - -# more perldoc at the end of the file - -## init lots of data - -my $errors =3D 0; -my $warnings =3D 0; -my $anon_struct_union =3D 0; - -# match expressions used to find embedded type information -my $type_constant =3D '\b``([^\`]+)``\b'; -my $type_constant2 =3D '\%([-_*\w]+)'; -my $type_func =3D '(\w+)\(\)'; -my $type_param =3D '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; -my $type_param_ref =3D '([\!~\*]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; -my $type_fp_param =3D '\@(\w+)\(\)'; # Special RST handling for func ptr = params -my $type_fp_param2 =3D '\@(\w+->\S+)\(\)'; # Special RST handling for str= ucts with func ptr params -my $type_env =3D '(\$\w+)'; -my $type_enum =3D '\&(enum\s*([_\w]+))'; -my $type_struct =3D '\&(struct\s*([_\w]+))'; -my $type_typedef =3D '\&(typedef\s*([_\w]+))'; -my $type_union =3D '\&(union\s*([_\w]+))'; -my $type_member =3D '\&([_\w]+)(\.|->)([_\w]+)'; -my $type_fallback =3D '\&([_\w]+)'; -my $type_member_func =3D $type_member . '\(\)'; - -# Output conversion substitutions. -# One for each output format - -# these are pretty rough -my @highlights_man =3D ( - [$type_constant, "\$1"], - [$type_constant2, "\$1"], - [$type_func, "\\\\fB\$1\\\\fP"], - [$type_enum, "\\\\fI\$1\\\\fP"], - [$type_struct, "\\\\fI\$1\\\\fP"], - [$type_typedef, "\\\\fI\$1\\\\fP"], - [$type_union, "\\\\fI\$1\\\\fP"], - [$type_param, "\\\\fI\$1\\\\fP"], - [$type_param_ref, "\\\\fI\$1\$2\\\\fP"], - [$type_member, "\\\\fI\$1\$2\$3\\\\fP"], - [$type_fallback, "\\\\fI\$1\\\\fP"] - ); -my $blankline_man =3D ""; - -# rst-mode -my @highlights_rst =3D ( - [$type_constant, "``\$1``"], - [$type_constant2, "``\$1``"], - - # Note: need to escape () to avoid func matching later - [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"], - [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"], - [$type_fp_param, "**\$1\\\\(\\\\)**"], - [$type_fp_param2, "**\$1\\\\(\\\\)**"], - [$type_func, "\$1()"], - [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"], - [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"], - [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"], - [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"], - - # in rst this can refer to any type - [$type_fallback, "\\:c\\:type\\:`\$1`"], - [$type_param_ref, "**\$1\$2**"] - ); -my $blankline_rst =3D "\n"; - -# read arguments -if ($#ARGV =3D=3D -1) { - pod2usage( - -message =3D> "No arguments!\n", - -exitval =3D> 1, - -verbose =3D> 99, - -sections =3D> 'SYNOPSIS', - -output =3D> \*STDERR, - ); -} - -my $kernelversion; - -my $dohighlight =3D ""; - -my $verbose =3D 0; -my $Werror =3D 0; -my $Wreturn =3D 0; -my $Wshort_desc =3D 0; -my $output_mode =3D "rst"; -my $output_preformatted =3D 0; -my $no_doc_sections =3D 0; -my $enable_lineno =3D 0; -my @highlights =3D @highlights_rst; -my $blankline =3D $blankline_rst; -my $modulename =3D "Kernel API"; - -use constant { - OUTPUT_ALL =3D> 0, # output all symbols and doc sections - OUTPUT_INCLUDE =3D> 1, # output only specified symbols - OUTPUT_EXPORTED =3D> 2, # output exported symbols - OUTPUT_INTERNAL =3D> 3, # output non-exported symbols -}; -my $output_selection =3D OUTPUT_ALL; -my $show_not_found =3D 0; # No longer used - -my @export_file_list; - -my @build_time; -if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) && - (my $seconds =3D `date -d "${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne = '') { - @build_time =3D gmtime($seconds); -} else { - @build_time =3D localtime; -} - -my $man_date =3D ('January', 'February', 'March', 'April', 'May', 'June', - 'July', 'August', 'September', 'October', - 'November', 'December')[$build_time[4]] . - " " . ($build_time[5]+1900); - -# Essentially these are globals. -# They probably want to be tidied up, made more localised or something. -# CAVEAT EMPTOR! Some of the others I localised may not want to be, which -# could cause "use of undefined value" or other bugs. -my ($function, %function_table, %parametertypes, $declaration_purpose); -my %nosymbol_table =3D (); -my $declaration_start_line; -my ($type, $declaration_name, $return_type); -my ($newsection, $newcontents, $prototype, $brcount); - -if (defined($ENV{'KBUILD_VERBOSE'}) && $ENV{'KBUILD_VERBOSE'} =3D~ '1') { - $verbose =3D 1; -} - -if (defined($ENV{'KCFLAGS'})) { - my $kcflags =3D "$ENV{'KCFLAGS'}"; - - if ($kcflags =3D~ /(\s|^)-Werror(\s|$)/) { - $Werror =3D 1; - } -} - -# reading this variable is for backwards compat just in case -# someone was calling it with the variable from outside the -# kernel's build system -if (defined($ENV{'KDOC_WERROR'})) { - $Werror =3D "$ENV{'KDOC_WERROR'}"; -} -# other environment variables are converted to command-line -# arguments in cmd_checkdoc in the build system - -# Generated docbook code is inserted in a template at a point where -# docbook v3.1 requires a non-zero sequence of RefEntry's; see: -# https://www.oasis-open.org/docbook/documentation/reference/html/refentry= .html -# We keep track of number of generated entries and generate a dummy -# if needs be to ensure the expanded template can be postprocessed -# into html. -my $section_counter =3D 0; - -my $lineprefix=3D""; - -# Parser states -use constant { - STATE_NORMAL =3D> 0, # normal code - STATE_NAME =3D> 1, # looking for function name - STATE_BODY_MAYBE =3D> 2, # body - or maybe more description - STATE_BODY =3D> 3, # the body of the comment - STATE_BODY_WITH_BLANK_LINE =3D> 4, # the body, which has a blank line - STATE_PROTO =3D> 5, # scanning prototype - STATE_DOCBLOCK =3D> 6, # documentation block - STATE_INLINE =3D> 7, # gathering doc outside main block -}; -my $state; -my $leading_space; - -# Inline documentation state -use constant { - STATE_INLINE_NA =3D> 0, # not applicable ($state !=3D STATE_INLINE) - STATE_INLINE_NAME =3D> 1, # looking for member name (@foo:) - STATE_INLINE_TEXT =3D> 2, # looking for member documentation - STATE_INLINE_END =3D> 3, # done - STATE_INLINE_ERROR =3D> 4, # error - Comment without header was found. - # Spit a warning as it's not - # proper kernel-doc and ignore the rest. -}; -my $inline_doc_state; - -#declaration types: can be -# 'function', 'struct', 'union', 'enum', 'typedef' -my $decl_type; - -# Name of the kernel-doc identifier for non-DOC markups -my $identifier; - -my $doc_start =3D '^/\*\*\s*$'; # Allow whitespace at end of comment start. -my $doc_end =3D '\*/'; -my $doc_com =3D '\s*\*\s*'; -my $doc_com_body =3D '\s*\* ?'; -my $doc_decl =3D $doc_com . '(\w+)'; -# @params and a strictly limited set of supported section names -# Specifically: -# Match @word: -# @...: -# @{section-name}: -# while trying to not match literal block starts like "example::" -# -my $doc_sect =3D $doc_com . - '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\= s*:([^:].*)?$'; -my $doc_content =3D $doc_com_body . '(.*)'; -my $doc_block =3D $doc_com . 'DOC:\s*(.*)?'; -my $doc_inline_start =3D '^\s*/\*\*\s*$'; -my $doc_inline_sect =3D '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)'; -my $doc_inline_end =3D '^\s*\*/\s*$'; -my $doc_inline_oneline =3D '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$'; -my $export_symbol =3D '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;'; -my $export_symbol_ns =3D '^\s*EXPORT_SYMBOL_NS(_GPL)?\s*\(\s*(\w+)\s*,\s*"= \S+"\)\s*;'; -my $function_pointer =3D qr{([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)}; -my $attribute =3D qr{__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)}i; - -my %parameterdescs; -my %parameterdesc_start_lines; -my @parameterlist; -my %sections; -my @sectionlist; -my %section_start_lines; -my $sectcheck; -my $struct_actual; - -my $contents =3D ""; -my $new_start_line =3D 0; - -# the canonical section names. see also $doc_sect above. -my $section_default =3D "Description"; # default section -my $section_intro =3D "Introduction"; -my $section =3D $section_default; -my $section_context =3D "Context"; -my $section_return =3D "Return"; - -my $undescribed =3D "-- undescribed --"; - -reset_state(); - -while ($ARGV[0] =3D~ m/^--?(.*)/) { - my $cmd =3D $1; - shift @ARGV; - if ($cmd eq "man") { - $output_mode =3D "man"; - @highlights =3D @highlights_man; - $blankline =3D $blankline_man; - } elsif ($cmd eq "rst") { - $output_mode =3D "rst"; - @highlights =3D @highlights_rst; - $blankline =3D $blankline_rst; - } elsif ($cmd eq "none") { - $output_mode =3D "none"; - } elsif ($cmd eq "module") { # not needed for XML, inherits from calli= ng document - $modulename =3D shift @ARGV; - } elsif ($cmd eq "function") { # to only output specific functions - $output_selection =3D OUTPUT_INCLUDE; - $function =3D shift @ARGV; - $function_table{$function} =3D 1; - } elsif ($cmd eq "nosymbol") { # Exclude specific symbols - my $symbol =3D shift @ARGV; - $nosymbol_table{$symbol} =3D 1; - } elsif ($cmd eq "export") { # only exported symbols - $output_selection =3D OUTPUT_EXPORTED; - %function_table =3D (); - } elsif ($cmd eq "internal") { # only non-exported symbols - $output_selection =3D OUTPUT_INTERNAL; - %function_table =3D (); - } elsif ($cmd eq "export-file") { - my $file =3D shift @ARGV; - push(@export_file_list, $file); - } elsif ($cmd eq "v") { - $verbose =3D 1; - } elsif ($cmd eq "Werror") { - $Werror =3D 1; - } elsif ($cmd eq "Wreturn") { - $Wreturn =3D 1; - } elsif ($cmd eq "Wshort-desc" or $cmd eq "Wshort-description") { - $Wshort_desc =3D 1; - } elsif ($cmd eq "Wall") { - $Wreturn =3D 1; - $Wshort_desc =3D 1; - } elsif (($cmd eq "h") || ($cmd eq "help")) { - pod2usage(-exitval =3D> 0, -verbose =3D> 2); - } elsif ($cmd eq 'no-doc-sections') { - $no_doc_sections =3D 1; - } elsif ($cmd eq 'enable-lineno') { - $enable_lineno =3D 1; - } elsif ($cmd eq 'show-not-found') { - $show_not_found =3D 1; # A no-op but don't fail - } else { - # Unknown argument - pod2usage( - -message =3D> "Argument unknown!\n", - -exitval =3D> 1, - -verbose =3D> 99, - -sections =3D> 'SYNOPSIS', - -output =3D> \*STDERR, - ); - } - if ($#ARGV < 0){ - pod2usage( - -message =3D> "FILE argument missing\n", - -exitval =3D> 1, - -verbose =3D> 99, - -sections =3D> 'SYNOPSIS', - -output =3D> \*STDERR, - ); - } -} - -# continue execution near EOF; - -sub findprog($) -{ - foreach(split(/:/, $ENV{PATH})) { - return "$_/$_[0]" if(-x "$_/$_[0]"); - } -} - -# get kernel version from env -sub get_kernel_version() { - my $version =3D 'unknown kernel version'; - - if (defined($ENV{'KERNELVERSION'})) { - $version =3D $ENV{'KERNELVERSION'}; - } - return $version; -} - -# -sub print_lineno { - my $lineno =3D shift; - if ($enable_lineno && defined($lineno)) { - print ".. LINENO " . $lineno . "\n"; - } -} - -sub emit_warning { - my $location =3D shift; - my $msg =3D shift; - print STDERR "$location: warning: $msg"; - ++$warnings; -} -## -# dumps section contents to arrays/hashes intended for that purpose. -# -sub dump_section { - my $file =3D shift; - my $name =3D shift; - my $contents =3D join "\n", @_; - - if ($name =3D~ m/$type_param/) { - $name =3D $1; - $parameterdescs{$name} =3D $contents; - $sectcheck =3D $sectcheck . $name . " "; - $parameterdesc_start_lines{$name} =3D $new_start_line; - $new_start_line =3D 0; - } elsif ($name eq "@\.\.\.") { - $name =3D "..."; - $parameterdescs{$name} =3D $contents; - $sectcheck =3D $sectcheck . $name . " "; - $parameterdesc_start_lines{$name} =3D $new_start_line; - $new_start_line =3D 0; - } else { - if (defined($sections{$name}) && ($sections{$name} ne "")) { - # Only warn on user specified duplicate section names. - if ($name ne $section_default) { - emit_warning("${file}:$.", "duplicate section name '$name'= \n"); - } - $sections{$name} .=3D $contents; - } else { - $sections{$name} =3D $contents; - push @sectionlist, $name; - $section_start_lines{$name} =3D $new_start_line; - $new_start_line =3D 0; - } - } -} - -## -# dump DOC: section after checking that it should go out -# -sub dump_doc_section { - my $file =3D shift; - my $name =3D shift; - my $contents =3D join "\n", @_; - - if ($no_doc_sections) { - return; - } - - return if (defined($nosymbol_table{$name})); - - if (($output_selection =3D=3D OUTPUT_ALL) || - (($output_selection =3D=3D OUTPUT_INCLUDE) && - defined($function_table{$name}))) - { - dump_section($file, $name, $contents); - output_blockhead({'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'module' =3D> $modulename, - 'content-only' =3D> ($output_selection !=3D OUTP= UT_ALL), }); - } -} - -## -# output function -# -# parameterdescs, a hash. -# function =3D> "function name" -# parameterlist =3D> @list of parameters -# parameterdescs =3D> %parameter descriptions -# sectionlist =3D> @list of sections -# sections =3D> %section descriptions -# - -sub output_highlight { - my $contents =3D join "\n",@_; - my $line; - -# DEBUG -# if (!defined $contents) { -# use Carp; -# confess "output_highlight got called with no args?\n"; -# } - -# print STDERR "contents b4:$contents\n"; - eval $dohighlight; - die $@ if $@; -# print STDERR "contents af:$contents\n"; - - foreach $line (split "\n", $contents) { - if (! $output_preformatted) { - $line =3D~ s/^\s*//; - } - if ($line eq ""){ - if (! $output_preformatted) { - print $lineprefix, $blankline; - } - } else { - if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { - print "\\&$line"; - } else { - print $lineprefix, $line; - } - } - print "\n"; - } -} - -## -# output function in man -sub output_function_man(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - my $count; - my $func_macro =3D $args{'func_macro'}; - my $paramcount =3D $#{$args{'parameterlist'}}; # -1 is empty - - print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\"= \"Kernel Hacker's Manual\" LINUX\n"; - - print ".SH NAME\n"; - print $args{'function'} . " \\- " . $args{'purpose'} . "\n"; - - print ".SH SYNOPSIS\n"; - if ($args{'functiontype'} ne "") { - print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} = . "\n"; - } else { - print ".B \"" . $args{'function'} . "\n"; - } - $count =3D 0; - my $parenth =3D "("; - my $post =3D ","; - foreach my $parameter (@{$args{'parameterlist'}}) { - if ($count =3D=3D $#{$args{'parameterlist'}}) { - $post =3D ");"; - } - $type =3D $args{'parametertypes'}{$parameter}; - if ($type =3D~ m/$function_pointer/) { - # pointer-to-function - print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" .= $post . "\"\n"; - } else { - $type =3D~ s/([^\*])$/$1 /; - print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\= "\n"; - } - $count++; - $parenth =3D ""; - } - - $paramcount =3D $#{$args{'parameterlist'}}; # -1 is empty - if ($paramcount >=3D 0) { - print ".SH ARGUMENTS\n"; - } - foreach $parameter (@{$args{'parameterlist'}}) { - my $parameter_name =3D $parameter; - $parameter_name =3D~ s/\[.*//; - - print ".IP \"" . $parameter . "\" 12\n"; - output_highlight($args{'parameterdescs'}{$parameter_name}); - } - foreach $section (@{$args{'sectionlist'}}) { - print ".SH \"", uc $section, "\"\n"; - output_highlight($args{'sections'}{$section}); - } -} - -## -# output enum in man -sub output_enum_man(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - my $count; - - print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" = \"API Manual\" LINUX\n"; - - print ".SH NAME\n"; - print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n"; - - print ".SH SYNOPSIS\n"; - print "enum " . $args{'enum'} . " {\n"; - $count =3D 0; - foreach my $parameter (@{$args{'parameterlist'}}) { - print ".br\n.BI \" $parameter\"\n"; - if ($count =3D=3D $#{$args{'parameterlist'}}) { - print "\n};\n"; - last; - } else { - print ", \n.br\n"; - } - $count++; - } - - print ".SH Constants\n"; - foreach $parameter (@{$args{'parameterlist'}}) { - my $parameter_name =3D $parameter; - $parameter_name =3D~ s/\[.*//; - - print ".IP \"" . $parameter . "\" 12\n"; - output_highlight($args{'parameterdescs'}{$parameter_name}); - } - foreach $section (@{$args{'sectionlist'}}) { - print ".SH \"$section\"\n"; - output_highlight($args{'sections'}{$section}); - } -} - -## -# output struct in man -sub output_struct_man(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - - print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'st= ruct'} . "\" \"$man_date\" \"API Manual\" LINUX\n"; - - print ".SH NAME\n"; - print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose= '} . "\n"; - - my $declaration =3D $args{'definition'}; - $declaration =3D~ s/\t/ /g; - $declaration =3D~ s/\n/"\n.br\n.BI \"/g; - print ".SH SYNOPSIS\n"; - print $args{'type'} . " " . $args{'struct'} . " {\n.br\n"; - print ".BI \"$declaration\n};\n.br\n\n"; - - print ".SH Members\n"; - foreach $parameter (@{$args{'parameterlist'}}) { - ($parameter =3D~ /^#/) && next; - - my $parameter_name =3D $parameter; - $parameter_name =3D~ s/\[.*//; - - ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; - print ".IP \"" . $parameter . "\" 12\n"; - output_highlight($args{'parameterdescs'}{$parameter_name}); - } - foreach $section (@{$args{'sectionlist'}}) { - print ".SH \"$section\"\n"; - output_highlight($args{'sections'}{$section}); - } -} - -## -# output typedef in man -sub output_typedef_man(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - - print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"= API Manual\" LINUX\n"; - - print ".SH NAME\n"; - print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n= "; - - foreach $section (@{$args{'sectionlist'}}) { - print ".SH \"$section\"\n"; - output_highlight($args{'sections'}{$section}); - } -} - -sub output_blockhead_man(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - my $count; - - print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"A= PI Manual\" LINUX\n"; - - foreach $section (@{$args{'sectionlist'}}) { - print ".SH \"$section\"\n"; - output_highlight($args{'sections'}{$section}); - } -} - -## -# output in restructured text -# - -# -# This could use some work; it's used to output the DOC: sections, and -# starts by putting out the name of the doc section itself, but that tends -# to duplicate a header already in the template file. -# -sub output_blockhead_rst(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - - foreach $section (@{$args{'sectionlist'}}) { - next if (defined($nosymbol_table{$section})); - - if ($output_selection !=3D OUTPUT_INCLUDE) { - print ".. _$section:\n\n"; - print "**$section**\n\n"; - } - print_lineno($section_start_lines{$section}); - output_highlight_rst($args{'sections'}{$section}); - print "\n"; - } -} - -# -# Apply the RST highlights to a sub-block of text. -# -sub highlight_block($) { - # The dohighlight kludge requires the text be called $contents - my $contents =3D shift; - eval $dohighlight; - die $@ if $@; - return $contents; -} - -# -# Regexes used only here. -# -my $sphinx_literal =3D '^[^.].*::$'; -my $sphinx_cblock =3D '^\.\.\ +code-block::'; - -sub output_highlight_rst { - my $input =3D join "\n",@_; - my $output =3D ""; - my $line; - my $in_literal =3D 0; - my $litprefix; - my $block =3D ""; - - foreach $line (split "\n",$input) { - # - # If we're in a literal block, see if we should drop out - # of it. Otherwise pass the line straight through unmunged. - # - if ($in_literal) { - if (! ($line =3D~ /^\s*$/)) { - # - # If this is the first non-blank line in a literal - # block we need to figure out what the proper indent is. - # - if ($litprefix eq "") { - $line =3D~ /^(\s*)/; - $litprefix =3D '^' . $1; - $output .=3D $line . "\n"; - } elsif (! ($line =3D~ /$litprefix/)) { - $in_literal =3D 0; - } else { - $output .=3D $line . "\n"; - } - } else { - $output .=3D $line . "\n"; - } - } - # - # Not in a literal block (or just dropped out) - # - if (! $in_literal) { - $block .=3D $line . "\n"; - if (($line =3D~ /$sphinx_literal/) || ($line =3D~ /$sphinx_cbl= ock/)) { - $in_literal =3D 1; - $litprefix =3D ""; - $output .=3D highlight_block($block); - $block =3D "" - } - } - } - - if ($block) { - $output .=3D highlight_block($block); - } - - $output =3D~ s/^\n+//g; - $output =3D~ s/\n+$//g; - - foreach $line (split "\n", $output) { - print $lineprefix . $line . "\n"; - } -} - -sub output_function_rst(%) { - my %args =3D %{$_[0]}; - my ($parameter, $section); - my $oldprefix =3D $lineprefix; - - my $signature =3D ""; - my $func_macro =3D $args{'func_macro'}; - my $paramcount =3D $#{$args{'parameterlist'}}; # -1 is empty - - if ($func_macro) { - $signature =3D $args{'function'}; - } else { - if ($args{'functiontype'}) { - $signature =3D $args{'functiontype'} . " "; - } - $signature .=3D $args{'function'} . " ("; - } - - my $count =3D 0; - foreach my $parameter (@{$args{'parameterlist'}}) { - if ($count ne 0) { - $signature .=3D ", "; - } - $count++; - $type =3D $args{'parametertypes'}{$parameter}; - - if ($type =3D~ m/$function_pointer/) { - # pointer-to-function - $signature .=3D $1 . $parameter . ") (" . $2 . ")"; - } else { - $signature .=3D $type; - } - } - - if (!$func_macro) { - $signature .=3D ")"; - } - - if ($args{'typedef'} || $args{'functiontype'} eq "") { - print ".. c:macro:: ". $args{'function'} . "\n\n"; - - if ($args{'typedef'}) { - print_lineno($declaration_start_line); - print " **Typedef**: "; - $lineprefix =3D ""; - output_highlight_rst($args{'purpose'}); - print "\n\n**Syntax**\n\n"; - print " ``$signature``\n\n"; - } else { - print "``$signature``\n\n"; - } - } else { - print ".. c:function:: $signature\n\n"; - } - - if (!$args{'typedef'}) { - print_lineno($declaration_start_line); - $lineprefix =3D " "; - output_highlight_rst($args{'purpose'}); - print "\n"; - } - - # - # Put our descriptive text into a container (thus an HTML
) to he= lp - # set the function prototypes apart. - # - $lineprefix =3D " "; - if ($paramcount >=3D 0) { - print ".. container:: kernelindent\n\n"; - print $lineprefix . "**Parameters**\n\n"; - } - foreach $parameter (@{$args{'parameterlist'}}) { - my $parameter_name =3D $parameter; - $parameter_name =3D~ s/\[.*//; - $type =3D $args{'parametertypes'}{$parameter}; - - if ($type ne "") { - print $lineprefix . "``$type``\n"; - } else { - print $lineprefix . "``$parameter``\n"; - } - - print_lineno($parameterdesc_start_lines{$parameter_name}); - - $lineprefix =3D " "; - if (defined($args{'parameterdescs'}{$parameter_name}) && - $args{'parameterdescs'}{$parameter_name} ne $undescribed) { - output_highlight_rst($args{'parameterdescs'}{$parameter_name}); - } else { - print $lineprefix . "*undescribed*\n"; - } - $lineprefix =3D " "; - print "\n"; - } - - output_section_rst(@_); - $lineprefix =3D $oldprefix; -} - -sub output_section_rst(%) { - my %args =3D %{$_[0]}; - my $section; - my $oldprefix =3D $lineprefix; - - foreach $section (@{$args{'sectionlist'}}) { - print $lineprefix . "**$section**\n\n"; - print_lineno($section_start_lines{$section}); - output_highlight_rst($args{'sections'}{$section}); - print "\n"; - } - print "\n"; -} - -sub output_enum_rst(%) { - my %args =3D %{$_[0]}; - my ($parameter); - my $oldprefix =3D $lineprefix; - my $count; - my $outer; - - my $name =3D $args{'enum'}; - print "\n\n.. c:enum:: " . $name . "\n\n"; - - print_lineno($declaration_start_line); - $lineprefix =3D " "; - output_highlight_rst($args{'purpose'}); - print "\n"; - - print ".. container:: kernelindent\n\n"; - $outer =3D $lineprefix . " "; - $lineprefix =3D $outer . " "; - print $outer . "**Constants**\n\n"; - foreach $parameter (@{$args{'parameterlist'}}) { - print $outer . "``$parameter``\n"; - - if ($args{'parameterdescs'}{$parameter} ne $undescribed) { - output_highlight_rst($args{'parameterdescs'}{$parameter}); - } else { - print $lineprefix . "*undescribed*\n"; - } - print "\n"; - } - print "\n"; - $lineprefix =3D $oldprefix; - output_section_rst(@_); -} - -sub output_typedef_rst(%) { - my %args =3D %{$_[0]}; - my ($parameter); - my $oldprefix =3D $lineprefix; - my $name; - - $name =3D $args{'typedef'}; - - print "\n\n.. c:type:: " . $name . "\n\n"; - print_lineno($declaration_start_line); - $lineprefix =3D " "; - output_highlight_rst($args{'purpose'}); - print "\n"; - - $lineprefix =3D $oldprefix; - output_section_rst(@_); -} - -sub output_struct_rst(%) { - my %args =3D %{$_[0]}; - my ($parameter); - my $oldprefix =3D $lineprefix; - - my $name =3D $args{'struct'}; - if ($args{'type'} eq 'union') { - print "\n\n.. c:union:: " . $name . "\n\n"; - } else { - print "\n\n.. c:struct:: " . $name . "\n\n"; - } - - print_lineno($declaration_start_line); - $lineprefix =3D " "; - output_highlight_rst($args{'purpose'}); - print "\n"; - - print ".. container:: kernelindent\n\n"; - print $lineprefix . "**Definition**::\n\n"; - my $declaration =3D $args{'definition'}; - $lineprefix =3D $lineprefix . " "; - $declaration =3D~ s/\t/$lineprefix/g; - print $lineprefix . $args{'type'} . " " . $args{'struct'} . " {\n$decl= aration" . $lineprefix . "};\n\n"; - - $lineprefix =3D " "; - print $lineprefix . "**Members**\n\n"; - foreach $parameter (@{$args{'parameterlist'}}) { - ($parameter =3D~ /^#/) && next; - - my $parameter_name =3D $parameter; - $parameter_name =3D~ s/\[.*//; - - ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; - $type =3D $args{'parametertypes'}{$parameter}; - print_lineno($parameterdesc_start_lines{$parameter_name}); - print $lineprefix . "``" . $parameter . "``\n"; - $lineprefix =3D " "; - output_highlight_rst($args{'parameterdescs'}{$parameter_name}); - $lineprefix =3D " "; - print "\n"; - } - print "\n"; - - $lineprefix =3D $oldprefix; - output_section_rst(@_); -} - -## none mode output functions - -sub output_function_none(%) { -} - -sub output_enum_none(%) { -} - -sub output_typedef_none(%) { -} - -sub output_struct_none(%) { -} - -sub output_blockhead_none(%) { -} - -## -# generic output function for all types (function, struct/union, typedef, = enum); -# calls the generated, variable output_ function name based on -# functype and output_mode -sub output_declaration { - no strict 'refs'; - my $name =3D shift; - my $functype =3D shift; - my $func =3D "output_${functype}_$output_mode"; - - return if (defined($nosymbol_table{$name})); - - if (($output_selection =3D=3D OUTPUT_ALL) || - (($output_selection =3D=3D OUTPUT_INCLUDE || - $output_selection =3D=3D OUTPUT_EXPORTED) && - defined($function_table{$name})) || - ($output_selection =3D=3D OUTPUT_INTERNAL && - !($functype eq "function" && defined($function_table{$name})))) - { - &$func(@_); - $section_counter++; - } -} - -## -# generic output function - calls the right one based on current output mo= de. -sub output_blockhead { - no strict 'refs'; - my $func =3D "output_blockhead_" . $output_mode; - &$func(@_); - $section_counter++; -} - -## -# takes a declaration (struct, union, enum, typedef) and -# invokes the right handler. NOT called for functions. -sub dump_declaration($$) { - no strict 'refs'; - my ($prototype, $file) =3D @_; - my $func =3D "dump_" . $decl_type; - &$func(@_); -} - -sub dump_union($$) { - dump_struct(@_); -} - -sub dump_struct($$) { - my $x =3D shift; - my $file =3D shift; - my $decl_type; - my $members; - my $type =3D qr{struct|union}; - # For capturing struct/union definition body, i.e. "{members*}qualifie= rs*" - my $qualifiers =3D qr{$attribute|__packed|__aligned|____cacheline_alig= ned_in_smp|____cacheline_aligned}; - my $definition_body =3D qr{\{(.*)\}\s*$qualifiers*}; - my $struct_members =3D qr{($type)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)= \;}; - - if ($x =3D~ /($type)\s+(\w+)\s*$definition_body/) { - $decl_type =3D $1; - $declaration_name =3D $2; - $members =3D $3; - } elsif ($x =3D~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) { - $decl_type =3D $1; - $declaration_name =3D $3; - $members =3D $2; - } - - if ($members) { - if ($identifier ne $declaration_name) { - emit_warning("${file}:$.", "expecting prototype for $decl_type= $identifier. Prototype was for $decl_type $declaration_name instead\n"); - return; - } - - # ignore members marked private: - $members =3D~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; - $members =3D~ s/\/\*\s*private:.*//gosi; - # strip comments: - $members =3D~ s/\/\*.*?\*\///gos; - # strip attributes - $members =3D~ s/\s*$attribute/ /gi; - $members =3D~ s/\s*__aligned\s*\([^;]*\)/ /gos; - $members =3D~ s/\s*__counted_by\s*\([^;]*\)/ /gos; - $members =3D~ s/\s*__counted_by_(le|be)\s*\([^;]*\)/ /gos; - $members =3D~ s/\s*__packed\s*/ /gos; - $members =3D~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos; - $members =3D~ s/\s*____cacheline_aligned_in_smp/ /gos; - $members =3D~ s/\s*____cacheline_aligned/ /gos; - # unwrap struct_group(): - # - first eat non-declaration parameters and rewrite for final mat= ch - # - then remove macro, outer parens, and trailing semicolon - $members =3D~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos; - $members =3D~ s/\bstruct_group_attr\s*\(([^,]*,){2}/STRUCT_GROUP(/= gos; - $members =3D~ s/\bstruct_group_tagged\s*\(([^,]*),([^,]*),/struct = $1 $2; STRUCT_GROUP(/gos; - $members =3D~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos; - $members =3D~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$= 2/gos; - - my $args =3D qr{([^,)]+)}; - # replace DECLARE_BITMAP - $members =3D~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DE= CLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos; - $members =3D~ s/DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)/DECLARE_= BITMAP($1, PHY_INTERFACE_MODE_MAX)/gos; - $members =3D~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long = $1\[BITS_TO_LONGS($2)\]/gos; - # replace DECLARE_HASHTABLE - $members =3D~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned lo= ng $1\[1 << (($2) - 1)\]/gos; - # replace DECLARE_KFIFO - $members =3D~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$= 1/gos; - # replace DECLARE_KFIFO_PTR - $members =3D~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos; - # replace DECLARE_FLEX_ARRAY - $members =3D~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 = $2\[\]/gos; - #replace DEFINE_DMA_UNMAP_ADDR - $members =3D~ s/DEFINE_DMA_UNMAP_ADDR\s*\($args\)/dma_addr_t $1/go= s; - #replace DEFINE_DMA_UNMAP_LEN - $members =3D~ s/DEFINE_DMA_UNMAP_LEN\s*\($args\)/__u32 $1/gos; - my $declaration =3D $members; - - # Split nested struct/union elements as newer ones - while ($members =3D~ m/$struct_members/) { - my $newmember; - my $maintype =3D $1; - my $ids =3D $4; - my $content =3D $3; - foreach my $id(split /,/, $ids) { - $newmember .=3D "$maintype $id; "; - - $id =3D~ s/[:\[].*//; - $id =3D~ s/^\s*\**(\S+)\s*/$1/; - foreach my $arg (split /;/, $content) { - next if ($arg =3D~ m/^\s*$/); - if ($arg =3D~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) { - # pointer-to-function - my $type =3D $1; - my $name =3D $2; - my $extra =3D $3; - next if (!$name); - if ($id =3D~ m/^\s*$/) { - # anonymous struct/union - $newmember .=3D "$type$name$extra; "; - } else { - $newmember .=3D "$type$id.$name$extra; "; - } - } else { - my $type; - my $names; - $arg =3D~ s/^\s+//; - $arg =3D~ s/\s+$//; - # Handle bitmaps - $arg =3D~ s/:\s*\d+\s*//g; - # Handle arrays - $arg =3D~ s/\[.*\]//g; - # The type may have multiple words, - # and multiple IDs can be defined, like: - # const struct foo, *bar, foobar - # So, we remove spaces when parsing the - # names, in order to match just names - # and commas for the names - $arg =3D~ s/\s*,\s*/,/g; - if ($arg =3D~ m/(.*)\s+([\S+,]+)/) { - $type =3D $1; - $names =3D $2; - } else { - $newmember .=3D "$arg; "; - next; - } - foreach my $name (split /,/, $names) { - $name =3D~ s/^\s*\**(\S+)\s*/$1/; - next if (($name =3D~ m/^\s*$/)); - if ($id =3D~ m/^\s*$/) { - # anonymous struct/union - $newmember .=3D "$type $name; "; - } else { - $newmember .=3D "$type $id.$name; "; - } - } - } - } - } - $members =3D~ s/$struct_members/$newmember/; - } - - # Ignore other nested elements, like enums - $members =3D~ s/(\{[^\{\}]*\})//g; - - create_parameterlist($members, ';', $file, $declaration_name); - check_sections($file, $declaration_name, $decl_type, $sectcheck, $= struct_actual); - - # Adjust declaration for better display - $declaration =3D~ s/([\{;])/$1\n/g; - $declaration =3D~ s/\}\s+;/};/g; - # Better handle inlined enums - do {} while ($declaration =3D~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2= /); - - my @def_args =3D split /\n/, $declaration; - my $level =3D 1; - $declaration =3D ""; - foreach my $clause (@def_args) { - $clause =3D~ s/^\s+//; - $clause =3D~ s/\s+$//; - $clause =3D~ s/\s+/ /; - next if (!$clause); - $level-- if ($clause =3D~ m/(\})/ && $level > 1); - if (!($clause =3D~ m/^\s*#/)) { - $declaration .=3D "\t" x $level; - } - $declaration .=3D "\t" . $clause . "\n"; - $level++ if ($clause =3D~ m/(\{)/ && !($clause =3D~m/\}/)); - } - output_declaration($declaration_name, - 'struct', - {'struct' =3D> $declaration_name, - 'module' =3D> $modulename, - 'definition' =3D> $declaration, - 'parameterlist' =3D> \@parameterlist, - 'parameterdescs' =3D> \%parameterdescs, - 'parametertypes' =3D> \%parametertypes, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose, - 'type' =3D> $decl_type - }); - } else { - print STDERR "${file}:$.: error: Cannot parse struct or union!\n"; - ++$errors; - } -} - - -sub show_warnings($$) { - my $functype =3D shift; - my $name =3D shift; - - return 0 if (defined($nosymbol_table{$name})); - - return 1 if ($output_selection =3D=3D OUTPUT_ALL); - - if ($output_selection =3D=3D OUTPUT_EXPORTED) { - if (defined($function_table{$name})) { - return 1; - } else { - return 0; - } - } - if ($output_selection =3D=3D OUTPUT_INTERNAL) { - if (!($functype eq "function" && defined($function_table{$name})))= { - return 1; - } else { - return 0; - } - } - if ($output_selection =3D=3D OUTPUT_INCLUDE) { - if (defined($function_table{$name})) { - return 1; - } else { - return 0; - } - } - die("Please add the new output type at show_warnings()"); -} - -sub dump_enum($$) { - my $x =3D shift; - my $file =3D shift; - my $members; - - # ignore members marked private: - $x =3D~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; - $x =3D~ s/\/\*\s*private:.*}/}/gosi; - - $x =3D~ s@/\*.*?\*/@@gos; # strip comments. - # strip #define macros inside enums - $x =3D~ s@#\s*((define|ifdef|if)\s+|endif)[^;]*;@@gos; - - if ($x =3D~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) { - $declaration_name =3D $2; - $members =3D $1; - } elsif ($x =3D~ /enum\s+(\w*)\s*\{(.*)\}/) { - $declaration_name =3D $1; - $members =3D $2; - } - - if ($members) { - if ($identifier ne $declaration_name) { - if ($identifier eq "") { - emit_warning("${file}:$.", "wrong kernel-doc identifier on= line:\n"); - } else { - emit_warning("${file}:$.", "expecting prototype for enum $= identifier. Prototype was for enum $declaration_name instead\n"); - } - return; - } - $declaration_name =3D "(anonymous)" if ($declaration_name eq ""); - - my %_members; - - $members =3D~ s/\s+$//; - $members =3D~ s/\([^;]*?[\)]//g; - - foreach my $arg (split ',', $members) { - $arg =3D~ s/^\s*(\w+).*/$1/; - push @parameterlist, $arg; - if (!$parameterdescs{$arg}) { - $parameterdescs{$arg} =3D $undescribed; - if (show_warnings("enum", $declaration_name)) { - emit_warning("${file}:$.", "Enum value '$arg' not desc= ribed in enum '$declaration_name'\n"); - } - } - $_members{$arg} =3D 1; - } - - while (my ($k, $v) =3D each %parameterdescs) { - if (!exists($_members{$k})) { - if (show_warnings("enum", $declaration_name)) { - emit_warning("${file}:$.", "Excess enum value '$k' des= cription in '$declaration_name'\n"); - } - } - } - - output_declaration($declaration_name, - 'enum', - {'enum' =3D> $declaration_name, - 'module' =3D> $modulename, - 'parameterlist' =3D> \@parameterlist, - 'parameterdescs' =3D> \%parameterdescs, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose - }); - } else { - print STDERR "${file}:$.: error: Cannot parse enum!\n"; - ++$errors; - } -} - -my $typedef_type =3D qr { ((?:\s+[\w\*]+\b){0,7}\s+(?:\w+\b|\*+))\s* }x; -my $typedef_ident =3D qr { \*?\s*(\w\S+)\s* }x; -my $typedef_args =3D qr { \s*\((.*)\); }x; - -my $typedef1 =3D qr { typedef$typedef_type\($typedef_ident\)$typedef_args = }x; -my $typedef2 =3D qr { typedef$typedef_type$typedef_ident$typedef_args }x; - -sub dump_typedef($$) { - my $x =3D shift; - my $file =3D shift; - - $x =3D~ s@/\*.*?\*/@@gos; # strip comments. - - # Parse function typedef prototypes - if ($x =3D~ $typedef1 || $x =3D~ $typedef2) { - $return_type =3D $1; - $declaration_name =3D $2; - my $args =3D $3; - $return_type =3D~ s/^\s+//; - - if ($identifier ne $declaration_name) { - emit_warning("${file}:$.", "expecting prototype for typedef $i= dentifier. Prototype was for typedef $declaration_name instead\n"); - return; - } - - create_parameterlist($args, ',', $file, $declaration_name); - - output_declaration($declaration_name, - 'function', - {'function' =3D> $declaration_name, - 'typedef' =3D> 1, - 'module' =3D> $modulename, - 'functiontype' =3D> $return_type, - 'parameterlist' =3D> \@parameterlist, - 'parameterdescs' =3D> \%parameterdescs, - 'parametertypes' =3D> \%parametertypes, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose - }); - return; - } - - while (($x =3D~ /\(*.\)\s*;$/) || ($x =3D~ /\[*.\]\s*;$/)) { - $x =3D~ s/\(*.\)\s*;$/;/; - $x =3D~ s/\[*.\]\s*;$/;/; - } - - if ($x =3D~ /typedef.*\s+(\w+)\s*;/) { - $declaration_name =3D $1; - - if ($identifier ne $declaration_name) { - emit_warning("${file}:$.", "expecting prototype for typedef $i= dentifier. Prototype was for typedef $declaration_name instead\n"); - return; - } - - output_declaration($declaration_name, - 'typedef', - {'typedef' =3D> $declaration_name, - 'module' =3D> $modulename, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose - }); - } else { - print STDERR "${file}:$.: error: Cannot parse typedef!\n"; - ++$errors; - } -} - -sub save_struct_actual($) { - my $actual =3D shift; - - # strip all spaces from the actual param so that it looks like one str= ing item - $actual =3D~ s/\s*//g; - $struct_actual =3D $struct_actual . $actual . " "; -} - -sub create_parameterlist($$$$) { - my $args =3D shift; - my $splitter =3D shift; - my $file =3D shift; - my $declaration_name =3D shift; - my $type; - my $param; - - # temporarily replace commas inside function pointer definition - my $arg_expr =3D qr{\([^\),]+}; - while ($args =3D~ /$arg_expr,/) { - $args =3D~ s/($arg_expr),/$1#/g; - } - - foreach my $arg (split($splitter, $args)) { - # strip comments - $arg =3D~ s/\/\*.*\*\///; - # ignore argument attributes - $arg =3D~ s/\sPOS0?\s/ /; - # strip leading/trailing spaces - $arg =3D~ s/^\s*//; - $arg =3D~ s/\s*$//; - $arg =3D~ s/\s+/ /; - - if ($arg =3D~ /^#/) { - # Treat preprocessor directive as a typeless variable just to = fill - # corresponding data structures "correctly". Catch it later in - # output_* subs. - push_parameter($arg, "", "", $file); - } elsif ($arg =3D~ m/\(.+\)\s*\(/) { - # pointer-to-function - $arg =3D~ tr/#/,/; - $arg =3D~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/; - $param =3D $1; - $type =3D $arg; - $type =3D~ s/([^\(]+\(\*?)\s*$param/$1/; - save_struct_actual($param); - push_parameter($param, $type, $arg, $file, $declaration_name); - } elsif ($arg =3D~ m/\(.+\)\s*\[/) { - # array-of-pointers - $arg =3D~ tr/#/,/; - $arg =3D~ m/[^\(]+\(\s*\*\s*([\w\[\]\.]*?)\s*(\s*\[\s*[\w]+\s*= \]\s*)*\)/; - $param =3D $1; - $type =3D $arg; - $type =3D~ s/([^\(]+\(\*?)\s*$param/$1/; - save_struct_actual($param); - push_parameter($param, $type, $arg, $file, $declaration_name); - } elsif ($arg) { - $arg =3D~ s/\s*:\s*/:/g; - $arg =3D~ s/\s*\[/\[/g; - - my @args =3D split('\s*,\s*', $arg); - if ($args[0] =3D~ m/\*/) { - $args[0] =3D~ s/(\*+)\s*/ $1/; - } - - my @first_arg; - if ($args[0] =3D~ /^(.*\s+)(.*?\[.*\].*)$/) { - shift @args; - push(@first_arg, split('\s+', $1)); - push(@first_arg, $2); - } else { - @first_arg =3D split('\s+', shift @args); - } - - unshift(@args, pop @first_arg); - $type =3D join " ", @first_arg; - - foreach $param (@args) { - if ($param =3D~ m/^(\*+)\s*(.*)/) { - save_struct_actual($2); - - push_parameter($2, "$type $1", $arg, $file, $declarati= on_name); - } elsif ($param =3D~ m/(.*?):(\w+)/) { - if ($type ne "") { # skip unnamed bit-fields - save_struct_actual($1); - push_parameter($1, "$type:$2", $arg, $file, $decla= ration_name) - } - } else { - save_struct_actual($param); - push_parameter($param, $type, $arg, $file, $declaratio= n_name); - } - } - } - } -} - -sub push_parameter($$$$$) { - my $param =3D shift; - my $type =3D shift; - my $org_arg =3D shift; - my $file =3D shift; - my $declaration_name =3D shift; - - if (($anon_struct_union =3D=3D 1) && ($type eq "") && - ($param eq "}")) { - return; # ignore the ending }; from anon. struct/union - } - - $anon_struct_union =3D 0; - $param =3D~ s/[\[\)].*//; - - if ($type eq "" && $param =3D~ /\.\.\.$/) - { - if (!$param =3D~ /\w\.\.\.$/) { - # handles unnamed variable parameters - $param =3D "..."; - } elsif ($param =3D~ /\w\.\.\.$/) { - # for named variable parameters of the form `x...`, remove the= dots - $param =3D~ s/\.\.\.$//; - } - if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq= "") { - $parameterdescs{$param} =3D "variable arguments"; - } - } - elsif ($type eq "" && ($param eq "" or $param eq "void")) - { - $param=3D"void"; - $parameterdescs{void} =3D "no arguments"; - } - elsif ($type eq "" && ($param eq "struct" or $param eq "union")) - # handle unnamed (anonymous) union or struct: - { - $type =3D $param; - $param =3D "{unnamed_" . $param . "}"; - $parameterdescs{$param} =3D "anonymous\n"; - $anon_struct_union =3D 1; - } - elsif ($param =3D~ "__cacheline_group" ) - # handle cache group enforcing variables: they do not need be describe= d in header files - { - return; # ignore __cacheline_group_begin and __cacheline_group_end - } - - # warn if parameter has no description - # (but ignore ones starting with # as these are not parameters - # but inline preprocessor statements); - # Note: It will also ignore void params and unnamed structs/unions - if (!defined $parameterdescs{$param} && $param !~ /^#/) { - $parameterdescs{$param} =3D $undescribed; - - if (show_warnings($type, $declaration_name) && $param !~ /\./) { - emit_warning("${file}:$.", "Function parameter or struct membe= r '$param' not described in '$declaration_name'\n"); - } - } - - # strip spaces from $param so that it is one continuous string - # on @parameterlist; - # this fixes a problem where check_sections() cannot find - # a parameter like "addr[6 + 2]" because it actually appears - # as "addr[6", "+", "2]" on the parameter list; - # but it's better to maintain the param string unchanged for output, - # so just weaken the string compare in check_sections() to ignore - # "[blah" in a parameter string; - ###$param =3D~ s/\s*//g; - push @parameterlist, $param; - $org_arg =3D~ s/\s\s+/ /g; - $parametertypes{$param} =3D $org_arg; -} - -sub check_sections($$$$$) { - my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) =3D @_; - my @sects =3D split ' ', $sectcheck; - my @prms =3D split ' ', $prmscheck; - my $err; - my ($px, $sx); - my $prm_clean; # strip trailing "[array size]" and/or beginning= "*" - - foreach $sx (0 .. $#sects) { - $err =3D 1; - foreach $px (0 .. $#prms) { - $prm_clean =3D $prms[$px]; - $prm_clean =3D~ s/\[.*\]//; - $prm_clean =3D~ s/$attribute//i; - # ignore array size in a parameter string; - # however, the original param string may contain - # spaces, e.g.: addr[6 + 2] - # and this appears in @prms as "addr[6" since the - # parameter list is split at spaces; - # hence just ignore "[..." for the sections check; - $prm_clean =3D~ s/\[.*//; - - ##$prm_clean =3D~ s/^\**//; - if ($prm_clean eq $sects[$sx]) { - $err =3D 0; - last; - } - } - if ($err) { - if ($decl_type eq "function") { - emit_warning("${file}:$.", - "Excess function parameter " . - "'$sects[$sx]' " . - "description in '$decl_name'\n"); - } elsif (($decl_type eq "struct") or - ($decl_type eq "union")) { - emit_warning("${file}:$.", - "Excess $decl_type member " . - "'$sects[$sx]' " . - "description in '$decl_name'\n"); - } - } - } -} - -## -# Checks the section describing the return value of a function. -sub check_return_section { - my $file =3D shift; - my $declaration_name =3D shift; - my $return_type =3D shift; - - # Ignore an empty return type (It's a macro) - # Ignore functions with a "void" return type. (But don't ignore "void = *") - if (($return_type eq "") || ($return_type =3D~ /void\s*\w*\s*$/)) { - return; - } - - if (!defined($sections{$section_return}) || - $sections{$section_return} eq "") - { - emit_warning("${file}:$.", - "No description found for return value of " . - "'$declaration_name'\n"); - } -} - -## -# takes a function prototype and the name of the current file being -# processed and spits out all the details stored in the global -# arrays/hashes. -sub dump_function($$) { - my $prototype =3D shift; - my $file =3D shift; - my $func_macro =3D 0; - - print_lineno($new_start_line); - - $prototype =3D~ s/^static +//; - $prototype =3D~ s/^extern +//; - $prototype =3D~ s/^asmlinkage +//; - $prototype =3D~ s/^inline +//; - $prototype =3D~ s/^__inline__ +//; - $prototype =3D~ s/^__inline +//; - $prototype =3D~ s/^__always_inline +//; - $prototype =3D~ s/^noinline +//; - $prototype =3D~ s/^__FORTIFY_INLINE +//; - $prototype =3D~ s/__init +//; - $prototype =3D~ s/__init_or_module +//; - $prototype =3D~ s/__deprecated +//; - $prototype =3D~ s/__flatten +//; - $prototype =3D~ s/__meminit +//; - $prototype =3D~ s/__must_check +//; - $prototype =3D~ s/__weak +//; - $prototype =3D~ s/__sched +//; - $prototype =3D~ s/_noprof//; - $prototype =3D~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//; - $prototype =3D~ s/__(?:re)?alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) += //; - $prototype =3D~ s/__diagnose_as\s*\(\s*\S+\s*(?:,\s*\d+\s*)*\) +//; - $prototype =3D~ s/DECL_BUCKET_PARAMS\s*\(\s*(\S+)\s*,\s*(\S+)\s*\)/$1,= $2/; - my $define =3D $prototype =3D~ s/^#\s*define\s+//; #ak added - $prototype =3D~ s/__attribute_const__ +//; - $prototype =3D~ s/__attribute__\s*\(\( - (?: - [\w\s]++ # attribute name - (?:\([^)]*+\))? # attribute arguments - \s*+,? # optional comma at the end - )+ - \)\)\s+//x; - - # Yes, this truly is vile. We are looking for: - # 1. Return type (may be nothing if we're looking at a macro) - # 2. Function name - # 3. Function parameters. - # - # All the while we have to watch out for function pointer parameters - # (which IIRC is what the two sections are for), C types (these - # regexps don't even start to express all the possibilities), and - # so on. - # - # If you mess with these regexps, it's a good idea to check that - # the following functions' documentation still comes out right: - # - parport_register_device (function pointer parameters) - # - atomic_set (macro) - # - pci_match_device, __copy_to_user (long return type) - my $name =3D qr{[a-zA-Z0-9_~:]+}; - my $prototype_end1 =3D qr{[^\(]*}; - my $prototype_end2 =3D qr{[^\{]*}; - my $prototype_end =3D qr{\(($prototype_end1|$prototype_end2)\)}; - my $type1 =3D qr{[\w\s]+}; - my $type2 =3D qr{$type1\*+}; - - if ($define && $prototype =3D~ m/^()($name)\s+/) { - # This is an object-like macro, it has no return type and no param= eter - # list. - # Function-like macros are not allowed to have spaces between - # declaration_name and opening parenthesis (notice the \s+). - $return_type =3D $1; - $declaration_name =3D $2; - $func_macro =3D 1; - } elsif ($prototype =3D~ m/^()($name)\s*$prototype_end/ || - $prototype =3D~ m/^($type1)\s+($name)\s*$prototype_end/ || - $prototype =3D~ m/^($type2+)\s*($name)\s*$prototype_end/) { - $return_type =3D $1; - $declaration_name =3D $2; - my $args =3D $3; - - create_parameterlist($args, ',', $file, $declaration_name); - } else { - emit_warning("${file}:$.", "cannot understand function prototype: = '$prototype'\n"); - return; - } - - if ($identifier ne $declaration_name) { - emit_warning("${file}:$.", "expecting prototype for $identifier().= Prototype was for $declaration_name() instead\n"); - return; - } - - my $prms =3D join " ", @parameterlist; - check_sections($file, $declaration_name, "function", $sectcheck, $prms= ); - - # This check emits a lot of warnings at the moment, because many - # functions don't have a 'Return' doc section. So until the number - # of warnings goes sufficiently down, the check is only performed in - # -Wreturn mode. - # TODO: always perform the check. - if ($Wreturn && !$func_macro) { - check_return_section($file, $declaration_name, $return_type); - } - - # The function parser can be called with a typedef parameter. - # Handle it. - if ($return_type =3D~ /typedef/) { - output_declaration($declaration_name, - 'function', - {'function' =3D> $declaration_name, - 'typedef' =3D> 1, - 'module' =3D> $modulename, - 'functiontype' =3D> $return_type, - 'parameterlist' =3D> \@parameterlist, - 'parameterdescs' =3D> \%parameterdescs, - 'parametertypes' =3D> \%parametertypes, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose, - 'func_macro' =3D> $func_macro - }); - } else { - output_declaration($declaration_name, - 'function', - {'function' =3D> $declaration_name, - 'module' =3D> $modulename, - 'functiontype' =3D> $return_type, - 'parameterlist' =3D> \@parameterlist, - 'parameterdescs' =3D> \%parameterdescs, - 'parametertypes' =3D> \%parametertypes, - 'sectionlist' =3D> \@sectionlist, - 'sections' =3D> \%sections, - 'purpose' =3D> $declaration_purpose, - 'func_macro' =3D> $func_macro - }); - } -} - -sub reset_state { - $function =3D ""; - %parameterdescs =3D (); - %parametertypes =3D (); - @parameterlist =3D (); - %sections =3D (); - @sectionlist =3D (); - $sectcheck =3D ""; - $struct_actual =3D ""; - $prototype =3D ""; - - $state =3D STATE_NORMAL; - $inline_doc_state =3D STATE_INLINE_NA; -} - -sub tracepoint_munge($) { - my $file =3D shift; - my $tracepointname =3D 0; - my $tracepointargs =3D 0; - - if ($prototype =3D~ m/TRACE_EVENT\((.*?),/) { - $tracepointname =3D $1; - } - if ($prototype =3D~ m/DEFINE_SINGLE_EVENT\((.*?),/) { - $tracepointname =3D $1; - } - if ($prototype =3D~ m/DEFINE_EVENT\((.*?),(.*?),/) { - $tracepointname =3D $2; - } - $tracepointname =3D~ s/^\s+//; #strip leading whitespace - if ($prototype =3D~ m/TP_PROTO\((.*?)\)/) { - $tracepointargs =3D $1; - } - if (($tracepointname eq 0) || ($tracepointargs eq 0)) { - emit_warning("${file}:$.", "Unrecognized tracepoint format: \n". - "$prototype\n"); - } else { - $prototype =3D "static inline void trace_$tracepointname($tracepoi= ntargs)"; - $identifier =3D "trace_$identifier"; - } -} - -sub syscall_munge() { - my $void =3D 0; - - $prototype =3D~ s@[\r\n]+@ @gos; # strip newlines/CR's -## if ($prototype =3D~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { - if ($prototype =3D~ m/SYSCALL_DEFINE0/) { - $void =3D 1; -## $prototype =3D "long sys_$1(void)"; - } - - $prototype =3D~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & f= unc name - if ($prototype =3D~ m/long (sys_.*?),/) { - $prototype =3D~ s/,/\(/; - } elsif ($void) { - $prototype =3D~ s/\)/\(void\)/; - } - - # now delete all of the odd-number commas in $prototype - # so that arg types & arg names don't have a comma between them - my $count =3D 0; - my $len =3D length($prototype); - if ($void) { - $len =3D 0; # skip the for-loop - } - for (my $ix =3D 0; $ix < $len; $ix++) { - if (substr($prototype, $ix, 1) eq ',') { - $count++; - if ($count % 2 =3D=3D 1) { - substr($prototype, $ix, 1) =3D ' '; - } - } - } -} - -sub process_proto_function($$) { - my $x =3D shift; - my $file =3D shift; - - $x =3D~ s@\/\/.*$@@gos; # strip C99-style comments to end of line - - if ($x =3D~ /^#/ && $x !~ /^#\s*define/) { - # do nothing - } elsif ($x =3D~ /([^\{]*)/) { - $prototype .=3D $1; - } - - if (($x =3D~ /\{/) || ($x =3D~ /\#\s*define/) || ($x =3D~ /;/)) { - $prototype =3D~ s@/\*.*?\*/@@gos; # strip comments. - $prototype =3D~ s@[\r\n]+@ @gos; # strip newlines/cr's. - $prototype =3D~ s@^\s+@@gos; # strip leading spaces - - # Handle prototypes for function pointers like: - # int (*pcs_config)(struct foo) - $prototype =3D~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos; - - if ($prototype =3D~ /SYSCALL_DEFINE/) { - syscall_munge(); - } - if ($prototype =3D~ /TRACE_EVENT/ || $prototype =3D~ /DEFINE_EVENT= / || - $prototype =3D~ /DEFINE_SINGLE_EVENT/) - { - tracepoint_munge($file); - } - dump_function($prototype, $file); - reset_state(); - } -} - -sub process_proto_type($$) { - my $x =3D shift; - my $file =3D shift; - - $x =3D~ s@[\r\n]+@ @gos; # strip newlines/cr's. - $x =3D~ s@^\s+@@gos; # strip leading spaces - $x =3D~ s@\s+$@@gos; # strip trailing spaces - $x =3D~ s@\/\/.*$@@gos; # strip C99-style comments to end of line - - if ($x =3D~ /^#/) { - # To distinguish preprocessor directive from regular declaration l= ater. - $x .=3D ";"; - } - - while (1) { - if ( $x =3D~ /([^\{\};]*)([\{\};])(.*)/ ) { - if( length $prototype ) { - $prototype .=3D " " - } - $prototype .=3D $1 . $2; - ($2 eq '{') && $brcount++; - ($2 eq '}') && $brcount--; - if (($2 eq ';') && ($brcount =3D=3D 0)) { - dump_declaration($prototype, $file); - reset_state(); - last; - } - $x =3D $3; - } else { - $prototype .=3D $x; - last; - } - } -} - - -sub map_filename($) { - my $file; - my ($orig_file) =3D @_; - - if (defined($ENV{'SRCTREE'})) { - $file =3D "$ENV{'SRCTREE'}" . "/" . $orig_file; - } else { - $file =3D $orig_file; - } - - return $file; -} - -sub process_export_file($) { - my ($orig_file) =3D @_; - my $file =3D map_filename($orig_file); - - if (!open(IN,"<$file")) { - print STDERR "Error: Cannot open file $file\n"; - ++$errors; - return; - } - - while () { - if (/$export_symbol/) { - next if (defined($nosymbol_table{$2})); - $function_table{$2} =3D 1; - } - if (/$export_symbol_ns/) { - next if (defined($nosymbol_table{$2})); - $function_table{$2} =3D 1; - } - } - - close(IN); -} - -# -# Parsers for the various processing states. -# -# STATE_NORMAL: looking for the /** to begin everything. -# -sub process_normal() { - if (/$doc_start/o) { - $state =3D STATE_NAME; # next line is always the function n= ame - $declaration_start_line =3D $. + 1; - } -} - -# -# STATE_NAME: Looking for the "name - description" line -# -sub process_name($$) { - my $file =3D shift; - my $descr; - - if (/$doc_block/o) { - $state =3D STATE_DOCBLOCK; - $contents =3D ""; - $new_start_line =3D $.; - - if ( $1 eq "" ) { - $section =3D $section_intro; - } else { - $section =3D $1; - } - } elsif (/$doc_decl/o) { - $identifier =3D $1; - my $is_kernel_comment =3D 0; - my $decl_start =3D qr{$doc_com}; - # test for pointer declaration type, foo * bar() - desc - my $fn_type =3D qr{\w+\s*\*\s*}; - my $parenthesis =3D qr{\(\w*\)}; - my $decl_end =3D qr{[-:].*}; - if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) { - $identifier =3D $1; - } - if ($identifier =3D~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) { - $decl_type =3D $1; - $identifier =3D $2; - $is_kernel_comment =3D 1; - } - # Look for foo() or static void foo() - description; or misspelt - # identifier - elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ = || - /^$decl_start$fn_type?(\w+[^-:]*)$parenthesis?\s*$decl_end$/) { - $identifier =3D $1; - $decl_type =3D 'function'; - $identifier =3D~ s/^define\s+//; - $is_kernel_comment =3D 1; - } - $identifier =3D~ s/\s+$//; - - $state =3D STATE_BODY; - # if there's no @param blocks need to set up default section - # here - $contents =3D ""; - $section =3D $section_default; - $new_start_line =3D $. + 1; - if (/[-:](.*)/) { - # strip leading/trailing/multiple spaces - $descr=3D $1; - $descr =3D~ s/^\s*//; - $descr =3D~ s/\s*$//; - $descr =3D~ s/\s+/ /g; - $declaration_purpose =3D $descr; - $state =3D STATE_BODY_MAYBE; - } else { - $declaration_purpose =3D ""; - } - - if (!$is_kernel_comment) { - emit_warning("${file}:$.", "This comment starts with '/**', bu= t isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\= n$_"); - $state =3D STATE_NORMAL; - } - - if (($declaration_purpose eq "") && $Wshort_desc) { - emit_warning("${file}:$.", "missing initial short description = on line:\n$_"); - } - - if ($identifier eq "" && $decl_type ne "enum") { - emit_warning("${file}:$.", "wrong kernel-doc identifier on lin= e:\n$_"); - $state =3D STATE_NORMAL; - } - - if ($verbose) { - print STDERR "${file}:$.: info: Scanning doc for $decl_type $i= dentifier\n"; - } - } else { - emit_warning("${file}:$.", "Cannot understand $_ on line $. - I th= ought it was a doc line\n"); - $state =3D STATE_NORMAL; - } -} - - -# -# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment. -# -sub process_body($$) { - my $file =3D shift; - - if ($state =3D=3D STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) { - dump_section($file, $section, $contents); - $section =3D $section_default; - $new_start_line =3D $.; - $contents =3D ""; - } - - if (/$doc_sect/i) { # case insensitive for supported section names - $newsection =3D $1; - $newcontents =3D $2; - - # map the supported section names to the canonical names - if ($newsection =3D~ m/^description$/i) { - $newsection =3D $section_default; - } elsif ($newsection =3D~ m/^context$/i) { - $newsection =3D $section_context; - } elsif ($newsection =3D~ m/^returns?$/i) { - $newsection =3D $section_return; - } elsif ($newsection =3D~ m/^\@return$/) { - # special: @return is a section, not a param description - $newsection =3D $section_return; - } - - if (($contents ne "") && ($contents ne "\n")) { - dump_section($file, $section, $contents); - $section =3D $section_default; - } - - $state =3D STATE_BODY; - $contents =3D $newcontents; - $new_start_line =3D $.; - while (substr($contents, 0, 1) eq " ") { - $contents =3D substr($contents, 1); - } - if ($contents ne "") { - $contents .=3D "\n"; - } - $section =3D $newsection; - $leading_space =3D undef; - } elsif (/$doc_end/) { - if (($contents ne "") && ($contents ne "\n")) { - dump_section($file, $section, $contents); - $section =3D $section_default; - $contents =3D ""; - } - # look for doc_com + + doc_end: - if ($_ =3D~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { - emit_warning("${file}:$.", "suspicious ending line: $_"); - } - - $prototype =3D ""; - $state =3D STATE_PROTO; - $brcount =3D 0; - $new_start_line =3D $. + 1; - } elsif (/$doc_content/) { - if ($1 eq "") { - if ($section eq $section_context) { - dump_section($file, $section, $contents); - $section =3D $section_default; - $contents =3D ""; - $new_start_line =3D $.; - $state =3D STATE_BODY; - } else { - if ($section ne $section_default) { - $state =3D STATE_BODY_WITH_BLANK_LINE; - } else { - $state =3D STATE_BODY; - } - $contents .=3D "\n"; - } - } elsif ($state =3D=3D STATE_BODY_MAYBE) { - # Continued declaration purpose - chomp($declaration_purpose); - $declaration_purpose .=3D " " . $1; - $declaration_purpose =3D~ s/\s+/ /g; - } else { - my $cont =3D $1; - if ($section =3D~ m/^@/ || $section eq $section_context) { - if (!defined $leading_space) { - if ($cont =3D~ m/^(\s+)/) { - $leading_space =3D $1; - } else { - $leading_space =3D ""; - } - } - $cont =3D~ s/^$leading_space//; - } - $contents .=3D $cont . "\n"; - } - } else { - # i dont know - bad line? ignore. - emit_warning("${file}:$.", "bad line: $_"); - } -} - - -# -# STATE_PROTO: reading a function/whatever prototype. -# -sub process_proto($$) { - my $file =3D shift; - - if (/$doc_inline_oneline/) { - $section =3D $1; - $contents =3D $2; - if ($contents ne "") { - $contents .=3D "\n"; - dump_section($file, $section, $contents); - $section =3D $section_default; - $contents =3D ""; - } - } elsif (/$doc_inline_start/) { - $state =3D STATE_INLINE; - $inline_doc_state =3D STATE_INLINE_NAME; - } elsif ($decl_type eq 'function') { - process_proto_function($_, $file); - } else { - process_proto_type($_, $file); - } -} - -# -# STATE_DOCBLOCK: within a DOC: block. -# -sub process_docblock($$) { - my $file =3D shift; - - if (/$doc_end/) { - dump_doc_section($file, $section, $contents); - $section =3D $section_default; - $contents =3D ""; - $function =3D ""; - %parameterdescs =3D (); - %parametertypes =3D (); - @parameterlist =3D (); - %sections =3D (); - @sectionlist =3D (); - $prototype =3D ""; - $state =3D STATE_NORMAL; - } elsif (/$doc_content/) { - if ( $1 eq "" ) { - $contents .=3D $blankline; - } else { - $contents .=3D $1 . "\n"; - } - } -} - -# -# STATE_INLINE: docbook comments within a prototype. -# -sub process_inline($$) { - my $file =3D shift; - - # First line (state 1) needs to be a @parameter - if ($inline_doc_state =3D=3D STATE_INLINE_NAME && /$doc_inline_sect/o)= { - $section =3D $1; - $contents =3D $2; - $new_start_line =3D $.; - if ($contents ne "") { - while (substr($contents, 0, 1) eq " ") { - $contents =3D substr($contents, 1); - } - $contents .=3D "\n"; - } - $inline_doc_state =3D STATE_INLINE_TEXT; - # Documentation block end */ - } elsif (/$doc_inline_end/) { - if (($contents ne "") && ($contents ne "\n")) { - dump_section($file, $section, $contents); - $section =3D $section_default; - $contents =3D ""; - } - $state =3D STATE_PROTO; - $inline_doc_state =3D STATE_INLINE_NA; - # Regular text - } elsif (/$doc_content/) { - if ($inline_doc_state =3D=3D STATE_INLINE_TEXT) { - $contents .=3D $1 . "\n"; - # nuke leading blank lines - if ($contents =3D~ /^\s*$/) { - $contents =3D ""; - } - } elsif ($inline_doc_state =3D=3D STATE_INLINE_NAME) { - $inline_doc_state =3D STATE_INLINE_ERROR; - emit_warning("${file}:$.", "Incorrect use of kernel-doc format= : $_"); - } - } -} - - -sub process_file($) { - my $file; - my ($orig_file) =3D @_; - - $file =3D map_filename($orig_file); - - if (!open(IN_FILE,"<$file")) { - print STDERR "Error: Cannot open file $file\n"; - ++$errors; - return; - } - - $. =3D 1; - - $section_counter =3D 0; - while () { - while (!/^ \*/ && s/\\\s*$//) { - $_ .=3D ; - } - # Replace tabs by spaces - while ($_ =3D~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}; - # Hand this line to the appropriate state handler - if ($state =3D=3D STATE_NORMAL) { - process_normal(); - } elsif ($state =3D=3D STATE_NAME) { - process_name($file, $_); - } elsif ($state =3D=3D STATE_BODY || $state =3D=3D STATE_BODY_MAYB= E || - $state =3D=3D STATE_BODY_WITH_BLANK_LINE) { - process_body($file, $_); - } elsif ($state =3D=3D STATE_INLINE) { # scanning for inline param= eters - process_inline($file, $_); - } elsif ($state =3D=3D STATE_PROTO) { - process_proto($file, $_); - } elsif ($state =3D=3D STATE_DOCBLOCK) { - process_docblock($file, $_); - } - } - - # Make sure we got something interesting. - if (!$section_counter && $output_mode ne "none") { - if ($output_selection =3D=3D OUTPUT_INCLUDE) { - emit_warning("${file}:1", "'$_' not found\n") - for keys %function_table; - } else { - emit_warning("${file}:1", "no structured comments found\n"); - } - } - close IN_FILE; -} - -$kernelversion =3D get_kernel_version(); - -# generate a sequence of code that will splice in highlighting information -# using the s// operator. -for (my $k =3D 0; $k < @highlights; $k++) { - my $pattern =3D $highlights[$k][0]; - my $result =3D $highlights[$k][1]; -# print STDERR "scanning pattern:$pattern, highlight:($result)\n"; - $dohighlight .=3D "\$contents =3D~ s:$pattern:$result:gs;\n"; -} - -if ($output_selection =3D=3D OUTPUT_EXPORTED || - $output_selection =3D=3D OUTPUT_INTERNAL) { - - push(@export_file_list, @ARGV); - - foreach (@export_file_list) { - chomp; - process_export_file($_); - } -} - -foreach (@ARGV) { - chomp; - process_file($_); -} -if ($verbose && $errors) { - print STDERR "$errors errors\n"; -} -if ($verbose && $warnings) { - print STDERR "$warnings warnings\n"; -} - -if ($Werror && $warnings) { - print STDERR "$warnings warnings as Errors\n"; - exit($warnings); -} else { - exit($output_mode eq "none" ? 0 : $errors) -} - -__END__ - -=3Dhead1 OPTIONS - -=3Dhead2 Output format selection (mutually exclusive): - -=3Dover 8 - -=3Ditem -man - -Output troff manual page format. - -=3Ditem -rst - -Output reStructuredText format. This is the default. - -=3Ditem -none - -Do not output documentation, only warnings. - -=3Dback - -=3Dhead2 Output format modifiers - -=3Dhead3 reStructuredText only - -=3Dhead2 Output selection (mutually exclusive): - -=3Dover 8 - -=3Ditem -export - -Only output documentation for the symbols that have been exported using -EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE. - -=3Ditem -internal - -Only output documentation for the symbols that have NOT been exported using -EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE. - -=3Ditem -function NAME - -Only output documentation for the given function or DOC: section title. -All other functions and DOC: sections are ignored. - -May be specified multiple times. - -=3Ditem -nosymbol NAME - -Exclude the specified symbol from the output documentation. - -May be specified multiple times. - -=3Dback - -=3Dhead2 Output selection modifiers: - -=3Dover 8 - -=3Ditem -no-doc-sections - -Do not output DOC: sections. - -=3Ditem -export-file FILE - -Specify an additional FILE in which to look for EXPORT_SYMBOL information. - -To be used with -export or -internal. - -May be specified multiple times. - -=3Dback - -=3Dhead3 reStructuredText only - -=3Dover 8 - -=3Ditem -enable-lineno - -Enable output of .. LINENO lines. - -=3Dback - -=3Dhead2 Other parameters: - -=3Dover 8 - -=3Ditem -h, -help - -Print this help. - -=3Ditem -v - -Verbose output, more warnings and other information. - -=3Ditem -Werror - -Treat warnings as errors. - -=3Dback - -=3Dcut --=20 2.51.0