Skip to contentSkip to conversation

arm64: add kdump.rst into index.rst

PATCH Applied Baoquan He 3 participants 3 messages Jun 11, 2023 – Jun 13, 2023 Documentation

lore
Share & tools
lore

Baoquan He

author
#0 lore raw

PATCH 1/1 arm64: add kdump.rst into index.rst

Document kdump.rst was added into Documentation/arm64/, but not listed in Documentation/arm64/index.rst. That triggers below warning when executing "make htmldoc":

Quoted 1 line
Quoted 1 line

Documentation/arm64/kdump.rst: WARNING: document isn't included in any toctree

Fix it now.

---
 Documentation/arm64/index.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/arm64/index.rst +1 -0
index ae21f8118830..e58391557f00 100644
@@ -15,6 +15,7 @@ ARM64 Architecture
     cpu-feature-registers
     elf_hwcaps
     hugetlbpage
+    kdump
     legacy_instructions
     memory
     memory-tagging-extension
Signature · 1 line
2.34.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 4 lines · Baoquan He

Document kdump.rst was added into Documentation/arm64/, but not listed in Documentation/arm64/index.rst. That triggers below warning when executing "make htmldoc":

Quoted 8 lines
Quoted 1 line
Quoted 1 line

Documentation/arm64/kdump.rst: WARNING: document isn't included in any toctree

Fix it now.

Let me add Fixes tag:

Fixes 03dc0e05407f39 ("Documentation: add kdump.rst to present crashkernel reservation on arm64")
Quoted 9 lines
---
 Documentation/arm64/index.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/arm64/index.rst +0 -0
index ae21f8118830..e58391557f00 100644

Documentation/arm64/index.rst ARM64 Architecture · line 21

Quoted 7 lines
Documentation/arm64/index.rst +1 -0
@@ -15,6 +15,7 @@ ARM64 Architecture
     cpu-feature-registers
     elf_hwcaps
     hugetlbpage
+    kdump
     legacy_instructions
     memory
     memory-tagging-extension
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#2 lore raw
In reply to Baoquan He
Quoted 9 lines · Baoquan He

Document kdump.rst was added into Documentation/arm64/, but not listed in Documentation/arm64/index.rst. That triggers below warning when executing "make htmldoc":

Quoted 1 line
Quoted 1 line

Documentation/arm64/kdump.rst: WARNING: document isn't included in any toctree

Fix it now.

[...]

Applied to arm64 (for-next/kdump), thanks!

[1/1] arm64: add kdump.rst into index.rst

      https://git.kernel.org/arm64/c/389ce21b622b
Signature · 1 line
Catalin