Re: [PATCH] Update zh-tw document index.rst (#1)

[Akira Yokosawa <akiyks@gmail.com>]

[+CC: Hu Haowen]

Hello Arthur,
Welcome to kerneldoc!

I have a few comments WRT how to post patches in translations
and .rst in particular.  Please see inline comments below.

(Note: I don't read Chinese text.)

On Sat,  4 Sep 2021 12:06:00 +0800, arthur.yueh wrote:
> From: ArthurYueh <ysde108@gmail.com>
> 
> Trying to make the `zh-tw` index.rst document more readable for users who use `zh-tw`
> ---

You do need to add your Signed-off-by tag here.
Otherwise, the patch won't be accepted.

See: Documentation/translations/zh_TW/process/submitting-patches.rst
or Documentation/process/submitting-patches.rst

As you see in the guide, in this case, you need to send zh_TW patches to
Hu Haowen, who is the maintainer of zh_TW translations.

You can find the right people to send patches by scripts/get_maintainer.pl

At current docs-next of -doc tree,

   ./scripts/get_maintainer.pl Documentation/translations/zh_TW/index.rst

gives the following list:

Hu Haowen <src.res@email.cn> (maintainer:TRADITIONAL CHINESE DOCUMENTATION)
Jonathan Corbet <corbet@lwn.net> (maintainer:DOCUMENTATION)
Alexei Starovoitov <ast@kernel.org> (supporter:BPF (Safe dynamic programs and tools))
Daniel Borkmann <daniel@iogearbox.net> (supporter:BPF (Safe dynamic programs and tools))
Andrii Nakryiko <andrii@kernel.org> (supporter:BPF (Safe dynamic programs and tools))
Martin KaFai Lau <kafai@fb.com> (reviewer:BPF (Safe dynamic programs and tools))
Song Liu <songliubraving@fb.com> (reviewer:BPF (Safe dynamic programs and tools))
Yonghong Song <yhs@fb.com> (reviewer:BPF (Safe dynamic programs and tools))
John Fastabend <john.fastabend@gmail.com> (reviewer:BPF (Safe dynamic programs and tools))
KP Singh <kpsingh@kernel.org> (reviewer:BPF (Safe dynamic programs and tools))
linux-doc-tw-discuss@lists.sourceforge.net (open list:TRADITIONAL CHINESE DOCUMENTATION)
linux-doc@vger.kernel.org (open list:DOCUMENTATION)
linux-kernel@vger.kernel.org (open list)
netdev@vger.kernel.org (open list:BPF (Safe dynamic programs and tools))
bpf@vger.kernel.org (open list:BPF (Safe dynamic programs and tools))

For this particular patch, I don't think BPF is relevant. so,

Hu Haowen <src.res@email.cn> (maintainer:TRADITIONAL CHINESE DOCUMENTATION)
Jonathan Corbet <corbet@lwn.net> (maintainer:DOCUMENTATION)
linux-doc-tw-discuss@lists.sourceforge.net (open list:TRADITIONAL CHINESE DOCUMENTATION)
linux-doc@vger.kernel.org (open list:DOCUMENTATION)   -> you posted here
linux-kernel@vger.kernel.org (open list)

should suffice.

(Note: linux-doc-tw-discuss@lists.sourceforge.net is not an open list,
but moderated.  You can omit it if you'd like, or it might be a good idea
to subscribe it if you are willing to continue contributing to
zh_TW translations.)

>  Documentation/translations/zh_TW/index.rst | 43 +++++++++-------------
>  1 file changed, 18 insertions(+), 25 deletions(-)
> 
> diff --git a/Documentation/translations/zh_TW/index.rst b/Documentation/translations/zh_TW/index.rst
> index c02c4b528..5458dab82 100644
> --- a/Documentation/translations/zh_TW/index.rst
> +++ b/Documentation/translations/zh_TW/index.rst
> @@ -14,22 +14,20 @@
>  
>  
>  .. note::
> -   內核文檔繁體中文版的翻譯工作正在進行中。如果您願意並且有時間參與這項工
> -   作，歡迎提交補丁給胡皓文 <src.res@email.cn>。
> +   linux核心文件繁體中文的翻譯工作正在進行中。如果您願意並且有時間參與這項工
> +   作，歡迎提交修正給胡皓文 <src.res@email.cn>。
>  
> -許可證文檔
> +許可證
>  ----------
   ------

In reST text, these bars indicate a section title and they should have
the same length as the title, so they should be shortened as well.
(One Chinese character -> two bars)

>  
> -下面的文檔介紹了Linux內核原始碼的許可證（GPLv2）、如何在原始碼樹中正確標記
> -單個文件的許可證、以及指向完整許可證文本的連結。
> +下面的文件介紹了Linux核心原始碼的許可證（GPLv2）、如何在原始碼的樹狀紀錄中，正確標記各個文件的許可證、以及完整的許可證內文的連結。

Please fold lines around 80 column.

>  
>  Documentation/translations/zh_TW/process/license-rules.rst
>  
> -用戶文檔
> +用戶相關文件
>  --------
   ------------

Ditto. (In this case need to be lengthened.)

I leave other similar mismatches in your patch.
I look forward to seeing a v2 of this patch.

        Thanks, Akira
>  
[...]