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: <aMIJRB2-G6zZDZMV@archie.me>
Date: Thu, 11 Sep 2025 06:27:00 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Tejun Heo <tj@...nel.org>, Jonathan Corbet <corbet@....net>
Cc: Michal Koutný <mkoutny@...e.com>,
	Mauro Carvalho Chehab <mchehab@...nel.org>,
	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	Linux Documentation <linux-doc@...r.kernel.org>,
	Linux cgroups <cgroups@...r.kernel.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 06:44:22AM -1000, Tejun Heo wrote:
> Hello,
> 
> On Wed, Sep 10, 2025 at 07:24:45AM -0600, Jonathan Corbet wrote:
> ...
> > 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.
> 
> Wouldn't it be better to have some automated script which triggers on
> mismatching TOC so that these get fixed up. I think people (including me) do
> read the plain text version, so it'd be a shame if we lose TOC in the source
> file.

In that case, I think we need to standardize these manual toctrees (perhaps
using custom directive?).

Thanks.

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

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