All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
Cc: "David S. Miller" <davem@davemloft.net>,
	Andrew Morton <akpm@linux-foundation.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jens Axboe <axboe@kernel.dk>,
	"Rafael J. Wysocki" <rafael.j.wysocki@intel.com>,
	Anshuman Khandual <anshuman.khandual@arm.com>,
	Pasha Tatashin <pasha.tatashin@soleen.com>,
	linux-mm@kvack.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation: arch_pgtable_helpers: demote pgtable list headings
Date: Wed, 6 Apr 2022 11:55:56 +0700	[thread overview]
Message-ID: <bc258b22-71b9-c8af-4045-21d424d978b8@gmail.com> (raw)
In-Reply-To: <87k0c3ecc1.fsf@meer.lwn.net>

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

      reply	other threads:[~2022-04-06  7:10 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-26 13:13 [PATCH] Documentation: arch_pgtable_helpers: demote pgtable list headings Bagas Sanjaya
2022-04-05 16:15 ` Jonathan Corbet
2022-04-06  4:55   ` Bagas Sanjaya [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bc258b22-71b9-c8af-4045-21d424d978b8@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=akpm@linux-foundation.org \
    --cc=anshuman.khandual@arm.com \
    --cc=axboe@kernel.dk \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=pasha.tatashin@soleen.com \
    --cc=rafael.j.wysocki@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.