From: Jonathan Corbet <corbet@lwn.net>
To: Yanteng Si <siyanteng01@gmail.com>
Cc: Yanteng Si <siyanteng@loongson.cn>,
chenhuacai@kernel.org, linux-doc@vger.kernel.org,
siyanteng01@gmail.com
Subject: Re: [PATCH 04/11] docs/vm: delele three spaces from page_owner
Date: Mon, 06 Dec 2021 10:58:33 -0700 [thread overview]
Message-ID: <87pmq9399y.fsf@meer.lwn.net> (raw)
In-Reply-To: <761f674199f426431c894c3a2eeda2e57ced925f.1638706875.git.siyanteng@loongson.cn>
Yanteng Si <siyanteng01@gmail.com> writes:
> Fix warning as:
>
> linux-next/Documentation/vm/page_owner.rst:92: WARNING: Unexpected indentation.
> linux-next/Documentation/vm/page_owner.rst:96: WARNING: Unexpected indentation.
> linux-next/Documentation/vm/page_owner.rst:107: WARNING: Unexpected indentation.
A general comment: "fixed a warning" is almost never a useful changelog
entry. Instead, talk about what you fixed that was causing the warning;
that, not the warning itself, is the real problem.
> Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
> ---
> Documentation/vm/page_owner.rst | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/vm/page_owner.rst b/Documentation/vm/page_owner.rst
> index 9837fc8147dd..9a3af6aafa09 100644
> --- a/Documentation/vm/page_owner.rst
> +++ b/Documentation/vm/page_owner.rst
> @@ -89,11 +89,11 @@ Usage
>
> Page allocated via order XXX, ...
> PFN XXX ...
> - // Detailed stack
> + // Detailed stack
>
> Page allocated via order XXX, ...
> PFN XXX ...
> - // Detailed stack
> + // Detailed stack
I don't think this is the right fix; instead, this text should be in a
literal block.
Thanks,
jon
next prev parent reply other threads:[~2021-12-06 17:58 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-05 13:43 [PATCH 00/11] docs: fix build warning Yanteng Si
2021-12-05 13:43 ` [PATCH 01/11] docs/driver-api: Reformatting serial ngsm Yanteng Si
2021-12-06 17:56 ` Jonathan Corbet
2021-12-09 7:05 ` yanteng si
2021-12-05 13:43 ` [PATCH 02/11] docs/admin-guide: Add the necessary blank lines to the writecache Yanteng Si
2021-12-05 13:43 ` [PATCH 03/11] docs/arm64: delete a space from tagged-address-abi Yanteng Si
2021-12-05 13:43 ` [PATCH 04/11] docs/vm: delele three spaces from page_owner Yanteng Si
2021-12-06 17:58 ` Jonathan Corbet [this message]
2021-12-09 7:17 ` yanteng si
2021-12-05 13:43 ` [PATCH 05/11] docs/filesystems: add four apostrophes to _start and _len Yanteng Si
2021-12-05 13:43 ` [PATCH 06/11] docs/virt: add a blank line and some - to kvm api Yanteng Si
2021-12-05 13:43 ` [PATCH 07/11] docs/driver-api: Replace a comma in the n_gsm.rst with a double colon Yanteng Si
2021-12-05 13:43 ` [PATCH 08/11] docs/core-api: Replace Footnote Reference in document idr with Substitution Reference Yanteng Si
2021-12-05 13:43 ` [PATCH 09/11] docs/filesystems: fix a label of backend-api Yanteng Si
2021-12-05 13:43 ` [PATCH 10/11] docs/trace: fix a label of boottime-trace Yanteng Si
2021-12-05 13:44 ` [PATCH 11/11] docs/admin-guide: add gpio-aggregator into index Yanteng Si
2021-12-06 18:09 ` [PATCH 00/11] docs: fix build warning Jonathan Corbet
2021-12-07 11:25 ` yanteng si
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=87pmq9399y.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=chenhuacai@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=siyanteng01@gmail.com \
--cc=siyanteng@loongson.cn \
/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).