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: <87o6ris7qq.fsf@trenco.lwn.net>
Date: Wed, 10 Sep 2025 08:27:25 -0600
From: Jonathan Corbet <corbet@....net>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: Michal Koutný <mkoutny@...e.com>, Bagas Sanjaya
 <bagasdotme@...il.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>,
 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

Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:

> Agreed. If you use:
>
>
> 	.. toctree::
> 	   :maxdepth: 1
> 	   :glob:
>
> 	   * 
>
> There won't be the need of manually updating the TOC tree.
>
> That's said, I guess very few documents currently use grub:
> 	$ git grep :glob: Documentation/|wc -l
> 	7
>
> Also, it has some drawbacks, as you can't control anymore the order 
> where the docs will be placed. So, if this is important, you may need
> to do something different, or maybe use things like (untested):

So this is a different level of TOC than what was originally being
discussed ... but now that we're here, I have to say that I am not a fan
of the use of wildcard toctrees in this way.  The index.rst files easily
become unstructured dumping grounds as it is; wildcards just make that
even worse.

IMO, every addition to a toctree should be considered with regard to
position, and the organization of the containing file in general.  But
then, I'm known to be an optimist.

jon