linux-kernel - Re: [PATCH] Documentation: arch_pgtable_helpers: demote pgtable list headings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <87k0c3ecc1.fsf@meer.lwn.net>
Date:   Tue, 05 Apr 2022 10:15:10 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Bagas Sanjaya <bagasdotme@...il.com>, linux-doc@...r.kernel.org
Cc:     Bagas Sanjaya <bagasdotme@...il.com>,
        "David S. Miller" <davem@...emloft.net>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Jens Axboe <axboe@...nel.dk>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        Anshuman Khandual <anshuman.khandual@....com>,
        Pasha Tatashin <pasha.tatashin@...een.com>, linux-mm@...ck.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] Documentation: arch_pgtable_helpers: demote pgtable
 list headings

Bagas Sanjaya <bagasdotme@...il.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@....net>
> Cc: "David S. Miller" <davem@...emloft.net>
> Cc: Andrew Morton <akpm@...ux-foundation.org>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: Jens Axboe <axboe@...nel.dk>
> Cc: "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>
> Cc: Anshuman Khandual <anshuman.khandual@....com>
> Cc: Pasha Tatashin <pasha.tatashin@...een.com>
> Cc: linux-mm@...ck.org
> Cc: linux-kernel@...r.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.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