From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Linux ext4 <linux-ext4@vger.kernel.org>
Cc: Theodore Ts'o <tytso@mit.edu>,
Andreas Dilger <adilger.kernel@dilger.ca>,
"Darrick J. Wong" <djwong@kernel.org>,
"Ritesh Harjani (IBM)" <ritesh.list@gmail.com>
Subject: Re: [PATCH 0/4] Slurp (squash) ext4 subdocs
Date: Fri, 20 Jun 2025 10:24:47 +0700 [thread overview]
Message-ID: <aFTUf2IZ72d9BODs@archie.me> (raw)
In-Reply-To: <87bjqjh5dr.fsf@trenco.lwn.net>
[-- Attachment #1: Type: text/plain, Size: 1115 bytes --]
On Thu, Jun 19, 2025 at 01:56:48PM -0600, Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
>
> > Let's slurp (squash) the subdocs instead. This will make the master docs
> > larger of course (although not as big as KVM API docs), but one can use
> > cross-reference labels without hitting aforementioned warning bug. Also,
> > docs directory structure is tidier with only 4 files (master docs and
> > about.rst). As a bonus, also reduce toctree depth as to not spill the
> > whole hierarchy.
>
> "slurp" is not exactly a technical term that will make sense to readers
> of the changelogs.
>
> But, more importantly... Might it be that the current file structure
> reflects the way the authors wanted to manage the docs? It seems to me
> that just organizing the existing files into a proper toctree would be
> rather less churny and yield useful results, no?
>
Agreed. The toctree approach was indeed my first thought ([1]).
Thanks.
[1]: https://lore.kernel.org/linux-doc/aEpAD2jcemzvoJlQ@archie.me/
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
prev parent reply other threads:[~2025-06-20 3:24 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-18 11:15 [PATCH 0/4] Slurp (squash) ext4 subdocs Bagas Sanjaya
2025-06-18 11:15 ` [PATCH 1/4] Documentation: ext4: Slurp included subdocs in high-level overview docs Bagas Sanjaya
2025-06-18 11:15 ` [PATCH 2/4] Documentation: ext4: Slurp included subdocs in global structures docs Bagas Sanjaya
2025-06-18 11:15 ` [PATCH 3/4] Documentation: ext4: Slurp included subdocs in dynamic " Bagas Sanjaya
2025-06-18 16:53 ` kernel test robot
2025-06-18 11:15 ` [PATCH 4/4] Documentation: ext4: Reduce toctree depth Bagas Sanjaya
2025-06-19 19:56 ` [PATCH 0/4] Slurp (squash) ext4 subdocs Jonathan Corbet
2025-06-20 3:24 ` Bagas Sanjaya [this message]
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=aFTUf2IZ72d9BODs@archie.me \
--to=bagasdotme@gmail.com \
--cc=adilger.kernel@dilger.ca \
--cc=corbet@lwn.net \
--cc=djwong@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-ext4@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=ritesh.list@gmail.com \
--cc=tytso@mit.edu \
/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;
as well as URLs for NNTP newsgroup(s).