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 <corbet@xxxxxxx> --- 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 => tools/doc}/parse-headers.pl | 4 ++-- 6 files changed, 12 insertions(+), 13 deletions(-) rename {Documentation/sphinx => 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. .. _parse_headers: -parse_headers.pl +parse-headers.pl ^^^^^^^^^^^^^^^^ NAME **** -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. @@ -30,7 +30,7 @@ SYNOPSIS ******** -\ **parse_headers.pl**\ [<options>] <C_FILE> <OUT_FILE> [<EXCEPTIONS_FILE>] +\ **parse-headers.pl**\ [<options>] <C_FILE> <OUT_FILE> [<EXCEPTIONS_FILE>] Where <options> can be: --debug, --help or --usage. 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``. .. _it_parse_headers: -parse_headers.pl +parse-headers.pl ^^^^^^^^^^^^^^^^ NOME **** -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 SINTASSI ******** -\ **parse_headers.pl**\ [<options>] <C_FILE> <OUT_FILE> [<EXCEPTIONS_FILE>] +\ **parse-headers.pl**\ [<options>] <C_FILE> <OUT_FILE> [<EXCEPTIONS_FILE>] Dove <options> può essere: --debug, --usage o --help. 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将生成警告。这有助于保持用户空间API文档与内核更改 .. _parse_headers_zh: -parse_headers.pl +parse-headers.pl ---------------- 脚本名称 ~~~~~~~~ -parse_headers.pl——解析一个C文件,识别函数、结构体、枚举、定义并对Sphinx文档 +parse-headers.pl——解析一个C文件,识别函数、结构体、枚举、定义并对Sphinx文档 创建交叉引用。 @@ -34,7 +34,7 @@ parse_headers.pl——解析一个C文件,识别函数、结构体、枚举、 ~~~~~~~~ -\ **parse_headers.pl**\ [<选项>] <C文件> <输出文件> [<例外文件>] +\ **parse-headers.pl**\ [<选项>] <C文件> <输出文件> [<例外文件>] <选项> 可以是: --debug, --help 或 --usage 。 diff --git a/Documentation/userspace-api/media/Makefile b/Documentation/userspace-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 SRC_DIR=$(srctree)/Documentation/userspace-api/media -PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl +PARSER = $(srctree)/tools/doc/parse-headers.pl UAPI = $(srctree)/include/uapi/linux KAPI = $(srctree)/include/linux diff --git a/MAINTAINERS b/MAINTAINERS index 2f1374130240..c2d2ce92bf79 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7338,7 +7338,6 @@ DOCUMENTATION SCRIPTS M: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx> L: linux-doc@xxxxxxxxxxxxxxx S: Maintained -F: Documentation/sphinx/parse-headers.pl F: tools/doc/ DOCUMENTATION/ITALIAN diff --git a/Documentation/sphinx/parse-headers.pl b/tools/doc/parse-headers.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__ =head1 NAME -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. =head1 SYNOPSIS -B<parse_headers.pl> [<options>] <C_FILE> <OUT_FILE> [<EXCEPTIONS_FILE>] +B<parse-headers.pl> [<options>] <C_FILE> <OUT_FILE> [<EXCEPTIONS_FILE>] Where <options> can be: --debug, --help or --usage. -- 2.50.1