From: Akira Yokosawa <akiyks@gmail.com>
To: Kosuke Fujimoto <fujimotokosuke0@gmail.com>
Cc: linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Tsugikazu Shibata <shibata@linuxfoundation.org>,
linux-doc@vger.kernel.org, Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH] docs/trans/ja_JP/howto: Don't mention specific kernel versions
Date: Mon, 18 Apr 2022 15:44:04 +0900 [thread overview]
Message-ID: <40b763ab-d35d-03de-9d27-bca2af56dd34@gmail.com> (raw)
In-Reply-To: <20220417070451.19736-1-fujimotokosuke0@gmail.com>
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@gmail.com>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Tsugikazu Shibata <shibata@linuxfoundation.org>
> Cc: Akira Yokosawa <akiyks@gmail.com>
> Cc: linux-doc@vger.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@gmail.com>
Thanks, Akira
> ---
> Documentation/translations/ja_JP/howto.rst | 43 ++++++++++------------
> 1 file changed, 20 insertions(+), 23 deletions(-)
>
[...]
next prev parent reply other threads:[~2022-04-18 6:44 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-17 7:04 [PATCH] docs/trans/ja_JP/howto: Don't mention specific kernel versions Kosuke Fujimoto
2022-04-18 6:44 ` Akira Yokosawa [this message]
2022-04-18 8:26 ` Kosuke Fujimoto
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=40b763ab-d35d-03de-9d27-bca2af56dd34@gmail.com \
--to=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=fujimotokosuke0@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=shibata@linuxfoundation.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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).