English fixes in vmalloced kernel stacks documentation
Subsystems (2)
PATCH 1/1 English fixes in vmalloced kernel stacks documentation
From cdc9d82bad7111ab1f132d1264fa6ffa323c26b0 Mon Sep 17 00:00:00 2001
From: Nir Lichtman <[email protected]>
Date: Wed, 19 Jun 2024 23:57:11 +0300
Subject: [PATCH] English fixes in vmalloced kernel stacks documentation
--- Documentation/mm/vmalloced-kernel-stacks.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
Documentation/mm/vmalloced-kernel-stacks.rst +5 -5
@@ -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. -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.
@@ -104,7 +104,7 @@ with PAGE_KERNEL protections. 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. +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
Signature · 1 line
2.39.2
Jonathan Corbet
maintainerThanks for working to improve our documentation!
That said...
Quoted 4 lines · Nir Lichtman
From
cdc9d82bad7111ab1f132d1264fa6ffa323c26b0Mon Sep 17 00:00:00 2001
From: Nir Lichtman <[email protected]>
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.
Quoted 9 lines
--- Documentation/mm/vmalloced-kernel-stacks.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)Documentation/mm/vmalloced-kernel-stacks.rst +0
-0
Documentation/mm/vmalloced-kernel-stacks.rst Introduction · line 23
Quoted 5 lines
Documentation/mm/vmalloced-kernel-stacks.rst +1
-1@@ -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
Randy Dunlap
reviewerHi,
Documentation/mm/vmalloced-kernel-stacks.rst with PAGE_KERNEL protections. · line 107
Quoted 6 lines · Nir Lichtman
Documentation/mm/vmalloced-kernel-stacks.rst +1
-1@@ -104,7 +104,7 @@ with PAGE_KERNEL protections. 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. +the code base to understand when and how a thread stack is allocated.
That last part is still not a sentence AFAICT. How about something like:
Quoted 3 lines
(quoted diff) +0
-0Thread stack allocation is initiated from clone(), fork(), vfork(), 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.
Signature · 1 line
~Randy
Thanks! I will include this fix as well in a new patch I will make considering Jonathan's comments as well