Skip to contentSkip to conversation

docs: mm: fix vm overcommit documentation for OVERCOMMIT_GUESS

PATCH In review [email protected] 3 participants 3 messages Aug 29, 2022 – Oct 10, 2023 1 message not in the archive

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: mm: fix vm overcommit documentation for OVERCOMMIT_GUESS

From: Vratislav Bendel <[email protected]>

Commit 8c7829b04c52 "mm: fix false-positive OVERCOMMIT_GUESS failures" changed the behavior of the default OVERCOMMIT_GUESS setting. Reflect the change also in the Documentation, namely files:
Documentation/admin-guide/sysctl/vm.rst Documentation/mm/overcommit-accounting.rst

---
 Documentation/admin-guide/sysctl/vm.rst    | 4 ++--
 Documentation/mm/overcommit-accounting.rst | 3 +--
 2 files changed, 3 insertions(+), 4 deletions(-)
Documentation/admin-guide/sysctl/vm.rst +2 -2
index 9b833e439f09..351443427360 100644
@@ -742,8 +742,8 @@ overcommit_memory
 
 This value contains a flag that enables memory overcommitment.
 
-When this flag is 0, the kernel attempts to estimate the amount
-of free memory left when userspace requests more memory.
+When this flag is 0, the kernel compares the userspace memory request
+size against total memory plus swap and rejects obvious overcommits.
 
 When this flag is 1, the kernel pretends there is always enough
 memory until it actually runs out.
Documentation/mm/overcommit-accounting.rst +1 -2
index a4895d6fc1c2..e2263477f6d5 100644
@@ -8,8 +8,7 @@ The Linux kernel supports the following overcommit handling modes
 	Heuristic overcommit handling. Obvious overcommits of address
 	space are refused. Used for a typical system. It ensures a
 	seriously wild allocation fails while allowing overcommit to
-	reduce swap usage.  root is allowed to allocate slightly more
-	memory in this mode. This is the default.
+	reduce swap usage. This is the default.
 
 1
 	Always overcommit. Appropriate for some scientific
Signature · 1 line
2.26.3
reviewer Acked-by on v1 1/1
#1 lore raw
Quoted 10 lines · On Mon, Aug 29, 2022 at 02:46:38PM +0200, [email protected] wrote:

From: Vratislav Bendel <[email protected]>

Commit 8c7829b04c52 "mm: fix false-positive OVERCOMMIT_GUESS failures" changed the behavior of the default OVERCOMMIT_GUESS setting. Reflect the change also in the Documentation, namely files:
Documentation/admin-guide/sysctl/vm.rst Documentation/mm/overcommit-accounting.rst

Quoted 37 lines
---
 Documentation/admin-guide/sysctl/vm.rst    | 4 ++--
 Documentation/mm/overcommit-accounting.rst | 3 +--
 2 files changed, 3 insertions(+), 4 deletions(-)
Documentation/admin-guide/sysctl/vm.rst +2 -2
index 9b833e439f09..351443427360 100644
@@ -742,8 +742,8 @@ overcommit_memory
 
 This value contains a flag that enables memory overcommitment.
 
-When this flag is 0, the kernel attempts to estimate the amount
-of free memory left when userspace requests more memory.
+When this flag is 0, the kernel compares the userspace memory request
+size against total memory plus swap and rejects obvious overcommits.
 
 When this flag is 1, the kernel pretends there is always enough
 memory until it actually runs out.
Documentation/mm/overcommit-accounting.rst +1 -2
index a4895d6fc1c2..e2263477f6d5 100644
@@ -8,8 +8,7 @@ The Linux kernel supports the following overcommit handling modes
 	Heuristic overcommit handling. Obvious overcommits of address
 	space are refused. Used for a typical system. It ensures a
 	seriously wild allocation fails while allowing overcommit to
-	reduce swap usage.  root is allowed to allocate slightly more
-	memory in this mode. This is the default.
+	reduce swap usage. This is the default.
 
 1
 	Always overcommit. Appropriate for some scientific
Signature · 1 line
2.26.3
Signature · 2 lines
Sincerely yours,
Mike.

A message that is not in the archive (sent off-list or not yet received): CAHrQN1yOTTMz=RR0rJxr9aFVmTPgYyrabPzNH00Z-fToorrPjQ@mail.gmail.com

maintainer
#3 lore raw
Quoted 14 lines · Vratislav Bendel

On Mon, Aug 29, 2022 at 3:45 PM Mike Rapoport <[email protected]> wrote:

Quoted 10 lines · On Mon, Aug 29, 2022 at 02:46:38PM +0200, [email protected] wrote:

From: Vratislav Bendel <[email protected]>

Commit 8c7829b04c52 "mm: fix false-positive OVERCOMMIT_GUESS failures" changed the behavior of the default OVERCOMMIT_GUESS setting. Reflect the change also in the Documentation, namely files:
Documentation/admin-guide/sysctl/vm.rst Documentation/mm/overcommit-accounting.rst

Quoted 7 lines

Hello,

Poking this one as it's been Acked here without merging for over a year. My humble opinion is that Docs should be up to date, reflecting the real behavior.

My humble opinion is that I must have screwed up somewhere; not sure how this fell through the cracks. I've applied it now, thanks and sorry for the delay.

jon