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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <aEpAD2jcemzvoJlQ@archie.me>
Date: Thu, 12 Jun 2025 09:48:47 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: "Darrick J. Wong" <djwong@...nel.org>
Cc: Jonathan Corbet <corbet@....net>,
	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	Linux Documentation <linux-doc@...r.kernel.org>,
	Linux ext4 <linux-ext4@...r.kernel.org>,
	Theodore Ts'o <tytso@....edu>,
	Andreas Dilger <adilger.kernel@...ger.ca>,
	"Ritesh Harjani (IBM)" <ritesh.list@...il.com>
Subject: Re: [PATCH] Documentation: ext4: atomic_writes: Remove
 cross-reference labels

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

Download attachment "signature.asc" of type "application/pgp-signature" (229 bytes)