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

Jonathan Corbet
2025-09-10T14:27:27Z

Mauro Carvalho Chehab <mchehab+huawei@kernel.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