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] [day] [month] [year] [list]

Date:   Wed, 6 Apr 2022 11:55:56 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Cc:     "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

On 05/04/22 23.15, Jonathan Corbet wrote:
> 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?
> 

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