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

From: Bagas Sanjaya
Date: Wed Apr 06 2022 - 03:14:02 EST


On 05/04/22 23.15, Jonathan Corbet wrote:
Bagas Sanjaya <bagasdotme@xxxxxxxxx> 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