linux-kernel - Re: [PATCH v2 02/10] docs: move checktransupdate.py to tools/docs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <CAD-N9QUyd0AbFpdOqxwGAvCoGwcCVVyE+2vcT4XopopcKoMU+A@mail.gmail.com>
Date: Sat, 25 Oct 2025 18:29:57 +0800
From: Dongliang Mu <mudongliangabcd@...il.com>
To: Jonathan Corbet <corbet@....net>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, 
	Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Akira Yokosawa <akiyks@...il.com>, 
	Randy Dunlap <rdunlap@...radead.org>, Jani Nikula <jani.nikula@...ux.intel.com>, 
	Alex Shi <alexs@...nel.org>, Yanteng Si <si.yanteng@...ux.dev>, 
	Dongliang Mu <dzm91@...t.edu.cn>
Subject: Re: [PATCH v2 02/10] docs: move checktransupdate.py to tools/docs

On Fri, Oct 24, 2025 at 12:11 AM Jonathan Corbet <corbet@....net> wrote:
>
> The checktranslate.py tool currently languishes in scripts/; move it to
> tools/docs and update references accordingly.
>
> Cc: Alex Shi <alexs@...nel.org>
> Cc: Yanteng Si <si.yanteng@...ux.dev>
> Cc: Dongliang Mu <dzm91@...t.edu.cn>
> Signed-off-by: Jonathan Corbet <corbet@....net>

Reviewed-by: Dongliang Mu <dzm91@...t.edu.cn>

> ---
>  Documentation/doc-guide/checktransupdate.rst              | 6 +++---
>  .../translations/zh_CN/doc-guide/checktransupdate.rst     | 6 +++---
>  Documentation/translations/zh_CN/how-to.rst               | 2 +-
>  MAINTAINERS                                               | 2 +-
>  {scripts => tools/docs}/checktransupdate.py               | 8 ++++----
>  5 files changed, 12 insertions(+), 12 deletions(-)
>  rename {scripts => tools/docs}/checktransupdate.py (97%)
>
> diff --git a/Documentation/doc-guide/checktransupdate.rst b/Documentation/doc-guide/checktransupdate.rst
> index dfaf9d373747..7b25375cc6d9 100644
> --- a/Documentation/doc-guide/checktransupdate.rst
> +++ b/Documentation/doc-guide/checktransupdate.rst
> @@ -27,15 +27,15 @@ Usage
>
>  ::
>
> -   ./scripts/checktransupdate.py --help
> +   tools/docs/checktransupdate.py --help
>
>  Please refer to the output of argument parser for usage details.
>
>  Samples
>
> --  ``./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 locale.
> --  ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
> +-  ``tools/docs/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
>     This will only print the status of the specified file.
>
>  Then the output is something like:
> diff --git a/Documentation/translations/zh_CN/doc-guide/checktransupdate.rst 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 @@
>
>  ::
>
> -    ./scripts/checktransupdate.py --help
> +    tools/docs/checktransupdate.py --help
>
>  具体用法请参考参数解析器的输出
>
>  示例
>
> --  ``./scripts/checktransupdate.py -l zh_CN``
> +-  ``tools/docs/checktransupdate.py -l zh_CN``
>     这将打印 zh_CN 语言中需要更新的所有文件。
> --  ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
> +-  ``tools/docs/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
>     这将只打印指定文件的状态。
>
>  然后输出类似如下的内容：
> diff --git a/Documentation/translations/zh_CN/how-to.rst b/Documentation/translations/zh_CN/how-to.rst
> index ddd99c0f9b4d..0d51bdf72e95 100644
> --- a/Documentation/translations/zh_CN/how-to.rst
> +++ b/Documentation/translations/zh_CN/how-to.rst
> @@ -437,7 +437,7 @@ git email 默认会抄送给您一份，所以您可以切换为审阅者的角
>  对于首次参与 Linux 内核中文文档翻译的新手，建议您在 linux 目录中运行以下命令：
>  ::
>
> -       ./script/checktransupdate.py -l zh_CN``
> +       tools/docs/checktransupdate.py -l zh_CN``
>
>  该命令会列出需要翻译或更新的英文文档，结果同时保存在 checktransupdate.log 中。
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index dafc11712544..1b5413e779f4 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -7301,8 +7301,8 @@ S:        Maintained
>  P:     Documentation/doc-guide/maintainer-profile.rst
>  T:     git git://git.lwn.net/linux.git docs-next
>  F:     Documentation/
> +F:     tools/docs/
>  F:     scripts/check-variable-fonts.sh
> -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 translation commit
>  differences occur, report the file and commits that need to be updated.
>
>  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-tools/testing-overview.rst
>  This will only print the status of the specified file.
>
>  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 = os.path.dirname(os.path.abspath(__file__))
> -    linux_path = os.path.join(script_path, "..")
> +    linux_path = 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="checktransupdate.log"):
>  def main():
>      """Main function of the script"""
>      script_path = os.path.dirname(os.path.abspath(__file__))
> -    linux_path = os.path.join(script_path, "..")
> +    linux_path = os.path.join(script_path, "../..")
>
>      parser = ArgumentParser(description="Check the translation update")
>      parser.add_argument(
> --
> 2.51.0
>
>