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