Re: [PATCH 11/13] docs: move split-man.pl to tools/doc

From: Mauro Carvalho Chehab
Date: Wed Aug 13 2025 - 19:52:08 EST


Em Wed, 13 Aug 2025 15:32:10 -0600
Jonathan Corbet <corbet@xxxxxxx> escreveu:

> ...and update all references to it.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>

Btw, I was not aware of this. It makes sense to move its logic to
the new sphinx-build-wrapper Python script that I'll be submitting
soon.

>
> Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
> ---
> Documentation/doc-guide/kernel-doc.rst | 6 +++---
> Documentation/translations/it_IT/doc-guide/kernel-doc.rst | 2 +-
> Documentation/translations/zh_CN/doc-guide/kernel-doc.rst | 6 +++---
> {scripts => tools/doc}/split-man.pl | 0
> 4 files changed, 7 insertions(+), 7 deletions(-)
> rename {scripts => tools/doc}/split-man.pl (100%)
>
> diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
> index 6fc89d444ada..b7c8ce55323c 100644
> --- a/Documentation/doc-guide/kernel-doc.rst
> +++ b/Documentation/doc-guide/kernel-doc.rst
> @@ -584,15 +584,15 @@ from the kernel git tree::
>
> $ tools/doc/kernel-doc -man \
> $(git grep -l '/\*\*' -- :^Documentation :^tools) \
> - | scripts/split-man.pl /tmp/man
> + | tools/doc/split-man.pl /tmp/man
>
> Some older versions of git do not support some of the variants of syntax for
> path exclusion. One of the following commands may work for those versions::
>
> $ tools/doc/kernel-doc -man \
> $(git grep -l '/\*\*' -- . ':!Documentation' ':!tools') \
> - | scripts/split-man.pl /tmp/man
> + | tools/doc/split-man.pl /tmp/man
>
> $ tools/doc/kernel-doc -man \
> $(git grep -l '/\*\*' -- . ":(exclude)Documentation" ":(exclude)tools") \
> - | scripts/split-man.pl /tmp/man
> + | tools/doc/split-man.pl /tmp/man
> diff --git a/Documentation/translations/it_IT/doc-guide/kernel-doc.rst b/Documentation/translations/it_IT/doc-guide/kernel-doc.rst
> index 05ea0f03c80b..bf04ceea2d83 100644
> --- a/Documentation/translations/it_IT/doc-guide/kernel-doc.rst
> +++ b/Documentation/translations/it_IT/doc-guide/kernel-doc.rst
> @@ -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::
>
> - $ tools/doc/kernel-doc -man $(git grep -l '/\*\*' -- :^Documentation :^tools) | scripts/split-man.pl /tmp/man
> + $ tools/doc/kernel-doc -man $(git grep -l '/\*\*' -- :^Documentation :^tools) | tools/doc/split-man.pl /tmp/man
> diff --git a/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst b/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
> index b242e52f911c..a807295bc403 100644
> --- a/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
> +++ b/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
> @@ -484,16 +484,16 @@ kernel-doc扩展包含在内核源代码树中,位于 ``Documentation/sphinx/k
>
> $ tools/doc/kernel-doc -man \
> $(git grep -l '/\*\*' -- :^Documentation :^tools) \
> - | scripts/split-man.pl /tmp/man
> + | tools/doc/split-man.pl /tmp/man
>
> 一些旧版本的git不支持路径排除语法的某些变体。
> 以下命令之一可能适用于这些版本::
>
> $ tools/doc/kernel-doc -man \
> $(git grep -l '/\*\*' -- . ':!Documentation' ':!tools') \
> - | scripts/split-man.pl /tmp/man
> + | tools/doc/split-man.pl /tmp/man
>
> $ tools/doc/kernel-doc -man \
> $(git grep -l '/\*\*' -- . ":(exclude)Documentation" ":(exclude)tools") \
> - | scripts/split-man.pl /tmp/man
> + | tools/doc/split-man.pl /tmp/man
>
> diff --git a/scripts/split-man.pl b/tools/doc/split-man.pl
> similarity index 100%
> rename from scripts/split-man.pl
> rename to tools/doc/split-man.pl



Thanks,
Mauro