1.. SPDX-License-Identifier: GPL-2.0 2 3Checking for needed translation updates 4======================================= 5 6This script helps track the translation status of the documentation in 7different locales, i.e., whether the documentation is up-to-date with 8the English counterpart. 9 10How it works 11------------ 12 13It uses ``git log`` command to track the latest English commit from the 14translation commit (order by author date) and the latest English commits 15from HEAD. If any differences occur, the file is considered as out-of-date, 16then commits that need to be updated will be collected and reported. 17 18Features implemented 19 20- check all files in a certain locale 21- check a single file or a set of files 22- provide options to change output format 23- track the translation status of files that have no translation 24 25Usage 26----- 27 28:: 29 30 ./scripts/checktransupdate.py --help 31 32Please refer to the output of argument parser for usage details. 33 34Samples 35 36- ``./scripts/checktransupdate.py -l zh_CN`` 37 This will print all the files that need to be updated in the zh_CN locale. 38- ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst`` 39 This will only print the status of the specified file. 40 41Then the output is something like: 42 43:: 44 45 Documentation/dev-tools/kfence.rst 46 No translation in the locale of zh_CN 47 48 Documentation/translations/zh_CN/dev-tools/testing-overview.rst 49 commit 42fb9cfd5b18 ("Documentation: dev-tools: Add link to RV docs") 50 1 commits needs resolving in total 51 52Features to be implemented 53 54- files can be a folder instead of only a file 55