linux-kernel - Re: [PATCH] docs/trans/ja_JP/howto: Don't mention specific kernel versions

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:   Mon, 18 Apr 2022 15:44:04 +0900
From:   Akira Yokosawa <akiyks@...il.com>
To:     Kosuke Fujimoto <fujimotokosuke0@...il.com>
Cc:     linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Tsugikazu Shibata <shibata@...uxfoundation.org>,
        linux-doc@...r.kernel.org, Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH] docs/trans/ja_JP/howto: Don't mention specific kernel
 versions

Hi Fujimoto-san,

This looks mostly good to me.
Please find inline comments below on a couple of conventions expected in
this community.

On Sun, 17 Apr 2022 16:04:51 +0900,
Kosuke Fujimoto wrote:
> [PATCH] docs/trans/ja_JP/howto: Don't mention specific kernel versions

It looks like patches to Chinese docs carry a simpler "docs/zh_CN:" prefix [1].
So "docs/ja_JP/howto:" should suffice.

[1]: example: https://lore.kernel.org/r/2fc8a76e1308e15823eebf614f35f36f322a55d3.1649384633.git.siyanteng@loongson.cn/

> This change is based on commit d2b008f134b7 (Documentation/process/howto: Update for 4.x -> 5.x versioning)

In changelog explanation, lines should not exceed 75 chars unless you
have a good reason.
The rule is stricter than the contents of documents because some of git
commands auto indent changelogs by 4 spaces, and the result should fit
in an 80-column wide terminal.
Also, the title of the referenced commit should be enclosed in a pair
of double quotation marks.  So this should be:

   This change is based on commit d2b008f134b7
   ("Documentation/process/howto: Update for 4.x -> 5.x versioning").

[with a punctuation fix]

> Replace "4.x kernel version" with generic term such as "mainline tree"
> 
> Signed-off-by: Kosuke Fujimoto <fujimotokosuke0@...il.com>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: Tsugikazu Shibata <shibata@...uxfoundation.org>
> Cc: Akira Yokosawa <akiyks@...il.com>
> Cc: linux-doc@...r.kernel.org
Please note that the above mentioned width limit does not apply to
tags.  E.g., Fixes: and Link: tags should not wrap.

These conventions are covered in the latter part of Section "Describe
your changes" and Section "The canonical patch format" of
Documentation/process/submitting-patches.rst.

So I'd suggest that you post a v2 with the subject and changelog
fixed.
But please wait a few days for comments from someone else.

With the above addressed, feel free to add:

Reviewed-by: Akira Yokosawa <akiyks@...il.com>

        Thanks, Akira

> ---
>  Documentation/translations/ja_JP/howto.rst | 43 ++++++++++------------
>  1 file changed, 20 insertions(+), 23 deletions(-)
> 
[...]