linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2 0/4] cgroup v2 toctree cleanup
@ 2025-09-15  8:19 Bagas Sanjaya
  2025-09-15  8:19 ` [PATCH v2 1/4] Documentation: cgroup-v2: Use dot delimiter in manual toctree section numbers Bagas Sanjaya
                   ` (3 more replies)
  0 siblings, 4 replies; 11+ messages in thread
From: Bagas Sanjaya @ 2025-09-15  8:19 UTC (permalink / raw)
  To: Linux Kernel Mailing List, Linux Documentation, Linux cgroups
  Cc: Jonathan Corbet, Michal Koutný, Bagas Sanjaya, Tejun Heo,
	Johannes Weiner, Andrea Righi, Johannes Bechberger, Changwoo Min,
	Shashank Balaji, Ingo Molnar, Jake Rice, Cengiz Can,
	Mauro Carvalho Chehab

Hi,

Unlike cgroup v1, cgroup v2 documentation is a rather lengthy single document
(Documentation/admin-guide/cgroup-v2.rst), although is not as long as KVM
API docs (Documentation/virt/kvm/api.rst). As such, it needs a roadmap for
allowing readers to easily navigate it: the toctree.

While plaintext (reST source) readers are delighted with already-existing,
manually-written toctree, readers in html format (including docs.kernel.org
visitors) don't get such luxury. Let's add reST toctree for them.

The first two patches ([1/4] and [2/4]) are section numbers preparation (just
as one would see the book toctree). Actual toctree generation is in [3/4],
and in the service of plaintext readers, also sync the manual toctree in
[4/4].

Enjoy!

Changes since v1 [1]:

  * Drop unrelated cross-reference patch
  * Keep the manual toctree, but fix it up to sync with actual sections
    listing/automatic toctree (Jon)

[1]: https://lore.kernel.org/linux-doc/20250910072334.30688-1-bagasdotme@gmail.com/

Bagas Sanjaya (4):
  Documentation: cgroup-v2: Use dot delimiter in manual toctree section
    numbers
  Documentation: cgroup-v2: Add section numbers
  Documentation: cgroup-v2: Automatically-generate toctree
  Documentation: cgroup-v2: Sync manual toctree

 Documentation/admin-guide/cgroup-v2.rst | 447 ++++++++++++------------
 1 file changed, 227 insertions(+), 220 deletions(-)


base-commit: cf9c2bbba2735831f1200227c7f13404b7d7908e
-- 
An old man doll... just what I always wanted! - Clara


^ permalink raw reply	[flat|nested] 11+ messages in thread

end of thread, other threads:[~2025-09-19  6:13 UTC | newest]

Thread overview: 11+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-09-15  8:19 [PATCH v2 0/4] cgroup v2 toctree cleanup Bagas Sanjaya
2025-09-15  8:19 ` [PATCH v2 1/4] Documentation: cgroup-v2: Use dot delimiter in manual toctree section numbers Bagas Sanjaya
2025-09-15  8:19 ` [PATCH v2 2/4] Documentation: cgroup-v2: Add " Bagas Sanjaya
2025-09-15 12:20   ` Michal Koutný
2025-09-15 12:40     ` Bagas Sanjaya
2025-09-16  9:36       ` Michal Koutný
2025-09-16 10:06         ` Bagas Sanjaya
2025-09-15  8:19 ` [PATCH v2 3/4] Documentation: cgroup-v2: Automatically-generate toctree Bagas Sanjaya
2025-09-15  8:19 ` [PATCH v2 4/4] Documentation: cgroup-v2: Sync manual toctree Bagas Sanjaya
2025-09-18 16:02   ` Tejun Heo
2025-09-19  6:12     ` Bagas Sanjaya

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).