Received-SPF: pass (google.com: domain of linux-kernel+bounces-153432-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
From: Jonathan Corbet <corbet@lwn.net>
To: Cheng Ziqiu <chengziqiu@hust.edu.cn>, Alex Shi <alexs@kernel.org>,
 Yanteng Si <siyanteng@loongson.cn>
Cc: Dongliang Mu <dzm91@hust.edu.cn>, linux-doc@vger.kernel.org,
 linux-kernel@vger.kernel.org, hust-os-kernel-patches@googlegroups.com,
 Cheng Ziqiu <chengziqiu@hust.edu.cn>
Subject: Re: [PATCH] scripts: add `check-trans-update.py`
In-Reply-To: <20240422065822.1441611-1-chengziqiu@hust.edu.cn>
References: <20240422065822.1441611-1-chengziqiu@hust.edu.cn>
Date: Mon, 22 Apr 2024 07:20:30 -0600
Message-ID: <8734rd4jq9.fsf@meer.lwn.net>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain

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

Thanks,

jon