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

Darrick J. Wong
2025-06-11T16:48:01Z

On Tue, Jun 10, 2025 at 04:11:59PM +0700, Bagas Sanjaya wrote:
> Sphinx reports htmldocs warnings on ext4 atomic block writes docs:
>
> Documentation/filesystems/ext4/atomic_writes.rst:5: WARNING: duplicate label atomic_writes, other instance in Documentation/filesystems/ext4/atomic_writes.rst
> Documentation/filesystems/ext4/atomic_writes.rst:207: WARNING: duplicate label atomic_write_bdev_support, other instance in Documentation/filesystems/ext4/atomic_writes.rst
>
> These warnings reference duplicated cross-reference labels to themselves in
> the same doc, which are because atomic_writes.rst is transcluded in
> overview.rst via include:: directive, thus the culprit docs get processed
> twice.

<confused> How is that possible? atomic_writes.rst is only "include::"d
once in overview.rst. Is the file implicitly included through some
other means?

--D

> Remove the labels to fix the warnings.
>
> Fixes: 0bf1f51e34c4 ("ext4: Add atomic block write documentation")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> Documentation/filesystems/ext4/atomic_writes.rst | 4 +---
> 1 file changed, 1 insertion(+), 3 deletions(-)
>
> diff --git a/Documentation/filesystems/ext4/atomic_writes.rst b/Documentation/filesystems/ext4/atomic_writes.rst
> index f65767df3620d5..f1a086aa026b1b 100644
> --- a/Documentation/filesystems/ext4/atomic_writes.rst
> +++ b/Documentation/filesystems/ext4/atomic_writes.rst
> @@ -1,5 +1,4 @@
> .. SPDX-License-Identifier: GPL-2.0
> -.. _atomic_writes:
>
> Atomic Block Writes
> -------------------------
> @@ -154,7 +153,7 @@ Creating Filesystems with Atomic Write Support
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> First check the atomic write units supported by block device.
> -See :ref:`atomic_write_bdev_support` for more details.
> +See "Hardware Support" section below for more details.
>
> For single-fsblock atomic writes with a larger block size
> (on systems with block size < page size):
> @@ -201,7 +200,6 @@ details:
> The STATX_ATTR_WRITE_ATOMIC flag in ``statx->attributes`` is set if atomic
> writes are supported.
>
> -.. _atomic_write_bdev_support:
>
> Hardware Support
> ----------------
>
> base-commit: d3f825032091fc14c7d5e34bcd54317ae4246903
> --
> An old man doll... just what I always wanted! - Clara
>
>