Re: [PATCH] Documentation: ext4: atomic_writes: Remove cross-reference labels

Bagas Sanjaya
2025-06-12T02:48:51Z

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

On Wed, Jun 11, 2025 at 06:09:42PM -0700, Darrick J. Wong wrote:
> On Thu, Jun 12, 2025 at 07:07:00AM +0700, Bagas Sanjaya wrote:
> > On Wed, Jun 11, 2025 at 11:05:17AM -0600, Jonathan Corbet wrote:
> > > 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?

I think overview.rst can be turned into toctree index.

>
> > > This could be "fixed" by removing the .rst extension from the included
> > > file. But, since there is no use of the atomic_writes label to begin
> > > with, it's better to just take it out. The other fix, removing a cross
> > > reference, is not entirely ideal, but there is little text between the
> > > label and the reference.
> >
> > So removing the labels looks good to you, right?
>
> I don't care that much either way, but if sphinx is going to include
> every rst file implicitly then maybe we just get rid of the explicit
> includes?

OK then.

Thanks.

--
An old man doll... just what I always wanted! - Clara

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