Hi all,
After merging the powerpc tree, today's linux-next build (htmldocs)
produces these warnings:
Documentation/powerpc/elf_hwcaps.rst:82: WARNING: Unexpected indentation.
Documentation/powerpc/elf_hwcaps.rst:100: WARNING: Unexpected indentation.
Documentation/powerpc/elf_hwcaps.rst:117: WARNING: Unexpected indentation.
Documentation/powerpc/elf_hwcaps.rst:122: WARNING: Unexpected indentation.
Documentation/powerpc/elf_hwcaps.rst:144: WARNING: Unexpected indentation.
Documentation/powerpc/elf_hwcaps.rst:5: WARNING: duplicate label elf_hwcaps_index, other instance in Documentation/arm64/elf_hwcaps.rst
Documentation/powerpc/elf_hwcaps.rst: WARNING: document isn't included in any toctree
Introduced by commit
3df1ff42e69e ("powerpc: add documentation for HWCAPs")
--
Cheers,
Stephen Rothwell
After merging powerpc tree for linux-next integration testing, Stephen
Rothwell reported htmldocs warnings at [1]. Fix these with self-explanatory
fixes in the shortlog below.
[1]: https://lore.kernel.org/linuxppc-dev/[email protected]/
Bagas Sanjaya (3):
Documentation: powerpc: fix indentation warnings
Documentation: use different label names for each arch's
elf_hwcaps.rst
Documentation: powerpc: add elf_hwcaps to table of contents
Documentation/arm64/elf_hwcaps.rst | 2 +-
Documentation/powerpc/elf_hwcaps.rst | 17 +++++++----------
Documentation/powerpc/index.rst | 1 +
.../translations/zh_CN/arm64/elf_hwcaps.rst | 2 +-
.../translations/zh_TW/arm64/elf_hwcaps.rst | 2 +-
5 files changed, 11 insertions(+), 13 deletions(-)
base-commit: d6b551b8f90cc92c7d3c09cf38c748efe305ecb4
--
An old man doll... just what I always wanted! - Clara
elf_hwcaps documentation is missing from table of contents at index.rst,
hence triggers Sphinx warning:
Documentation/powerpc/elf_hwcaps.rst: WARNING: document isn't included in any toctree
Add the documentation to the index to fix the warning.
Link: https://lore.kernel.org/linuxppc-dev/[email protected]/
Fixes: 3df1ff42e69e91 ("powerpc: add documentation for HWCAPs")
Reported-by: Stephen Rothwell <[email protected]>
Signed-off-by: Bagas Sanjaya <[email protected]>
---
Documentation/powerpc/index.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/powerpc/index.rst b/Documentation/powerpc/index.rst
index 0f7d3c495693e0..85e80e30160bb6 100644
--- a/Documentation/powerpc/index.rst
+++ b/Documentation/powerpc/index.rst
@@ -17,6 +17,7 @@ powerpc
dawr-power9
dscr
eeh-pci-error-recovery
+ elf_hwcaps
elfnote
firmware-assisted-dump
hvcs
--
An old man doll... just what I always wanted! - Clara
Sphinx reported unexpected indentation warnings:
Documentation/powerpc/elf_hwcaps.rst:82: WARNING: Unexpected indentation.
Documentation/powerpc/elf_hwcaps.rst:100: WARNING: Unexpected indentation.
Documentation/powerpc/elf_hwcaps.rst:117: WARNING: Unexpected indentation.
Documentation/powerpc/elf_hwcaps.rst:122: WARNING: Unexpected indentation.
Documentation/powerpc/elf_hwcaps.rst:144: WARNING: Unexpected indentation.
Fix these warnings by unindenting commit references and using literal code
block for instructions list for PPC_FEATURE_ICACHE_SNOOP.
Link: https://lore.kernel.org/linuxppc-dev/[email protected]/
Fixes: 3df1ff42e69e91 ("powerpc: add documentation for HWCAPs")
Reported-by: Stephen Rothwell <[email protected]>
Signed-off-by: Bagas Sanjaya <[email protected]>
---
Documentation/powerpc/elf_hwcaps.rst | 15 ++++++---------
1 file changed, 6 insertions(+), 9 deletions(-)
diff --git a/Documentation/powerpc/elf_hwcaps.rst b/Documentation/powerpc/elf_hwcaps.rst
index 96d4fc4a3f91fe..bb7438cebf36e8 100644
--- a/Documentation/powerpc/elf_hwcaps.rst
+++ b/Documentation/powerpc/elf_hwcaps.rst
@@ -78,8 +78,7 @@ PPC_FEATURE_64
PPC_FEATURE_601_INSTR
The processor is PowerPC 601.
- Unused in the kernel since:
- f0ed73f3fa2c ("powerpc: Remove PowerPC 601")
+ Unused in the kernel since f0ed73f3fa2c ("powerpc: Remove PowerPC 601")
PPC_FEATURE_HAS_ALTIVEC
Vector (aka Altivec, VMX) facility is available.
@@ -96,8 +95,7 @@ PPC_FEATURE_HAS_4xxMAC
PPC_FEATURE_UNIFIED_CACHE
The processor has a unified L1 cache for instructions and data, as
found in NXP e200.
- Unused in the kernel since:
- 39c8bf2b3cc1 ("powerpc: Retire e200 core (mpc555x processor)")
+ Unused in the kernel since 39c8bf2b3cc1 ("powerpc: Retire e200 core (mpc555x processor)")
PPC_FEATURE_HAS_SPE
Signal Processing Engine facility is available.
@@ -113,13 +111,11 @@ PPC_FEATURE_NO_TB
This is a 601 specific HWCAP, so if it is known that the processor
running is not a 601, via other HWCAPs or other means, it is not
required to test this bit before using the timebase.
- Unused in the kernel since:
- f0ed73f3fa2c ("powerpc: Remove PowerPC 601")
+ Unused in the kernel since f0ed73f3fa2c ("powerpc: Remove PowerPC 601")
PPC_FEATURE_POWER4
The processor is POWER4 or PPC970/FX/MP.
- POWER4 support dropped from the kernel since:
- 471d7ff8b51b ("powerpc/64s: Remove POWER4 support")
+ POWER4 support dropped from the kernel since 471d7ff8b51b ("powerpc/64s: Remove POWER4 support")
PPC_FEATURE_POWER5
The processor is POWER5.
@@ -140,7 +136,8 @@ PPC_FEATURE_ICACHE_SNOOP
The processor icache is coherent with the dcache, and instruction storage
can be made consistent with data storage for the purpose of executing
instructions with the sequence (as described in, e.g., POWER9 Processor
- User's Manual, 4.6.2.2 Instruction Cache Block Invalidate (icbi)):
+ User's Manual, 4.6.2.2 Instruction Cache Block Invalidate (icbi))::
+
sync
icbi (to any address)
isync
--
An old man doll... just what I always wanted! - Clara
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/[email protected]/
Fixes: 3df1ff42e69e91 ("powerpc: add documentation for HWCAPs")
Reported-by: Stephen Rothwell <[email protected]>
Signed-off-by: Bagas Sanjaya <[email protected]>
---
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(-)
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 <[email protected]>
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 <[email protected]>
Hu Haowen <[email protected]>
--
An old man doll... just what I always wanted! - Clara
Bagas Sanjaya <[email protected]> writes:
> After merging powerpc tree for linux-next integration testing, Stephen
> Rothwell reported htmldocs warnings at [1]. Fix these with self-explanatory
> fixes in the shortlog below.
>
> [1]: https://lore.kernel.org/linuxppc-dev/[email protected]/
>
> Bagas Sanjaya (3):
> Documentation: powerpc: fix indentation warnings
> Documentation: use different label names for each arch's
> elf_hwcaps.rst
> Documentation: powerpc: add elf_hwcaps to table of contents
>
> Documentation/arm64/elf_hwcaps.rst | 2 +-
> Documentation/powerpc/elf_hwcaps.rst | 17 +++++++----------
> Documentation/powerpc/index.rst | 1 +
> .../translations/zh_CN/arm64/elf_hwcaps.rst | 2 +-
> .../translations/zh_TW/arm64/elf_hwcaps.rst | 2 +-
> 5 files changed, 11 insertions(+), 13 deletions(-)
Hi Bagas,
I'd actually already fixed these locally, but I'll take your versions
because you went to all the trouble of sending them :)
I've modified patch 2 to only change the powerpc label name, I don't
want to be touching the arm64 documentation this late in the development
cycle.
I've also installed every python package on earth and got my development
machine setup to build the docs again, so hopefully I'll catch errors
like this in future.
cheers
Bagas Sanjaya <[email protected]> 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/[email protected]/
> Fixes: 3df1ff42e69e91 ("powerpc: add documentation for HWCAPs")
> Reported-by: Stephen Rothwell <[email protected]>
> Signed-off-by: Bagas Sanjaya <[email protected]>
> ---
> 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
On Thu, 28 Jul 2022 10:33:30 +0700, Bagas Sanjaya wrote:
> After merging powerpc tree for linux-next integration testing, Stephen
> Rothwell reported htmldocs warnings at [1]. Fix these with self-explanatory
> fixes in the shortlog below.
>
> [1]: https://lore.kernel.org/linuxppc-dev/[email protected]/
>
> Bagas Sanjaya (3):
> Documentation: powerpc: fix indentation warnings
> Documentation: use different label names for each arch's
> elf_hwcaps.rst
> Documentation: powerpc: add elf_hwcaps to table of contents
>
> [...]
Applied to powerpc/next.
[1/3] Documentation: powerpc: fix indentation warnings
https://git.kernel.org/powerpc/c/4515862b66d3bdaf681cade1c72f047c93d94d01
[2/3] Documentation: use different label names for each arch's elf_hwcaps.rst
https://git.kernel.org/powerpc/c/0595a216920cb035030c73cec3ab9fe413ef1d77
[3/3] Documentation: powerpc: add elf_hwcaps to table of contents
https://git.kernel.org/powerpc/c/a05aae92f84ba6d2705f6dac206ef5dcf097ea96
cheers