public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Tejun Heo <tj@kernel.org>, Jonathan Corbet <corbet@lwn.net>
Cc: "Michal Koutný" <mkoutny@suse.com>,
	"Mauro Carvalho Chehab" <mchehab@kernel.org>,
	"Linux Kernel Mailing List" <linux-kernel@vger.kernel.org>,
	"Linux Documentation" <linux-doc@vger.kernel.org>,
	"Linux cgroups" <cgroups@vger.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>
Subject: Re: [PATCH 2/2] Documentation: cgroup-v2: Replace manual table of contents with contents:: directive
Date: Thu, 11 Sep 2025 06:27:00 +0700	[thread overview]
Message-ID: <aMIJRB2-G6zZDZMV@archie.me> (raw)
In-Reply-To: <aMGq5tNNAk5DsJWo@slm.duckdns.org>

[-- Attachment #1: Type: text/plain, Size: 957 bytes --]

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

  reply	other threads:[~2025-09-10 23:27 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-10  7:23 [PATCH 0/2] cgroup v2 docs update Bagas Sanjaya
2025-09-10  7:23 ` [PATCH 1/2] Documentation: cgroup-v2: Use document path for cross-references Bagas Sanjaya
2025-09-10  7:23 ` [PATCH 2/2] Documentation: cgroup-v2: Replace manual table of contents with contents:: directive Bagas Sanjaya
2025-09-10  8:13   ` Michal Koutný
2025-09-10 11:11     ` Bagas Sanjaya
2025-09-10 13:24     ` Jonathan Corbet
2025-09-10 13:50       ` Mauro Carvalho Chehab
2025-09-10 14:27         ` Jonathan Corbet
2025-09-10 16:44       ` Tejun Heo
2025-09-10 23:27         ` Bagas Sanjaya [this message]
2025-09-10 23:34       ` Bagas Sanjaya
2025-09-10 14:37   ` Michal Koutný

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=aMIJRB2-G6zZDZMV@archie.me \
    --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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox