linux-kernel - Re: [PATCH] scripts: add `check-trans-update.py`

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Sat, 27 Apr 2024 18:18:12 +0800
From: Yanteng Si <siyanteng@...ngson.cn>
To: Jonathan Corbet <corbet@....net>, Cheng Ziqiu <chengziqiu@...t.edu.cn>,
 Alex Shi <alexs@...nel.org>
Cc: Dongliang Mu <dzm91@...t.edu.cn>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, hust-os-kernel-patches@...glegroups.com
Subject: Re: [PATCH] scripts: add `check-trans-update.py`


在 2024/4/22 21:20, Jonathan Corbet 写道:
> Cheng Ziqiu <chengziqiu@...t.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@...t.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