[PATCH 6/7] docs/admin-guide/mm: start moving here files from Documentation/vm
Several documents in Documentation/vm fit quite well into the "admin/user guide" category. The documents that don't overload the reader with lots of implementation details and provide coherent description of certain feature can be moved to Documentation/admin-guide/mm. Signed-off-by: Mike Rapoport--- Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/sysfs-kernel-mm-hugepages | 2 +- Documentation/{vm => admin-guide/mm}/hugetlbpage.rst| 0 Documentation/{vm => admin-guide/mm}/idle_page_tracking.rst | 2 +- Documentation/admin-guide/mm/index.rst | 9 + Documentation/{vm => admin-guide/mm}/pagemap.rst| 6 +++--- Documentation/{vm => admin-guide/mm}/soft-dirty.rst | 0 Documentation/{vm => admin-guide/mm}/userfaultfd.rst| 0 Documentation/filesystems/proc.txt | 6 -- Documentation/sysctl/vm.txt | 4 ++-- Documentation/vm/00-INDEX | 10 -- Documentation/vm/hwpoison.rst | 2 +- Documentation/vm/index.rst | 5 - fs/Kconfig | 2 +- fs/proc/task_mmu.c | 4 ++-- mm/Kconfig | 5 +++-- 16 files changed, 28 insertions(+), 31 deletions(-) rename Documentation/{vm => admin-guide/mm}/hugetlbpage.rst (100%) rename Documentation/{vm => admin-guide/mm}/idle_page_tracking.rst (98%) rename Documentation/{vm => admin-guide/mm}/pagemap.rst (96%) rename Documentation/{vm => admin-guide/mm}/soft-dirty.rst (100%) rename Documentation/{vm => admin-guide/mm}/userfaultfd.rst (100%) diff --git a/Documentation/ABI/stable/sysfs-devices-node b/Documentation/ABI/stable/sysfs-devices-node index b38f4b7..3e90e1f 100644 --- a/Documentation/ABI/stable/sysfs-devices-node +++ b/Documentation/ABI/stable/sysfs-devices-node @@ -90,4 +90,4 @@ Date: December 2009 Contact: Lee Schermerhorn Description: The node's huge page size control/query attributes. - See Documentation/vm/hugetlbpage.rst \ No newline at end of file + See Documentation/admin-guide/mm/hugetlbpage.rst \ No newline at end of file diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-hugepages b/Documentation/ABI/testing/sysfs-kernel-mm-hugepages index 5140b23..fdaa216 100644 --- a/Documentation/ABI/testing/sysfs-kernel-mm-hugepages +++ b/Documentation/ABI/testing/sysfs-kernel-mm-hugepages @@ -12,4 +12,4 @@ Description: free_hugepages surplus_hugepages resv_hugepages - See Documentation/vm/hugetlbpage.rst for details. + See Documentation/admin-guide/mm/hugetlbpage.rst for details. diff --git a/Documentation/vm/hugetlbpage.rst b/Documentation/admin-guide/mm/hugetlbpage.rst similarity index 100% rename from Documentation/vm/hugetlbpage.rst rename to Documentation/admin-guide/mm/hugetlbpage.rst diff --git a/Documentation/vm/idle_page_tracking.rst b/Documentation/admin-guide/mm/idle_page_tracking.rst similarity index 98% rename from Documentation/vm/idle_page_tracking.rst rename to Documentation/admin-guide/mm/idle_page_tracking.rst index d1c4609..92e3a25 100644 --- a/Documentation/vm/idle_page_tracking.rst +++ b/Documentation/admin-guide/mm/idle_page_tracking.rst @@ -65,7 +65,7 @@ workload one should: are not reclaimable, he or she can filter them out using ``/proc/kpageflags``. -See Documentation/vm/pagemap.rst for more information about +See Documentation/admin-guide/mm/pagemap.rst for more information about ``/proc/pid/pagemap``, ``/proc/kpageflags``, and ``/proc/kpagecgroup``. .. _impl_details: diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst index c47c16e..6c8b554 100644 --- a/Documentation/admin-guide/mm/index.rst +++ b/Documentation/admin-guide/mm/index.rst @@ -17,3 +17,12 @@ are described in Documentation/sysctl/vm.txt and in `man 5 proc`_. Here we document in detail how to interact with various mechanisms in the Linux memory management. + +.. toctree:: + :maxdepth: 1 + + hugetlbpage + idle_page_tracking + pagemap + soft-dirty + userfaultfd diff --git a/Documentation/vm/pagemap.rst b/Documentation/admin-guide/mm/pagemap.rst similarity index 96% rename from Documentation/vm/pagemap.rst rename to Documentation/admin-guide/mm/pagemap.rst index 7ba8cbd..053ca64 100644 --- a/Documentation/vm/pagemap.rst +++ b/Documentation/admin-guide/mm/pagemap.rst @@ -18,7 +18,7 @@ There are four components to pagemap: * Bits 0-54 page frame number (PFN) if present * Bits 0-4 swap type if swapped * Bits 5-54 swap offset if swapped -* Bit 55
[PATCH 6/7] docs/admin-guide/mm: start moving here files from Documentation/vm
Several documents in Documentation/vm fit quite well into the "admin/user guide" category. The documents that don't overload the reader with lots of implementation details and provide coherent description of certain feature can be moved to Documentation/admin-guide/mm. Signed-off-by: Mike Rapoport --- Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/sysfs-kernel-mm-hugepages | 2 +- Documentation/{vm => admin-guide/mm}/hugetlbpage.rst| 0 Documentation/{vm => admin-guide/mm}/idle_page_tracking.rst | 2 +- Documentation/admin-guide/mm/index.rst | 9 + Documentation/{vm => admin-guide/mm}/pagemap.rst| 6 +++--- Documentation/{vm => admin-guide/mm}/soft-dirty.rst | 0 Documentation/{vm => admin-guide/mm}/userfaultfd.rst| 0 Documentation/filesystems/proc.txt | 6 -- Documentation/sysctl/vm.txt | 4 ++-- Documentation/vm/00-INDEX | 10 -- Documentation/vm/hwpoison.rst | 2 +- Documentation/vm/index.rst | 5 - fs/Kconfig | 2 +- fs/proc/task_mmu.c | 4 ++-- mm/Kconfig | 5 +++-- 16 files changed, 28 insertions(+), 31 deletions(-) rename Documentation/{vm => admin-guide/mm}/hugetlbpage.rst (100%) rename Documentation/{vm => admin-guide/mm}/idle_page_tracking.rst (98%) rename Documentation/{vm => admin-guide/mm}/pagemap.rst (96%) rename Documentation/{vm => admin-guide/mm}/soft-dirty.rst (100%) rename Documentation/{vm => admin-guide/mm}/userfaultfd.rst (100%) diff --git a/Documentation/ABI/stable/sysfs-devices-node b/Documentation/ABI/stable/sysfs-devices-node index b38f4b7..3e90e1f 100644 --- a/Documentation/ABI/stable/sysfs-devices-node +++ b/Documentation/ABI/stable/sysfs-devices-node @@ -90,4 +90,4 @@ Date: December 2009 Contact: Lee Schermerhorn Description: The node's huge page size control/query attributes. - See Documentation/vm/hugetlbpage.rst \ No newline at end of file + See Documentation/admin-guide/mm/hugetlbpage.rst \ No newline at end of file diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-hugepages b/Documentation/ABI/testing/sysfs-kernel-mm-hugepages index 5140b23..fdaa216 100644 --- a/Documentation/ABI/testing/sysfs-kernel-mm-hugepages +++ b/Documentation/ABI/testing/sysfs-kernel-mm-hugepages @@ -12,4 +12,4 @@ Description: free_hugepages surplus_hugepages resv_hugepages - See Documentation/vm/hugetlbpage.rst for details. + See Documentation/admin-guide/mm/hugetlbpage.rst for details. diff --git a/Documentation/vm/hugetlbpage.rst b/Documentation/admin-guide/mm/hugetlbpage.rst similarity index 100% rename from Documentation/vm/hugetlbpage.rst rename to Documentation/admin-guide/mm/hugetlbpage.rst diff --git a/Documentation/vm/idle_page_tracking.rst b/Documentation/admin-guide/mm/idle_page_tracking.rst similarity index 98% rename from Documentation/vm/idle_page_tracking.rst rename to Documentation/admin-guide/mm/idle_page_tracking.rst index d1c4609..92e3a25 100644 --- a/Documentation/vm/idle_page_tracking.rst +++ b/Documentation/admin-guide/mm/idle_page_tracking.rst @@ -65,7 +65,7 @@ workload one should: are not reclaimable, he or she can filter them out using ``/proc/kpageflags``. -See Documentation/vm/pagemap.rst for more information about +See Documentation/admin-guide/mm/pagemap.rst for more information about ``/proc/pid/pagemap``, ``/proc/kpageflags``, and ``/proc/kpagecgroup``. .. _impl_details: diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst index c47c16e..6c8b554 100644 --- a/Documentation/admin-guide/mm/index.rst +++ b/Documentation/admin-guide/mm/index.rst @@ -17,3 +17,12 @@ are described in Documentation/sysctl/vm.txt and in `man 5 proc`_. Here we document in detail how to interact with various mechanisms in the Linux memory management. + +.. toctree:: + :maxdepth: 1 + + hugetlbpage + idle_page_tracking + pagemap + soft-dirty + userfaultfd diff --git a/Documentation/vm/pagemap.rst b/Documentation/admin-guide/mm/pagemap.rst similarity index 96% rename from Documentation/vm/pagemap.rst rename to Documentation/admin-guide/mm/pagemap.rst index 7ba8cbd..053ca64 100644 --- a/Documentation/vm/pagemap.rst +++ b/Documentation/admin-guide/mm/pagemap.rst @@ -18,7 +18,7 @@ There are four components to pagemap: * Bits 0-54 page frame number (PFN) if present * Bits 0-4 swap type if swapped * Bits 5-54 swap offset if swapped -* Bit 55pte is soft-dirty (see