linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Akira Yokosawa <akiyks@gmail.com>,
	Randy Dunlap <rdunlap@infradead.org>
Subject: Re: [PATCH 11/13] docs: move split-man.pl to tools/doc
Date: Thu, 14 Aug 2025 01:50:05 +0200	[thread overview]
Message-ID: <20250814015005.22f0fced@foz.lan> (raw)
In-Reply-To: <20250813213218.198582-12-corbet@lwn.net>

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

> ...and update all references to it.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

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@lwn.net>
> ---
>  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

  reply	other threads:[~2025-08-13 23:50 UTC|newest]

Thread overview: 47+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-13 21:31 [PATCH RFC 00/13] Collect documention-related tools under tools/doc Jonathan Corbet
2025-08-13 21:32 ` [PATCH 01/13] docs: Move the "features" tools to tools/doc Jonathan Corbet
2025-08-13 23:38   ` Mauro Carvalho Chehab
2025-08-13 23:42     ` Randy Dunlap
2025-08-14  5:56       ` Mauro Carvalho Chehab
2025-08-14  5:57         ` Randy Dunlap
2025-08-13 21:32 ` [PATCH 02/13] docs: move checktransupdate.py " Jonathan Corbet
2025-08-13 23:51   ` Mauro Carvalho Chehab
2025-08-13 21:32 ` [PATCH 03/13] docs: move scripts/check-variable-fonts.sh " Jonathan Corbet
2025-08-13 23:46   ` Mauro Carvalho Chehab
2025-08-13 21:32 ` [PATCH 04/13] docs: move scripts/documentation-file-ref-check " Jonathan Corbet
2025-08-13 23:47   ` Mauro Carvalho Chehab
2025-08-13 21:32 ` [PATCH 05/13] docs: move parallel-wrapper.sh to tools/doc/ Jonathan Corbet
2025-08-13 23:31   ` Mauro Carvalho Chehab
2025-08-13 21:32 ` [PATCH 06/13] docs: move get_abi.py to tools/doc Jonathan Corbet
2025-08-13 23:43   ` Mauro Carvalho Chehab
2025-08-13 21:32 ` [PATCH 07/13] docs: move sphinx-pre-install " Jonathan Corbet
2025-08-13 23:36   ` Mauro Carvalho Chehab
2025-08-14  2:14     ` Jonathan Corbet
2025-08-14  6:21       ` Mauro Carvalho Chehab
2025-08-14 13:52         ` Jonathan Corbet
2025-08-15  5:18           ` Mauro Carvalho Chehab
2025-08-15 13:18             ` Jonathan Corbet
2025-08-15 15:13               ` Mauro Carvalho Chehab
2025-08-15 19:31                 ` Jonathan Corbet
2025-08-16  9:34                   ` Mauro Carvalho Chehab
2025-08-13 21:32 ` [PATCH 08/13] docs: move test_doc_build.py " Jonathan Corbet
2025-08-13 23:36   ` Mauro Carvalho Chehab
2025-08-13 21:32 ` [PATCH 09/13] docs: move parse-headers.pl " Jonathan Corbet
2025-08-13 23:32   ` Mauro Carvalho Chehab
2025-08-13 21:32 ` [PATCH 10/13] docs: move kernel-doc " Jonathan Corbet
2025-08-13 23:33   ` Mauro Carvalho Chehab
2025-08-13 23:48   ` Mauro Carvalho Chehab
2025-08-14 12:13   ` kernel test robot
2025-08-13 21:32 ` [PATCH 11/13] docs: move split-man.pl " Jonathan Corbet
2025-08-13 23:50   ` Mauro Carvalho Chehab [this message]
2025-08-13 21:32 ` [PATCH 12/13] docs: move find-unused-docs.sh " Jonathan Corbet
2025-08-13 23:50   ` Mauro Carvalho Chehab
2025-08-13 21:32 ` [PATCH 13/13] docs: remove kernel-doc.pl Jonathan Corbet
2025-08-13 23:33   ` Mauro Carvalho Chehab
2025-08-15  2:43   ` Randy Dunlap
2025-08-15  4:45     ` Mauro Carvalho Chehab
2025-08-13 21:38 ` [PATCH RFC 00/13] Collect documention-related tools under tools/doc Jonathan Corbet
2025-08-13 23:29 ` Mauro Carvalho Chehab
2025-08-14 14:59 ` Jani Nikula
2025-08-15  2:53   ` Randy Dunlap
2025-08-15  8:29     ` Jani Nikula

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250814015005.22f0fced@foz.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).