All the mail mirrored from lore.kernel.org
 help / color / mirror / Atom feed

From: Yanteng Si <siyanteng@loongson.cn>
To: Jonathan Corbet <corbet@lwn.net>,
	Cheng Ziqiu <chengziqiu@hust.edu.cn>, Alex Shi <alexs@kernel.org>
Cc: Dongliang Mu <dzm91@hust.edu.cn>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	hust-os-kernel-patches@googlegroups.com
Subject: Re: [PATCH] scripts: add `check-trans-update.py`
Date: Sat, 27 Apr 2024 18:18:12 +0800	[thread overview]
Message-ID: <4ca4f26c-8def-4409-9c74-f1e3e7237412@loongson.cn> (raw)
In-Reply-To: <8734rd4jq9.fsf@meer.lwn.net>


在 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

next prev parent reply	other threads:[~2024-04-27 10:18 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-22  6:58 [PATCH] scripts: add `check-trans-update.py` Cheng Ziqiu
2024-04-22 13:20 ` Jonathan Corbet
2024-04-27 10:18   ` Yanteng Si [this message]
2024-04-27 10:44 ` Yanteng Si

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4ca4f26c-8def-4409-9c74-f1e3e7237412@loongson.cn \
    --to=siyanteng@loongson.cn \
    --cc=alexs@kernel.org \
    --cc=chengziqiu@hust.edu.cn \
    --cc=corbet@lwn.net \
    --cc=dzm91@hust.edu.cn \
    --cc=hust-os-kernel-patches@googlegroups.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.