Re: [PATCH 2/2] Documentation: cgroup-v2: Replace manual table of contents with contents:: directive

Jonathan Corbet
2025-09-10T13:24:48Z

Michal Koutný <mkoutny@suse.com> writes:

> On Wed, Sep 10, 2025 at 02:23:34PM +0700, Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>> manually-arranged table of contents (as reST comments) gets out-of-sync
>> with actual toctree as not all of these are added to it.
>
> Is this true? I generated HTML with this patch and the resulting ToC
> matches what's in the comment.
>
>> Replace it with automatically-generated table of contents via contents::
>> directive.
>
> Mauro, what's the best practice wrt consistent ToC and having it in
> plaintext form?

I fairly routinely get patches fixing manual TOCs that are not updated
to match changes elsewhere. We have a nice system that can manage the
TOC automatically for us, it seems best to me to use it.

That said, if having the TOC in the plain-text version of the document
is deemed to be important, then it needs to be kept and manually
maintained.

Thanks,

jon