diff mbox series

[2/3] Documentation: use different label names for each arch's elf_hwcaps.rst

Message ID 20220728033332.27836-3-bagasdotme@gmail.com (mailing list archive)
State Accepted
Headers show
Series [1/3] Documentation: powerpc: fix indentation warnings | expand

Commit Message

Bagas Sanjaya July 28, 2022, 3:33 a.m. UTC
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@canb.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.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(-)

Comments

Jonathan Corbet July 28, 2022, 1:05 p.m. UTC | #1
Bagas Sanjaya <bagasdotme@gmail.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@canb.auug.org.au>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.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
diff mbox series

Patch

diff --git a/Documentation/arm64/elf_hwcaps.rst b/Documentation/arm64/elf_hwcaps.rst
index 3d116fb536c538..63b75080ec4544 100644
--- a/Documentation/arm64/elf_hwcaps.rst
+++ b/Documentation/arm64/elf_hwcaps.rst
@@ -1,4 +1,4 @@ 
-.. _elf_hwcaps_index:
+.. _elf_hwcaps_arm64:
 
 ================
 ARM64 ELF hwcaps
diff --git a/Documentation/powerpc/elf_hwcaps.rst b/Documentation/powerpc/elf_hwcaps.rst
index bb7438cebf36e8..3366e5b18e6759 100644
--- a/Documentation/powerpc/elf_hwcaps.rst
+++ b/Documentation/powerpc/elf_hwcaps.rst
@@ -1,4 +1,4 @@ 
-.. _elf_hwcaps_index:
+.. _elf_hwcaps_powerpc:
 
 ==================
 POWERPC ELF HWCAPs
diff --git a/Documentation/translations/zh_CN/arm64/elf_hwcaps.rst b/Documentation/translations/zh_CN/arm64/elf_hwcaps.rst
index 9aa4637eac979c..39a94ff5383c01 100644
--- a/Documentation/translations/zh_CN/arm64/elf_hwcaps.rst
+++ b/Documentation/translations/zh_CN/arm64/elf_hwcaps.rst
@@ -1,6 +1,6 @@ 
 .. include:: ../disclaimer-zh_CN.rst
 
-:Original: :ref:`Documentation/arm64/elf_hwcaps.rst <elf_hwcaps_index>`
+:Original: :ref:`Documentation/arm64/elf_hwcaps.rst <elf_hwcaps_arm64>`
 
 Translator: Bailu Lin <bailu.lin@vivo.com>
 
diff --git a/Documentation/translations/zh_TW/arm64/elf_hwcaps.rst b/Documentation/translations/zh_TW/arm64/elf_hwcaps.rst
index 3eb1c623ce31b0..76164d851d0b5e 100644
--- a/Documentation/translations/zh_TW/arm64/elf_hwcaps.rst
+++ b/Documentation/translations/zh_TW/arm64/elf_hwcaps.rst
@@ -2,7 +2,7 @@ 
 
 .. include:: ../disclaimer-zh_TW.rst
 
-:Original: :ref:`Documentation/arm64/elf_hwcaps.rst <elf_hwcaps_index>`
+:Original: :ref:`Documentation/arm64/elf_hwcaps.rst <elf_hwcaps_arm64>`
 
 Translator: Bailu Lin <bailu.lin@vivo.com>
             Hu Haowen <src.res@email.cn>