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

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

[alexs]

From: Alex Shi <alexs@kernel.org>

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

Signed-off-by: Alex Shi <alexs@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
---
 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%)

diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst
index c21b5823f126..b92de39a53d3 100644
--- a/Documentation/admin-guide/mm/index.rst
+++ b/Documentation/admin-guide/mm/index.rst
@@ -35,6 +35,7 @@ the Linux memory management.
    nommu-mmap
    numa_memory_policy
    numaperf
+   overcommit-accounting
    pagemap
    soft-dirty
    swap_numa
diff --git a/Documentation/vm/overcommit-accounting.rst b/Documentation/admin-guide/mm/overcommit-accounting.rst
similarity index 100%
rename from Documentation/vm/overcommit-accounting.rst
rename to Documentation/admin-guide/mm/overcommit-accounting.rst
diff --git a/Documentation/admin-guide/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst
index 5c9aa171a0d3..4344006ae764 100644
--- a/Documentation/admin-guide/sysctl/vm.rst
+++ b/Documentation/admin-guide/sysctl/vm.rst
@@ -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.
 
 
diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
index 1bc91fb8c321..ff2f42772975 100644
--- a/Documentation/filesystems/proc.rst
+++ b/Documentation/filesystems/proc.rst
@@ -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
diff --git a/Documentation/translations/zh_CN/admin-guide/mm/index.rst b/Documentation/translations/zh_CN/admin-guide/mm/index.rst
index 702271c5b683..7304924d8131 100644
--- a/Documentation/translations/zh_CN/admin-guide/mm/index.rst
+++ b/Documentation/translations/zh_CN/admin-guide/mm/index.rst
@@ -31,6 +31,7 @@ Linux内存管理有它自己的术语，如果你还不熟悉它，请考虑阅
 
    damon/index
    ksm
+   overcommit-accounting
 
 Todolist:
 * concepts
diff --git a/Documentation/translations/zh_CN/vm/overcommit-accounting.rst b/Documentation/translations/zh_CN/admin-guide/mm/overcommit-accounting.rst
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
--- a/Documentation/translations/zh_CN/vm/overcommit-accounting.rst
+++ b/Documentation/translations/zh_CN/admin-guide/mm/overcommit-accounting.rst
@@ -1,4 +1,4 @@
-:Original: Documentation/vm/overcommit-accounting.rst
+:Original: Documentation/admin-guide/mm/overcommit-accounting.rst
 
 :翻译:
 
diff --git a/Documentation/translations/zh_CN/vm/index.rst b/Documentation/translations/zh_CN/vm/index.rst
index a1c6d529b6ff..00762b5cb174 100644
--- a/Documentation/translations/zh_CN/vm/index.rst
+++ b/Documentation/translations/zh_CN/vm/index.rst
@@ -34,7 +34,6 @@ TODO:待引用文档集被翻译完毕后请及时修改此处）
    memory-model
    mmu_notifier
    numa
-   overcommit-accounting
    page_frags
    page_owner
    page_table_check
diff --git a/Documentation/vm/index.rst b/Documentation/vm/index.rst
index 575ccd40e30c..e5ba30c89552 100644
--- a/Documentation/vm/index.rst
+++ b/Documentation/vm/index.rst
@@ -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
-- 
2.25.1

Re: [PATCH] doc/vm: move overcommit-accounting doc to admin-guide

[Jonathan Corbet]

alexs@kernel.org writes:

> From: Alex Shi <alexs@kernel.org>
>
> Since the contents is mainly focus on a sysctl vm.overcommit_memory,
> it's more suitable for admin-guide dir instead of vm/ dir.
>
> Signed-off-by: Alex Shi <alexs@kernel.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: linux-doc@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> ---
>  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

Re: [PATCH] doc/vm: move overcommit-accounting doc to admin-guide

[Andrew Morton]

On Wed, 20 Jul 2022 15:22:30 -0600 Jonathan Corbet <corbet@lwn.net> wrote:

> alexs@kernel.org writes:
> 
> > From: Alex Shi <alexs@kernel.org>
> >
> > Since the contents is mainly focus on a sysctl vm.overcommit_memory,
> > it's more suitable for admin-guide dir instead of vm/ dir.
> >
> > Signed-off-by: Alex Shi <alexs@kernel.org>
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Cc: Andrew Morton <akpm@linux-foundation.org>
> > Cc: linux-doc@vger.kernel.org
> > Cc: linux-kernel@vger.kernel.org
> > ---
> >  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.
> 

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

Re: [PATCH] doc/vm: move overcommit-accounting doc to admin-guide

[Jonathan Corbet]

Andrew Morton <akpm@linux-foundation.org> writes:

> 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

Re: [PATCH] doc/vm: move overcommit-accounting doc to admin-guide

[Alex Shi]

On Thu, Jul 21, 2022 at 7:11 AM Jonathan Corbet <corbet@lwn.net> wrote:
>
> Andrew Morton <akpm@linux-foundation.org> writes:
>
> > 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/20220721090834.17130-1-alexs@kernel.org/T/#u

Thanks
Alex