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

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

Message-ID: <6geggl3iu2hffdop43rtd6yp2ivd26ytfn4xdclurwce6mapal@4ve46y652dbj>
Date: Wed, 10 Sep 2025 10:13:05 +0200
From: Michal Koutný <mkoutny@...e.com>
To: Bagas Sanjaya <bagasdotme@...il.com>, 
	Mauro Carvalho Chehab <mchehab@...nel.org>
Cc: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>, 
	Linux Documentation <linux-doc@...r.kernel.org>, Linux cgroups <cgroups@...r.kernel.org>, 
	Jonathan Corbet <corbet@....net>, Tejun Heo <tj@...nel.org>, Johannes Weiner <hannes@...xchg.org>, 
	Andrea Righi <arighi@...dia.com>, Johannes Bechberger <me@...tlynerdless.de>, 
	Changwoo Min <changwoo@...lia.com>, Shashank Balaji <shashank.mahadasyam@...y.com>, 
	Ingo Molnar <mingo@...nel.org>, Jake Rice <jake@...erice.dev>, Cengiz Can <cengiz@...nel.wtf>
Subject: Re: [PATCH 2/2] Documentation: cgroup-v2: Replace manual table of
 contents with contents:: directive

On Wed, Sep 10, 2025 at 02:23:34PM +0700, Bagas Sanjaya <bagasdotme@...il.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?

Thanks,
Michal

Download attachment "signature.asc" of type "application/pgp-signature" (266 bytes)