[PATCH v3 2/8] docs: move checktransupdate.py to tools/docs

Partially applied
From:Jonathan Corbet <corbet@lwn.net>
Date:
Message-ID:<20251024200834.20644-3-corbet@lwn.net>
Patch:v3 · 2/8
Language:Mixed
Patch-ID:59c631a4237b3b0c897792cf8eb3cfbadbb255b5
Files:Documentation/doc-guide/checktransupdate.rstDocumentation/translations/zh_CN/doc-guide/checktransupdate.rstDocumentation/translations/zh_CN/how-to.rstMAINTAINERStools/docs/checktransupdate.py

Patch content 5 changed files

The checktranslate.py tool currently languishes in scripts/; move it totools/docs and update references accordingly. Cc: Alex Shi <alexs@kernel.org>Cc: Yanteng Si <si.yanteng@linux.dev>Cc: Dongliang Mu <dzm91@hust.edu.cn>Acked-by: Jani Nikula <jani.nikula@intel.com>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                                               | 1 - {scripts => tools/docs}/checktransupdate.py               | 8 ++++---- 5 files changed, 11 insertions(+), 12 deletions(-) rename {scripts => tools/docs}/checktransupdate.py (97%) diff --git a/Documentation/doc-guide/checktransupdate.rst b/Documentation/doc-guide/checktransupdate.rstindex 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.rstindex 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.rstindex 714664fec308..7ae5d8765888 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/MAINTAINERSindex 5aa6d769b254..cd187b9f1dc2 100644--- a/MAINTAINERS+++ b/MAINTAINERS@@ -7411,7 +7411,6 @@ S:	Maintained P:	Documentation/doc-guide/maintainer-profile.rst T:	git git://git.lwn.net/linux.git docs-next F:	Documentation/-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.pysimilarity index 97%rename from scripts/checktransupdate.pyrename to tools/docs/checktransupdate.pyindex 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