lkml.org 
[lkml]   [2024]   [Apr]   [27]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH] scripts: add `check-trans-update.py`
From

在 2024/4/22 21:20, Jonathan Corbet 写道:
> Cheng Ziqiu <chengziqiu@hust.edu.cn> writes:
>
>> The `check-trans-update.py` scripts check whether a translated version
>> of a documentation is up-to-date with the english version.
>>
>> The scripts use `git log` commit to find the latest english commit from
>> the translation commit (order by author date) and the latest english
>> commits from HEAD. If differences occurs, report the file and commits
>> need to be updated.
>>
>> Signed-off-by: Cheng Ziqiu <chengziqiu@hust.edu.cn>
>> ---
>> scripts/check-trans-update.py | 176 ++++++++++++++++++++++++++++++++++
>> 1 file changed, 176 insertions(+)
>> create mode 100755 scripts/check-trans-update.py
> From a *quick* look I see how this could be a useful tool. I think a
> real requirement, though, is that a script like this start with a nice
> comment saying what it does and how to use it. Most people will simply
> stumble across it while looking at files in scripts/; without such a
> comment, they will be hard put to know what it's for.
>
> Scripts for the documentation should be well documented :)

Yes, Ziqiu, can you describe the specific function of your script? just
like:


1. What work does my tool replace?

2. How to use it?

3. What features did I implement?

4. What other features do I plan to add in the future?


Finally, it would be great if you could write it up as a

check_trans_update.rst and put it in the patch set,

but of course provide both English and Chinese.

Maybe we can put it here:

 Documentation/doc-guide/ ?


Thanks,

Yanteng




\
 
 \ /
  Last update: 2024-04-27 12:18    [W:0.040 / U:0.588 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site