Linux Documentation
 help / color / mirror / Atom feed
From: Weijie Yuan <wy@wyuan.org>
To: Dongliang Mu <dzm91@hust.edu.cn>
Cc: Alex Shi <alexs@kernel.org>, Yanteng Si <si.yanteng@linux.dev>,
	Jonathan Corbet <corbet@lwn.net>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Konstantin Ryabitsev <konstantin@linuxfoundation.org>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 0/4] Update maintainer-pgp-guide.rst Chinese translation
Date: Fri, 21 Aug 2026 19:56:29 +0800	[thread overview]
Message-ID: <aog87UzDIz20XzU_@wyuan.org> (raw)
In-Reply-To: <7232a999-0bb8-45fa-8d33-a11efc661012@hust.edu.cn>

On Fri, Aug 21, 2026 at 07:18:56PM +0800, Dongliang Mu wrote:
> > [...]
> > Thanks for emphasizing this. While I do remember I used "make cleandocs
> > && make htmldocs", and checked among those long lines of red warning
> > output to find anything caused by my commit, I indeed didn't notice this
> > warning appearing at the early stage of the compilation.
> > 
> > It seems that I need to have my eyes checked soon. ;-)
> > 
> > Apologize for my recklessness.
> > 
> > Even so, do we have any way to distinguish these long-standing warnings
> > from the new warnings that appear during compilation? In fact, every
> > time I was worried that I might not have noticed the newly appeared
> > warning. Unfortunately, this time it really happened. (For example,
> > setting a new color? for new warnings?) Do you have a better idea or
> > tips for this?
> 
> My suggestion is to keep the log in each file, and you can easily observe
> the diff. Otherwise, even I can ignore some warnings.

Ah, makes sense! I was actually wondering earlier why we need to put
this log in the directory instead of just keeping it in the CLI.

(I definitely won´t admit that the log file annoyed me a few times
because I accidentally included it with 'git add .' and then had to 'git
commit --amend' right after) ;-)

Very useful, thanks!

> And many contributors are coming together to fix those warnings. If they are
> done, all new warnings are easily captured. Let us do more contribution to
> help this.

Yeah, eliminating these warnings at their root is the straightforward
solution.

And that's exactly what Jon expects:

Kernel Recipes 2019 - Kernel documentation: past, present, and future
#Build warnings

https://youtu.be/1LuAIUKqKDk?t=876&si=XgHhHtukyjyDdtzF

It'd certainly be worth spending some time with folks from those
subsystems to get these warnings fixed once and for all.

> > Btw I've been trying to know more about Sphinx and kernel-docs, hope my
> > mistake won't happen again.
> 
> That change can fix problem. The underlying problem is RST syntax. Maybe you
> can have a look at this or query it in the LLM.

Absolutely. I did have relatively little experience writing rst before.
But that's definitely no excuse - I'll try to pick it up quickly.

Thanks!

  reply	other threads:[~2026-08-21 11:56 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-20 17:13 [PATCH 0/4] Update maintainer-pgp-guide.rst Chinese translation Weijie Yuan
2026-08-20 17:13 ` [PATCH 1/4] docs/zh_CN: update maintainer-pgp-guide translation Weijie Yuan
2026-08-20 17:13 ` [PATCH 2/4] docs/zh_CN: clarify free Nitrokey requirements Weijie Yuan
2026-08-20 17:13 ` [PATCH 3/4] docs/zh_CN: update maintainer-pgp-guide kernel.org link Weijie Yuan
2026-08-20 17:13 ` [PATCH 4/4] docs/zh_CN: add kernel.org trust repository reference Weijie Yuan
2026-08-20 17:38   ` Weijie Yuan
2026-08-21  4:14     ` Dongliang Mu
2026-08-21  5:14       ` Weijie Yuan
2026-08-21  6:54 ` [PATCH 0/4] Update maintainer-pgp-guide.rst Chinese translation Dongliang Mu
2026-08-21  7:22   ` Weijie Yuan
2026-08-21 11:18     ` Dongliang Mu
2026-08-21 11:56       ` Weijie Yuan [this message]
2026-08-21 12:17         ` Dongliang Mu
2026-08-21 12:48           ` Weijie Yuan
2026-08-21 12:57             ` Dongliang Mu
2026-08-21 13:11               ` Weijie Yuan
2026-08-21 13:45                 ` Dongliang Mu
2026-08-21 14:01                   ` Weijie Yuan

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=aog87UzDIz20XzU_@wyuan.org \
    --to=wy@wyuan.org \
    --cc=alexs@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dzm91@hust.edu.cn \
    --cc=konstantin@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=si.yanteng@linux.dev \
    --cc=skhan@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