Commit d37366ca authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

docs: move checktransupdate.py to tools/docs 



The checktranslate.py tool currently languishes in scripts/; move it to
tools/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>
Reviewed-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: default avatarJani Nikula <jani.nikula@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 909597fa

Documentation/doc-guide/checktransupdate.rst

+3 −3
Original line number Diff line number Diff line
@@ -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:

Documentation/translations/zh_CN/doc-guide/checktransupdate.rst

+3 −3
Original line number Diff line number Diff line
@@ -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``

   这将只打印指定文件的状态。



然后输出类似如下的内容：

Documentation/translations/zh_CN/how-to.rst

+1 −1
Original line number Diff line number Diff line
@@ -437,7 +437,7 @@ git email 默认会抄送给您一份，所以您可以切换为审阅者的角 
对于首次参与 Linux 内核中文文档翻译的新手，建议您在 linux 目录中运行以下命令：

::



	./script/checktransupdate.py -l zh_CN``

	tools/docs/checktransupdate.py -l zh_CN``



该命令会列出需要翻译或更新的英文文档，结果同时保存在 checktransupdate.log 中。

MAINTAINERS

+0 −1
Original line number Diff line number Diff line
@@ -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*

scripts/checktransupdate.py→tools/docs/checktransupdate.py

+4 −4
Original line number Diff line number Diff line
@@ -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(