From: Jonathan Corbet <corbet@lwn.net>
To: "Darrick J. Wong" <djwong@kernel.org>,
Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Linux ext4 <linux-ext4@vger.kernel.org>,
Theodore Ts'o <tytso@mit.edu>,
Andreas Dilger <adilger.kernel@dilger.ca>,
"Ritesh Harjani (IBM)" <ritesh.list@gmail.com>
Subject: Re: [PATCH] Documentation: ext4: atomic_writes: Remove cross-reference labels
Date: Thu, 12 Jun 2025 06:22:20 -0600 [thread overview]
Message-ID: <87ldpxm9oj.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20250612010942.GJ6179@frogsfrogsfrogs>
"Darrick J. Wong" <djwong@kernel.org> writes:
>> > Sphinx wants to snarf up every .rst file it sees, regardless of whether
>> > it is explicitly made part of the document tree. So it will pick up
>> > atomic_writes.rst separately from the include.
>
> Does that mean that overview.rst doesn't need to include the other files
> at all?
Not quite. Sphinx does what is arguably the least useful thing possible
- it picks up and parses the file, but does not place it in the TOC
tree. It will normally warn in such cases, at least. So if this file
is not brought in with an "include" directive, it needs to appear in a
table of contents somewhere.
jon
next prev parent reply other threads:[~2025-06-12 12:22 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-10 9:11 [PATCH] Documentation: ext4: atomic_writes: Remove cross-reference labels Bagas Sanjaya
2025-06-11 16:48 ` Darrick J. Wong
2025-06-11 17:05 ` Jonathan Corbet
2025-06-12 0:07 ` Bagas Sanjaya
2025-06-12 1:09 ` Darrick J. Wong
2025-06-12 2:48 ` Bagas Sanjaya
2025-06-12 3:14 ` Bagas Sanjaya
2025-06-12 12:22 ` Jonathan Corbet [this message]
2025-06-12 12:20 ` Jonathan Corbet
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=87ldpxm9oj.fsf@trenco.lwn.net \
--to=corbet@lwn.net \
--cc=adilger.kernel@dilger.ca \
--cc=bagasdotme@gmail.com \
--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