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]

Message-ID: <8734rd4jq9.fsf@meer.lwn.net>
Date: Mon, 22 Apr 2024 07:20:30 -0600
From: Jonathan Corbet <corbet@....net>
To: Cheng Ziqiu <chengziqiu@...t.edu.cn>, Alex Shi <alexs@...nel.org>,
 Yanteng Si <siyanteng@...ngson.cn>
Cc: Dongliang Mu <dzm91@...t.edu.cn>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, hust-os-kernel-patches@...glegroups.com,
 Cheng Ziqiu <chengziqiu@...t.edu.cn>
Subject: Re: [PATCH] scripts: add `check-trans-update.py`

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 :)

Thanks,

jon