1. Patchew
  2. linux
  3. [PATCH RFC 00/13] Collect documention-related tools under tools/doc
  4. View patch

[PATCH 02/13] docs: move checktransupdate.py to tools/doc

Jonathan Corbet posted 13 patches 1 month, 3 weeks ago
[PATCH 02/13] docs: move checktransupdate.py to tools/doc
Posted by Jonathan Corbet 1 month, 3 weeks ago 
The checktranslate.py tool currently languishes in scripts/; move it to
tools/doc and update references accordingly.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 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/doc}/checktransupdate.py                | 8 ++++----
 5 files changed, 12 insertions(+), 12 deletions(-)
 rename {scripts => tools/doc}/checktransupdate.py (98%)

diff --git a/Documentation/doc-guide/checktransupdate.rst b/Documentation/doc-guide/checktransupdate.rst
index dfaf9d373747..48bf1ee9a62e 100644
--- a/Documentation/doc-guide/checktransupdate.rst
+++ b/Documentation/doc-guide/checktransupdate.rst
@@ -27,15 +27,15 @@ Usage
 
 ::
 
-   ./scripts/checktransupdate.py --help
+   tools/doc/checktransupdate.py --help
 
 Please refer to the output of argument parser for usage details.
 
 Samples
 
--  ``./scripts/checktransupdate.py -l zh_CN``
+-  ``tools/doc/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/doc/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..165e25155084 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/doc/checktransupdate.py --help
 
 具体用法请参考参数解析器的输出
 
 示例
 
--  ``./scripts/checktransupdate.py -l zh_CN``
+-  ``tools/doc/checktransupdate.py -l zh_CN``
    这将打印 zh_CN 语言中需要更新的所有文件。
--  ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
+-  ``tools/doc/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..cf66c72ee0c5 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/doc/checktransupdate.py -l zh_CN``
 
 该命令会列出需要翻译或更新的英文文档，结果同时保存在 checktransupdate.log 中。
 
diff --git a/MAINTAINERS b/MAINTAINERS
index dafc11712544..a3a396fc1c3f 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/doc/
 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/doc/checktransupdate.py
similarity index 98%
rename from scripts/checktransupdate.py
rename to tools/doc/checktransupdate.py
index e39529e46c3d..61bd7b02ca55 100755
--- a/scripts/checktransupdate.py
+++ b/tools/doc/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/doc/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/doc/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.50.1
Re: [PATCH 02/13] docs: move checktransupdate.py to tools/doc
Posted by Mauro Carvalho Chehab 1 month, 3 weeks ago 
Em Wed, 13 Aug 2025 15:32:01 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> The checktranslate.py tool currently languishes in scripts/; move it to
> tools/doc and update references accordingly.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> 
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
>  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/doc}/checktransupdate.py                | 8 ++++----
>  5 files changed, 12 insertions(+), 12 deletions(-)
>  rename {scripts => tools/doc}/checktransupdate.py (98%)
> 
> diff --git a/Documentation/doc-guide/checktransupdate.rst b/Documentation/doc-guide/checktransupdate.rst
> index dfaf9d373747..48bf1ee9a62e 100644
> --- a/Documentation/doc-guide/checktransupdate.rst
> +++ b/Documentation/doc-guide/checktransupdate.rst
> @@ -27,15 +27,15 @@ Usage
>  
>  ::
>  
> -   ./scripts/checktransupdate.py --help
> +   tools/doc/checktransupdate.py --help
>  
>  Please refer to the output of argument parser for usage details.
>  
>  Samples
>  
> --  ``./scripts/checktransupdate.py -l zh_CN``
> +-  ``tools/doc/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/doc/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..165e25155084 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/doc/checktransupdate.py --help
>  
>  具体用法请参考参数解析器的输出
>  
>  示例
>  
> --  ``./scripts/checktransupdate.py -l zh_CN``
> +-  ``tools/doc/checktransupdate.py -l zh_CN``
>     这将打印 zh_CN 语言中需要更新的所有文件。
> --  ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
> +-  ``tools/doc/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..cf66c72ee0c5 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/doc/checktransupdate.py -l zh_CN``
>  
>  该命令会列出需要翻译或更新的英文文档，结果同时保存在 checktransupdate.log 中。
>  
> diff --git a/MAINTAINERS b/MAINTAINERS
> index dafc11712544..a3a396fc1c3f 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/doc/
>  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/doc/checktransupdate.py
> similarity index 98%
> rename from scripts/checktransupdate.py
> rename to tools/doc/checktransupdate.py
> index e39529e46c3d..61bd7b02ca55 100755
> --- a/scripts/checktransupdate.py
> +++ b/tools/doc/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/doc/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/doc/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(



Thanks,
Mauro

Patchew 2.1-devel-b67e4c2

© 2016 - 2025 Red Hat, Inc.