All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux cgroups <cgroups@vger.kernel.org>
Cc: "Jonathan Corbet" <corbet@lwn.net>,
	"Michal Koutný" <mkoutny@suse.com>,
	"Bagas Sanjaya" <bagasdotme@gmail.com>,
	"Tejun Heo" <tj@kernel.org>,
	"Johannes Weiner" <hannes@cmpxchg.org>,
	"Andrea Righi" <arighi@nvidia.com>,
	"Johannes Bechberger" <me@mostlynerdless.de>,
	"Changwoo Min" <changwoo@igalia.com>,
	"Shashank Balaji" <shashank.mahadasyam@sony.com>,
	"Ingo Molnar" <mingo@kernel.org>, "Jake Rice" <jake@jakerice.dev>,
	"Cengiz Can" <cengiz@kernel.wtf>,
	"Mauro Carvalho Chehab" <mchehab@kernel.org>
Subject: [PATCH v2 0/4] cgroup v2 toctree cleanup
Date: Mon, 15 Sep 2025 15:19:23 +0700	[thread overview]
Message-ID: <20250915081942.25077-1-bagasdotme@gmail.com> (raw)

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


             reply	other threads:[~2025-09-15  8:19 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-15  8:19 Bagas Sanjaya [this message]
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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250915081942.25077-1-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=arighi@nvidia.com \
    --cc=cengiz@kernel.wtf \
    --cc=cgroups@vger.kernel.org \
    --cc=changwoo@igalia.com \
    --cc=corbet@lwn.net \
    --cc=hannes@cmpxchg.org \
    --cc=jake@jakerice.dev \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=me@mostlynerdless.de \
    --cc=mingo@kernel.org \
    --cc=mkoutny@suse.com \
    --cc=shashank.mahadasyam@sony.com \
    --cc=tj@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.