From nobody Sat Oct 4 19:19:13 2025 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 6D63C30AACA; Wed, 13 Aug 2025 21:32:37 +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=1755120759; cv=none; b=n5VBHJTgXiPNNd3Jqx/7pLiFm6EgSiiNGvldpAz3khpQTKw80aADJ0hAHPpq3tuVKqq3NlSFIdgQSJ+J6Du0nLAW6/vzRUmtLTEbzEoGPKN1NTw12sXoEPY3QQyTcEXzaZD+YmtZTFeL8TuU6egudGZIC16MvBPaPUw+ETndS6A= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1755120759; c=relaxed/simple; bh=bCqcEuYXIZ5FS0iGGlt/V5k155zzYR3s8m9do/BeNFw=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=dscQwURhrY/ZYU+D645O7R2BO32mHZqPCfpHZ37Bg0sRoYOh1oETWIFJi+4Ffb44F3cssfYr/zGHJ0Uc/Hoa7XLwUoRuBZ+8CnLRl/C1jbxNEZVj/fK40j/TfBtKnh8xezNnYznLEhfcn6ateYpypVpmkCJDP9ZNrfBizy7tg2Q= 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=hhVafAcs; 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="hhVafAcs" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 9AC0A40AFC DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1755120753; bh=n0Uge/EydivOUALbTlxUcyMHQ+hRH50kMHQoRmNZbsc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=hhVafAcso4jU6ES5Kl6Km6bZcrjTFmUX3wtKUgbPPO2sA3IFGdhkIQQynqR8X2eh7 rYmgWmaEUjjpOxfMONtofgT0XumzXBf5THhtQCau7u0LQ9ZxuLEUuJyYhtUOSTWx6l Hyu0td5mqz3Eo5wCCKaE3Cw/U40ySREr9pCzBktumEnP+RCeGyJtU5mD/jqNPJ4Wx5 bfOATRAr2qKPAi0znNDLm8djZrD7K4iDurtFG4wZeD3Xw3fTMBPZj6sJtnbVC0F+Fa nKB6li2AqX3Frkwo9VpMSaToI4k5a7LgPxb3MbKrLivoy6ZUYufE2n2Oqu5a7ocyZt xkACiZS+frnew== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id 9AC0A40AFC; Wed, 13 Aug 2025 21:32:32 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Randy Dunlap , Jonathan Corbet Subject: [PATCH 09/13] docs: move parse-headers.pl to tools/doc Date: Wed, 13 Aug 2025 15:32:08 -0600 Message-ID: <20250813213218.198582-10-corbet@lwn.net> X-Mailer: git-send-email 2.50.1 In-Reply-To: <20250813213218.198582-1-corbet@lwn.net> References: <20250813213218.198582-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 the tool and fix all the references, including the numerous ones that said "parse_headers" instead of "parse-headers". Signed-off-by: Jonathan Corbet --- Documentation/doc-guide/parse-headers.rst | 6 +++--- .../translations/it_IT/doc-guide/parse-headers.rst | 6 +++--- .../translations/zh_CN/doc-guide/parse-headers.rst | 6 +++--- Documentation/userspace-api/media/Makefile | 2 +- MAINTAINERS | 1 - {Documentation/sphinx =3D> tools/doc}/parse-headers.pl | 4 ++-- 6 files changed, 12 insertions(+), 13 deletions(-) rename {Documentation/sphinx =3D> tools/doc}/parse-headers.pl (98%) diff --git a/Documentation/doc-guide/parse-headers.rst b/Documentation/doc-= guide/parse-headers.rst index 204b025f1349..954cd81523a0 100644 --- a/Documentation/doc-guide/parse-headers.rst +++ b/Documentation/doc-guide/parse-headers.rst @@ -15,14 +15,14 @@ about how to use it inside the Kernel tree. =20 .. _parse_headers: =20 -parse_headers.pl +parse-headers.pl ^^^^^^^^^^^^^^^^ =20 NAME **** =20 =20 -parse_headers.pl - parse a C file, in order to identify functions, structs, +parse-headers.pl - parse a C file, in order to identify functions, structs, enums and defines and create cross-references to a Sphinx book. =20 =20 @@ -30,7 +30,7 @@ SYNOPSIS ******** =20 =20 -\ **parse_headers.pl**\ [] [] +\ **parse-headers.pl**\ [] [] =20 Where can be: --debug, --help or --usage. =20 diff --git a/Documentation/translations/it_IT/doc-guide/parse-headers.rst b= /Documentation/translations/it_IT/doc-guide/parse-headers.rst index 026a23e49767..45b6b6fc4fb5 100644 --- a/Documentation/translations/it_IT/doc-guide/parse-headers.rst +++ b/Documentation/translations/it_IT/doc-guide/parse-headers.rst @@ -20,21 +20,21 @@ consultate ``Documentation/userspace-api/media/Makefile= ``. =20 .. _it_parse_headers: =20 -parse_headers.pl +parse-headers.pl ^^^^^^^^^^^^^^^^ =20 NOME **** =20 =20 -parse_headers.pl - analizza i file C al fine di identificare funzioni, +parse-headers.pl - analizza i file C al fine di identificare funzioni, strutture, enumerati e definizioni, e creare riferimenti per Sphinx =20 SINTASSI ******** =20 =20 -\ **parse_headers.pl**\ [] [] +\ **parse-headers.pl**\ [] [] =20 Dove pu=C3=B2 essere: --debug, --usage o --help. =20 diff --git a/Documentation/translations/zh_CN/doc-guide/parse-headers.rst b= /Documentation/translations/zh_CN/doc-guide/parse-headers.rst index a08819e904ed..22253fea5da1 100644 --- a/Documentation/translations/zh_CN/doc-guide/parse-headers.rst +++ b/Documentation/translations/zh_CN/doc-guide/parse-headers.rst @@ -19,14 +19,14 @@ Sphinx=E5=B0=86=E7=94=9F=E6=88=90=E8=AD=A6=E5=91=8A=E3= =80=82=E8=BF=99=E6=9C=89=E5=8A=A9=E4=BA=8E=E4=BF=9D=E6=8C=81=E7=94=A8=E6=88= =B7=E7=A9=BA=E9=97=B4API=E6=96=87=E6=A1=A3=E4=B8=8E=E5=86=85=E6=A0=B8=E6=9B= =B4=E6=94=B9 =20 .. _parse_headers_zh: =20 -parse_headers.pl +parse-headers.pl ---------------- =20 =E8=84=9A=E6=9C=AC=E5=90=8D=E7=A7=B0 ~~~~~~~~ =20 =20 -parse_headers.pl=E2=80=94=E2=80=94=E8=A7=A3=E6=9E=90=E4=B8=80=E4=B8=AAC=E6= =96=87=E4=BB=B6=EF=BC=8C=E8=AF=86=E5=88=AB=E5=87=BD=E6=95=B0=E3=80=81=E7=BB= =93=E6=9E=84=E4=BD=93=E3=80=81=E6=9E=9A=E4=B8=BE=E3=80=81=E5=AE=9A=E4=B9=89= =E5=B9=B6=E5=AF=B9Sphinx=E6=96=87=E6=A1=A3 +parse-headers.pl=E2=80=94=E2=80=94=E8=A7=A3=E6=9E=90=E4=B8=80=E4=B8=AAC=E6= =96=87=E4=BB=B6=EF=BC=8C=E8=AF=86=E5=88=AB=E5=87=BD=E6=95=B0=E3=80=81=E7=BB= =93=E6=9E=84=E4=BD=93=E3=80=81=E6=9E=9A=E4=B8=BE=E3=80=81=E5=AE=9A=E4=B9=89= =E5=B9=B6=E5=AF=B9Sphinx=E6=96=87=E6=A1=A3 =E5=88=9B=E5=BB=BA=E4=BA=A4=E5=8F=89=E5=BC=95=E7=94=A8=E3=80=82 =20 =20 @@ -34,7 +34,7 @@ parse_headers.pl=E2=80=94=E2=80=94=E8=A7=A3=E6=9E=90=E4= =B8=80=E4=B8=AAC=E6=96=87=E4=BB=B6=EF=BC=8C=E8=AF=86=E5=88=AB=E5=87=BD=E6= =95=B0=E3=80=81=E7=BB=93=E6=9E=84=E4=BD=93=E3=80=81=E6=9E=9A=E4=B8=BE=E3=80= =81 ~~~~~~~~ =20 =20 -\ **parse_headers.pl**\ [<=E9=80=89=E9=A1=B9>] <=E8= =BE=93=E5=87=BA=E6=96=87=E4=BB=B6> [<=E4=BE=8B=E5=A4=96=E6=96=87=E4=BB=B6>] +\ **parse-headers.pl**\ [<=E9=80=89=E9=A1=B9>] <=E8= =BE=93=E5=87=BA=E6=96=87=E4=BB=B6> [<=E4=BE=8B=E5=A4=96=E6=96=87=E4=BB=B6>] =20 <=E9=80=89=E9=A1=B9> =E5=8F=AF=E4=BB=A5=E6=98=AF=EF=BC=9A --debug, --help = =E6=88=96 --usage =E3=80=82 =20 diff --git a/Documentation/userspace-api/media/Makefile b/Documentation/use= rspace-api/media/Makefile index 3d8aaf5c253b..632798bca615 100644 --- a/Documentation/userspace-api/media/Makefile +++ b/Documentation/userspace-api/media/Makefile @@ -3,7 +3,7 @@ # Rules to convert a .h file to inline RST documentation =20 SRC_DIR=3D$(srctree)/Documentation/userspace-api/media -PARSER =3D $(srctree)/Documentation/sphinx/parse-headers.pl +PARSER =3D $(srctree)/tools/doc/parse-headers.pl UAPI =3D $(srctree)/include/uapi/linux KAPI =3D $(srctree)/include/linux =20 diff --git a/MAINTAINERS b/MAINTAINERS index 2f1374130240..c2d2ce92bf79 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7338,7 +7338,6 @@ DOCUMENTATION SCRIPTS M: Mauro Carvalho Chehab L: linux-doc@vger.kernel.org S: Maintained -F: Documentation/sphinx/parse-headers.pl F: tools/doc/ =20 DOCUMENTATION/ITALIAN diff --git a/Documentation/sphinx/parse-headers.pl b/tools/doc/parse-header= s.pl similarity index 98% rename from Documentation/sphinx/parse-headers.pl rename to tools/doc/parse-headers.pl index 7b1458544e2e..47b90bf8c96d 100755 --- a/Documentation/sphinx/parse-headers.pl +++ b/tools/doc/parse-headers.pl @@ -340,12 +340,12 @@ __END__ =20 =3Dhead1 NAME =20 -parse_headers.pl - parse a C file, in order to identify functions, structs, +parse-headers.pl - parse a C file, in order to identify functions, structs, enums and defines and create cross-references to a Sphinx book. =20 =3Dhead1 SYNOPSIS =20 -B [] [] +B [] [] =20 Where can be: --debug, --help or --usage. =20 --=20 2.50.1