linux-kernel - Re: [PATCH 2/3] Documentation: use different label names for each arch's elf

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: <87y1wdcrqb.fsf@meer.lwn.net>
Date:   Thu, 28 Jul 2022 07:05:32 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Bagas Sanjaya <bagasdotme@...il.com>, linux-doc@...r.kernel.org,
        linux-next@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
        linuxppc-dev@...ts.ozlabs.org,
        linux-doc-tw-discuss@...ts.sourceforge.net
Cc:     linux-kernel@...r.kernel.org,
        Catalin Marinas <catalin.marinas@....com>,
        Will Deacon <will@...nel.org>,
        Michael Ellerman <mpe@...erman.id.au>,
        Benjamin Herrenschmidt <benh@...nel.crashing.org>,
        Paul Mackerras <paulus@...ba.org>, Alex Shi <alexs@...nel.org>,
        Yanteng Si <siyanteng@...ngson.cn>,
        Nicholas Piggin <npiggin@...il.com>,
        Segher Boessenkool <segher@...nel.crashing.org>,
        Bagas Sanjaya <bagasdotme@...il.com>,
        Stephen Rothwell <sfr@...b.auug.org.au>
Subject: Re: [PATCH 2/3] Documentation: use different label names for each
 arch's elf_hwcaps.rst

Bagas Sanjaya <bagasdotme@...il.com> writes:

> Sphinx reported duplicate label warning:
>
> WARNING: duplicate label elf_hwcaps_index, other instance in Documentation/arm64/elf_hwcaps.rst
>
> The warning is caused by elf_hwcaps_index label name is already used for
> arm64 documentation, whileas powerpc use the same name.
>
> Disambiguate the label name for each architecture's documentation. While
> at it, also adjust original reference in translated documentation.
>
> Link: https://lore.kernel.org/linuxppc-dev/20220727220050.549db613@canb.auug.org.au/
> Fixes: 3df1ff42e69e91 ("powerpc: add documentation for HWCAPs")
> Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> ---
>  Documentation/arm64/elf_hwcaps.rst                    | 2 +-
>  Documentation/powerpc/elf_hwcaps.rst                  | 2 +-
>  Documentation/translations/zh_CN/arm64/elf_hwcaps.rst | 2 +-
>  Documentation/translations/zh_TW/arm64/elf_hwcaps.rst | 2 +-
>  4 files changed, 4 insertions(+), 4 deletions(-)

A better solution in cases like this is to just delete the label
entirely.  I'm not quite sure how we got started with this habit of
adding unneeded labels, but they just clutter up the text - and, as
we've seen, add warnings.

These labels aren't needed for anything, so I'd just take them out.

Thanks,

jon