Linux-RISC-V Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Yao Zi <me@ziyao.cc>
To: Weijie Yuan <wy@wyuan.org>, Yao Zi <me@ziyao.cc>
Cc: Yukai Wu <xiaoyewuz.ruster@gmail.com>,
	Alex Shi <alexs@kernel.org>, Yanteng Si <si.yanteng@linux.dev>,
	Jonathan Corbet <corbet@lwn.net>, Paul Walmsley <pjw@kernel.org>,
	Palmer Dabbelt <palmer@dabbelt.com>,
	Albert Ou <aou@eecs.berkeley.edu>,
	Dongliang Mu <dzm91@hust.edu.cn>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Alexandre Ghiti <alex@ghiti.fr>,
	linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs/zh_CN: Update arch/riscv/vm-layout.rst translation
Date: Sun, 30 Aug 2026 18:53:07 +0000	[thread overview]
Message-ID: <apR8CoTs4hj-vqLG@pie> (raw)
In-Reply-To: <apQ-7U-omIeXvZ1N@wyuan.org>

On Sun, Aug 30, 2026 at 10:32:13PM +0800, Weijie Yuan wrote:
> On Sat, Aug 29, 2026 at 04:57:49PM +0000, Yao Zi wrote:
> > On Sat, Aug 29, 2026 at 12:15:10PM +0800, Yukai Wu wrote:
> > > Update Documentation/arch/riscv/vm-layout.rst translation.
> > > 
> > > Update the translation through commit 954260ff5a46
> > > ("Revert "RISC-V: mm: Document mmap changes"")
> > > 
> > > Signed-off-by: Yukai Wu <xiaoyewuz.Ruster@gmail.com>
> > > ---
> > >  .../zh_CN/arch/riscv/vm-layout.rst             | 18 +++++++++---------
> > >  1 file changed, 9 insertions(+), 9 deletions(-)
> > > 
> > > diff --git a/Documentation/translations/zh_CN/arch/riscv/vm-layout.rst b/Documentation/translations/zh_CN/arch/riscv/vm-layout.rst
> > > index 4b9f4dcf6c19..0d0ec8ea5d05 100644
> > > --- a/Documentation/translations/zh_CN/arch/riscv/vm-layout.rst
> > > +++ b/Documentation/translations/zh_CN/arch/riscv/vm-layout.rst
> > > @@ -15,7 +15,7 @@ RISC-V Linux上的虚拟内存布局
> > >  :作者: Alexandre Ghiti <alex@ghiti.fr>
> > >  :日期: 12 February 2021
> > >  
> > > -这份文件描述了RISC-V Linux内核使用的虚拟内存布局。
> > > +这份文件描述了 RISC-V Linux 内核使用的虚拟内存布局。
> > >  
> > >  32位 RISC-V Linux 内核
> > >  ======================
> > > @@ -28,9 +28,9 @@ TODO
> > >  64位 RISC-V Linux 内核
> > >  ======================
> > >  
> > > -RISC-V特权架构文档指出,64位地址 "必须使第63-48位值都等于第47位,否则将发生缺页异常。":这将虚
> > > -拟地址空间分成两半,中间有一个非常大的洞,下半部分是用户空间所在的地方,上半部分是RISC-V Linux
> > > -内核所在的地方。
> > > +RISC-V 特权架构文档指出,64 位地址“必须使第 63-48 位值都等于第 47 位,否则将发生缺页异常。”:
> > > +这将虚拟地址空间分成两半,中间有一个非常大的洞,下半部分是用户空间所在的地方,上半部分是 RISC-V
> > > +Linux 内核所在的地方。
> > 
> > I think changes above are purely style improvements? If so please
> > mention it in the commit message, instead of specifying it's "updating"
> > only.
> 
> Agreed. To put it further, I think the commit message template we
> provided in how-to.rst [1] is somewhat like telling contributors: That's
> all you need to do.

Oops, I don't even realize it's part of our existing contributing
guide...

> Of course, in some cases, the patch is quite simple and there is nothing
> else to elaborate on. However, in some cases, such as when making
> extensive changes and updates, we should encourage contributors to write
> down some relevant information for future reference.
> 
> Similarly, just like this patch, the author did more than just update;
> he also carried out other actions, but failed to include the relevant
> details in the commit message. So I feel that perhaps our template might
> have somewhat restricted our writing? (to some extent)

Agree.

> Sure, the requirements for commit messages in the Chinese documentation
> are certainly not as strict as those for the more core subsystems.
> However, I do think it's fine to appropriately explicitly encourage
> contributors to include more meaningful relevant information in the
> commit messages.
> 
> Any ideas for this, or any objections? ;)

I think it's worth pointing out that the template commit message is for
reference only in how-to.rst, and guiding readers to
submitting-patches.rst so at least newcomers have a brief understanding
of the process and requirements.

Now how-to.rst refers process/index.rst, but this index seems to contain
too much for anyone unfamiliar with the process to read through.

> Thanks!
> 
> [1] https://docs.kernel.org/translations/zh_CN/how-to.html#id13

Regards,
Yao Zi

_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv

      reply	other threads:[~2026-08-30 18:53 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-29  4:15 [PATCH] docs/zh_CN: Update arch/riscv/vm-layout.rst translation Yukai Wu
2026-08-29 15:32 ` Weijie Yuan
2026-08-30  1:33   ` Yukai Wu
2026-08-30  4:55     ` Weijie Yuan
2026-08-29 16:57 ` Yao Zi
2026-08-30 14:32   ` Weijie Yuan
2026-08-30 18:53     ` Yao Zi [this message]

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=apR8CoTs4hj-vqLG@pie \
    --to=me@ziyao.cc \
    --cc=alex@ghiti.fr \
    --cc=alexs@kernel.org \
    --cc=aou@eecs.berkeley.edu \
    --cc=corbet@lwn.net \
    --cc=dzm91@hust.edu.cn \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-riscv@lists.infradead.org \
    --cc=palmer@dabbelt.com \
    --cc=pjw@kernel.org \
    --cc=si.yanteng@linux.dev \
    --cc=skhan@linuxfoundation.org \
    --cc=wy@wyuan.org \
    --cc=xiaoyewuz.ruster@gmail.com \
    /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