[PATCH] Documentation: English corrections in vmalloced kernel stacks

[PATCH] Documentation: English corrections in vmalloced kernel stacks

[Nir Lichtman]

From 34f137faedf7769b2ab8c834ce57d4de56eb0d88 Mon Sep 17 00:00:00 2001
From: Nir Lichtman <nir@lichtman.org>
Date: Thu, 20 Jun 2024 00:45:14 +0300
Subject: [PATCH] Documentation: English corrections in vmalloced kernel stacks

Minor grammar fixes in vmalloced-kernel-stacks

Signed-off-by: Nir Lichtman <nir@lichtman.org>
---
 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..4edca515b 100644
--- a/Documentation/mm/vmalloced-kernel-stacks.rst
+++ b/Documentation/mm/vmalloced-kernel-stacks.rst
@@ -22,7 +22,7 @@ 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.
 
-Virtually-mapped kernel stacks with guard pages causes kernel stack
+Virtually mapped kernel stacks with guard pages cause kernel stack
 overflows to be caught immediately rather than causing difficult to
 diagnose corruptions.
 
@@ -57,7 +57,7 @@ enable this bool configuration option. The requirements are:
 VMAP_STACK
 ----------
 
-VMAP_STACK bool configuration option when enabled allocates virtually
+When enabled, the VMAP_STACK bool configuration option allocates virtually
 mapped task stacks. This option depends on HAVE_ARCH_VMAP_STACK.
 
 - Enable this if you want the use virtually-mapped kernel stacks
@@ -83,7 +83,7 @@ the latest code base:
 Allocation
 -----------
 
-When a new kernel thread is created, thread stack is allocated from
+When a new kernel thread is created, a thread stack is allocated from
 virtually contiguous memory pages from the page level allocator. These
 pages are mapped into contiguous kernel virtual space with PAGE_KERNEL
 protections.
@@ -103,8 +103,8 @@ with PAGE_KERNEL protections.
 - This does not address interrupt stacks - according to the original patch
 
 Thread stack allocation is initiated from clone(), fork(), vfork(),
-kernel_thread() via kernel_clone(). Leaving a few hints for searching
-the code base to understand when and how thread stack is allocated.
+kernel_thread() via kernel_clone(). These are a few hints for searching
+the code base to understand when and how a thread stack is allocated.
 
 Bulk of the code is in:
 `kernel/fork.c <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/kernel/fork.c>`.

base-commit: e5b3efbe1ab1793bb49ae07d56d0973267e65112
-- 
2.39.2

Re: [PATCH] Documentation: English corrections in vmalloced kernel stacks

[Randy Dunlap]

On 6/19/24 2:59 PM, Nir Lichtman wrote:
> From 34f137faedf7769b2ab8c834ce57d4de56eb0d88 Mon Sep 17 00:00:00 2001
> From: Nir Lichtman <nir@lichtman.org>
> Date: Thu, 20 Jun 2024 00:45:14 +0300
> Subject: [PATCH] Documentation: English corrections in vmalloced kernel stacks
> 
> Minor grammar fixes in vmalloced-kernel-stacks
> 
> Signed-off-by: Nir Lichtman <nir@lichtman.org>
> ---
>  Documentation/mm/vmalloced-kernel-stacks.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

-- 
~Randy

Re: [PATCH] Documentation: English corrections in vmalloced kernel stacks

[Jonathan Corbet]

I have applied this but...

Nir Lichtman <nir@lichtman.org> writes:

> From 34f137faedf7769b2ab8c834ce57d4de56eb0d88 Mon Sep 17 00:00:00 2001
> From: Nir Lichtman <nir@lichtman.org>
> Date: Thu, 20 Jun 2024 00:45:14 +0300
> Subject: [PATCH] Documentation: English corrections in vmalloced kernel stacks

This stuff ^^^ just has to be edited out when I apply the patch, which
adds useless work.  If you don't use git send-email to send your
patches, please make the effort to send something that can be directly
applied.

Also: when sending a new version of a patch, indicate that it is such
("v2") and make a note of what changed.

Thanks,

jon

Re: [PATCH] Documentation: English corrections in vmalloced kernel stacks

[Nir Lichtman]

Noted.

Thanks,
Nir