Linux Documentation
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Nir Lichtman <nir@lichtman.org>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] English fixes in vmalloced kernel stacks documentation
Date: Wed, 19 Jun 2024 15:14:35 -0600	[thread overview]
Message-ID: <87iky44ouc.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20240619210707.GA3570474@lichtman.org>

Thanks for working to improve our documentation!

That said...

Nir Lichtman <nir@lichtman.org> writes:

> From cdc9d82bad7111ab1f132d1264fa6ffa323c26b0 Mon Sep 17 00:00:00 2001
> From: Nir Lichtman <nir@lichtman.org>
> Date: Wed, 19 Jun 2024 23:57:11 +0300
> Subject: [PATCH] English fixes in vmalloced kernel stacks documentation

All patches need a proper changelog, and this is not it.  Please have a
look at Documentation/process/submitting-patches.rst for information on
how to describe your change.

Please pay attention to the section on Signed-off-by while you are there
as well.

> ---
>  Documentation/mm/vmalloced-kernel-stacks.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/mm/vmalloced-kernel-stacks.rst b/Documentation/mm/vmalloced-kernel-stacks.rst
> index fc8c67833..b4ca3176e 100644
> --- a/Documentation/mm/vmalloced-kernel-stacks.rst
> +++ b/Documentation/mm/vmalloced-kernel-stacks.rst
> @@ -20,9 +20,9 @@ Introduction
>  
>  Kernel stack overflows are often hard to debug and make the kernel
>  susceptible to exploits. Problems could show up at a later time making
> -it difficult to isolate and root-cause.
> +it difficult to pinpoint their root cause.

This is a change in meaning and is not necessarily an improvement.

The other changes are fine.

Thanks,

jon

  reply	other threads:[~2024-06-19 21:14 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-19 21:07 [PATCH] English fixes in vmalloced kernel stacks documentation Nir Lichtman
2024-06-19 21:14 ` Jonathan Corbet [this message]
2024-06-19 21:33 ` Randy Dunlap
2024-06-19 21:41   ` Nir Lichtman

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=87iky44ouc.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nir@lichtman.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