[PATCH] Documentation: arch_pgtable_helpers: demote pgtable list headings

[PATCH] Documentation: arch_pgtable_helpers: demote pgtable list headings

[Bagas Sanjaya]

Demote pgtable list headings from title heading to chapter heading.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jens Axboe <axboe@kernel.dk>
Cc: "Rafael J. Wysocki" <rafael.j.wysocki@intel.com>
Cc: Anshuman Khandual <anshuman.khandual@arm.com>
Cc: Pasha Tatashin <pasha.tatashin@soleen.com>
Cc: linux-mm@kvack.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/vm/arch_pgtable_helpers.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/vm/arch_pgtable_helpers.rst b/Documentation/vm/arch_pgtable_helpers.rst
index f8b225fc919047..cbaee9e592410f 100644
--- a/Documentation/vm/arch_pgtable_helpers.rst
+++ b/Documentation/vm/arch_pgtable_helpers.rst
@@ -13,7 +13,7 @@ Following tables describe the expected semantics which can also be tested during
 boot via CONFIG_DEBUG_VM_PGTABLE option. All future changes in here or the debug
 test need to be in sync.
 
-======================
+
 PTE Page Table Helpers
 ======================
 
@@ -79,7 +79,7 @@ PTE Page Table Helpers
 | ptep_set_access_flags     | Converts into a more permissive PTE              |
 +---------------------------+--------------------------------------------------+
 
-======================
+
 PMD Page Table Helpers
 ======================
 
@@ -153,7 +153,7 @@ PMD Page Table Helpers
 | pmdp_set_access_flags     | Converts into a more permissive PMD              |
 +---------------------------+--------------------------------------------------+
 
-======================
+
 PUD Page Table Helpers
 ======================
 
@@ -209,7 +209,7 @@ PUD Page Table Helpers
 | pudp_set_access_flags     | Converts into a more permissive PUD              |
 +---------------------------+--------------------------------------------------+
 
-==========================
+
 HugeTLB Page Table Helpers
 ==========================
 
@@ -235,7 +235,7 @@ HugeTLB Page Table Helpers
 | huge_ptep_set_access_flags  | Converts into a more permissive HugeTLB        |
 +---------------------------+--------------------------------------------------+
 
-========================
+
 SWAP Page Table Helpers
 ========================
 

base-commit: f443e374ae131c168a065ea1748feac6b2e76613
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] Documentation: arch_pgtable_helpers: demote pgtable list headings

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Demote pgtable list headings from title heading to chapter heading.

This is a classic example of the sort of changelog that says *what* the
patch does (which we can also see from the patch itself) but not *why*.
Why do these headings need to be changed?

Thanks,

jon

> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: Jens Axboe <axboe@kernel.dk>
> Cc: "Rafael J. Wysocki" <rafael.j.wysocki@intel.com>
> Cc: Anshuman Khandual <anshuman.khandual@arm.com>
> Cc: Pasha Tatashin <pasha.tatashin@soleen.com>
> Cc: linux-mm@kvack.org
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/vm/arch_pgtable_helpers.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/vm/arch_pgtable_helpers.rst b/Documentation/vm/arch_pgtable_helpers.rst
> index f8b225fc919047..cbaee9e592410f 100644
> --- a/Documentation/vm/arch_pgtable_helpers.rst
> +++ b/Documentation/vm/arch_pgtable_helpers.rst
> @@ -13,7 +13,7 @@ Following tables describe the expected semantics which can also be tested during
>  boot via CONFIG_DEBUG_VM_PGTABLE option. All future changes in here or the debug
>  test need to be in sync.
>  
> -======================
> +
>  PTE Page Table Helpers
>  ======================
>  
> @@ -79,7 +79,7 @@ PTE Page Table Helpers
>  | ptep_set_access_flags     | Converts into a more permissive PTE              |
>  +---------------------------+--------------------------------------------------+
>  
> -======================
> +
>  PMD Page Table Helpers
>  ======================
>  
> @@ -153,7 +153,7 @@ PMD Page Table Helpers
>  | pmdp_set_access_flags     | Converts into a more permissive PMD              |
>  +---------------------------+--------------------------------------------------+
>  
> -======================
> +
>  PUD Page Table Helpers
>  ======================
>  
> @@ -209,7 +209,7 @@ PUD Page Table Helpers
>  | pudp_set_access_flags     | Converts into a more permissive PUD              |
>  +---------------------------+--------------------------------------------------+
>  
> -==========================
> +
>  HugeTLB Page Table Helpers
>  ==========================
>  
> @@ -235,7 +235,7 @@ HugeTLB Page Table Helpers
>  | huge_ptep_set_access_flags  | Converts into a more permissive HugeTLB        |
>  +---------------------------+--------------------------------------------------+
>  
> -========================
> +
>  SWAP Page Table Helpers
>  ========================
>  
>
> base-commit: f443e374ae131c168a065ea1748feac6b2e76613
> -- 
> An old man doll... just what I always wanted! - Clara

Re: [PATCH] Documentation: arch_pgtable_helpers: demote pgtable list headings

[Bagas Sanjaya]

On 05/04/22 23.15, Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
> 
>> Demote pgtable list headings from title heading to chapter heading.
> 
> This is a classic example of the sort of changelog that says *what* the
> patch does (which we can also see from the patch itself) but not *why*.
> Why do these headings need to be changed?
> 

In this case, before this patch, generated table of contents for
vm/ contains:

- Active MM
- Architecture Page Table Helpers
- PTE Page Table Helpers
- PMD Page Table Helpers
- PUD Page Table Helpers
- HugeTLB Page Table Helpers
- SWAP Page Table Helpers
- Memory Balancing
...

The headings for PTE, PMD, PUD, HugeTLB, and SWAP Page Table Helpers
should be subheading of Architecture Page Table Helpers, but these
were marked up with page title heading instead of chapter heading.

-- 
An old man doll... just what I always wanted! - Clara