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

Bagas Sanjaya
2025-09-10T23:34:55Z

[-- Attachment #1: Type: text/plain, Size: 1190 bytes --]

On Wed, Sep 10, 2025 at 07:24:45AM -0600, Jonathan Corbet wrote:
> 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.

So for the v2, should I fix up the manual toctree to match autogenerated
one?

Thanks.

--
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]