Skip to contentSkip to conversation

doc/vm: move overcommit-accounting doc to admin-guide

PATCH Applied [email protected] 4 participants 5 messages Jul 14, 2022 – Jul 21, 2022

Subsystems (5)

v1 of 2 Applied Latest is v2 →

lore
Share & tools
lore

[email protected]

author maintainer
#0 lore raw

PATCH 1/1 doc/vm: move overcommit-accounting doc to admin-guide

From: Alex Shi <[email protected]>

Since the contents is mainly focus on a sysctl vm.overcommit_memory, it's more suitable for admin-guide dir instead of vm/ dir.

---
 Documentation/admin-guide/mm/index.rst                          | 1 +
 Documentation/{vm => admin-guide/mm}/overcommit-accounting.rst  | 0
 Documentation/admin-guide/sysctl/vm.rst                         | 2 +-
 Documentation/filesystems/proc.rst                              | 2 +-
 Documentation/translations/zh_CN/admin-guide/mm/index.rst       | 1 +
 .../zh_CN/{vm => admin-guide/mm}/overcommit-accounting.rst      | 2 +-
 Documentation/translations/zh_CN/vm/index.rst                   | 1 -
 Documentation/vm/index.rst                                      | 1 -
 8 files changed, 5 insertions(+), 5 deletions(-)
 rename Documentation/{vm => admin-guide/mm}/overcommit-accounting.rst (100%)
 rename Documentation/translations/zh_CN/{vm => admin-guide/mm}/overcommit-accounting.rst (97%)
Documentation/admin-guide/mm/index.rst +1 -0
index c21b5823f126..b92de39a53d3 100644
@@ -35,6 +35,7 @@ the Linux memory management.
    nommu-mmap
    numa_memory_policy
    numaperf
+   overcommit-accounting
    pagemap
    soft-dirty
    swap_numa
Documentation/admin-guide/mm/overcommit-accounting.rst renamed from Documentation/vm/overcommit-accounting.rst +0 -0
similarity index 100%
rename from Documentation/vm/overcommit-accounting.rst
rename to Documentation/admin-guide/mm/overcommit-accounting.rst
Documentation/admin-guide/sysctl/vm.rst +1 -1
index 5c9aa171a0d3..4344006ae764 100644
@@ -760,7 +760,7 @@ and don't use much of it.
 
 The default value is 0.
 
-See Documentation/vm/overcommit-accounting.rst and
+See Documentation/admin-guide/mm/overcommit-accounting.rst and
 mm/util.c::__vm_enough_memory() for more information.
 
 
Documentation/filesystems/proc.rst +1 -1
index 1bc91fb8c321..ff2f42772975 100644
@@ -1109,7 +1109,7 @@ CommitLimit
               yield a CommitLimit of 7.3G.
 
               For more details, see the memory overcommit documentation
-              in vm/overcommit-accounting.
+              in admin-guide/mm/overcommit-accounting.
 Committed_AS
               The amount of memory presently allocated on the system.
               The committed memory is a sum of all of the memory which
Documentation/translations/zh_CN/admin-guide/mm/index.rst +1 -0
index 702271c5b683..7304924d8131 100644
@@ -31,6 +31,7 @@ Linux内存管理有它自己的术语,如果你还不熟悉它,请考虑阅
 
    damon/index
    ksm
+   overcommit-accounting
 
 Todolist:
 * concepts
Documentation/translations/zh_CN/admin-guide/mm/overcommit-accounting.rst renamed from Documentation/translations/zh_CN/vm/overcommit-accounting.rst +1 -1
similarity index 97%
rename from Documentation/translations/zh_CN/vm/overcommit-accounting.rst
rename to Documentation/translations/zh_CN/admin-guide/mm/overcommit-accounting.rst
index 8765cb118f24..04b6067d711d 100644
@@ -1,4 +1,4 @@
-:Original: Documentation/vm/overcommit-accounting.rst
+:Original: Documentation/admin-guide/mm/overcommit-accounting.rst
 
 :翻译:
 
Documentation/translations/zh_CN/vm/index.rst +0 -1
index a1c6d529b6ff..00762b5cb174 100644
@@ -34,7 +34,6 @@ TODO:待引用文档集被翻译完毕后请及时修改此处)
    memory-model
    mmu_notifier
    numa
-   overcommit-accounting
    page_frags
    page_owner
    page_table_check
Documentation/vm/index.rst +0 -1
index 575ccd40e30c..e5ba30c89552 100644
@@ -52,7 +52,6 @@ above structured documentation, or deleted if it has served its purpose.
    memory-model
    mmu_notifier
    numa
-   overcommit-accounting
    page_migration
    page_frags
    page_owner
Signature · 1 line
2.25.1
maintainer Applied
#1 lore raw
Quoted 10 lines · [email protected] writes:

From: Alex Shi <[email protected]>

Since the contents is mainly focus on a sysctl vm.overcommit_memory, it's more suitable for admin-guide dir instead of vm/ dir.

Quoted 12 lines
---
 Documentation/admin-guide/mm/index.rst                          | 1 +
 Documentation/{vm => admin-guide/mm}/overcommit-accounting.rst  | 0
 Documentation/admin-guide/sysctl/vm.rst                         | 2 +-
 Documentation/filesystems/proc.rst                              | 2 +-
 Documentation/translations/zh_CN/admin-guide/mm/index.rst       | 1 +
 .../zh_CN/{vm => admin-guide/mm}/overcommit-accounting.rst      | 2 +-
 Documentation/translations/zh_CN/vm/index.rst                   | 1 -
 Documentation/vm/index.rst                                      | 1 -
 8 files changed, 5 insertions(+), 5 deletions(-)
 rename Documentation/{vm => admin-guide/mm}/overcommit-accounting.rst (100%)
 rename Documentation/translations/zh_CN/{vm => admin-guide/mm}/overcommit-accounting.rst (97%)

Applied, thanks.

jon

maintainer
#2 lore raw
Quoted 25 lines · On Wed, 20 Jul 2022 15:22:30 -0600 Jonathan Corbet <[email protected]> wrote:
Quoted 10 lines · [email protected] writes:

From: Alex Shi <[email protected]>

Since the contents is mainly focus on a sysctl vm.overcommit_memory, it's more suitable for admin-guide dir instead of vm/ dir.

Quoted 12 lines
---
 Documentation/admin-guide/mm/index.rst                          | 1 +
 Documentation/{vm => admin-guide/mm}/overcommit-accounting.rst  | 0
 Documentation/admin-guide/sysctl/vm.rst                         | 2 +-
 Documentation/filesystems/proc.rst                              | 2 +-
 Documentation/translations/zh_CN/admin-guide/mm/index.rst       | 1 +
 .../zh_CN/{vm => admin-guide/mm}/overcommit-accounting.rst      | 2 +-
 Documentation/translations/zh_CN/vm/index.rst                   | 1 -
 Documentation/vm/index.rst                                      | 1 -
 8 files changed, 5 insertions(+), 5 deletions(-)
 rename Documentation/{vm => admin-guide/mm}/overcommit-accounting.rst (100%)
 rename Documentation/translations/zh_CN/{vm => admin-guide/mm}/overcommit-accounting.rst (97%)
Quoted 2 lines

Applied, thanks.

Don't forget that Documentation/vm was moved to Documentation/mm in mm-stable and linux-next.

maintainer
#3 lore raw
Quoted 2 lines · Andrew Morton

Don't forget that Documentation/vm was moved to Documentation/mm in mm-stable and linux-next.

True, that's only going to make things messier. I've dropped this one for now; I can either reapply it after the move hits mainline or it can go through -mm now, whatever's easiest.

Thanks,

jon

#4 lore raw
Quoted 10 lines · Jonathan Corbet
Quoted 2 lines · Andrew Morton

Don't forget that Documentation/vm was moved to Documentation/mm in mm-stable and linux-next.

True, that's only going to make things messier. I've dropped this one for now; I can either reapply it after the move hits mainline or it can go through -mm now, whatever's easiest.

Thanks for reminding. I updated it to -next tree.
https://lore.kernel.org/linux-doc/[email protected]/T/#u

Thanks
Alex