diff mbox series

arm64: add kdump.rst into index.rst

Message ID 20230611230358.13635-1-bhe@redhat.com
State New
Headers
Series arm64: add kdump.rst into index.rst |

Commit Message

Baoquan He June 11, 2023, 11:03 p.m. UTC 
  Document kdump.rst was added into Documentation/arm64/, but not listed
in Documentation/arm64/index.rst. That triggers below warning when
executing "make htmldoc":

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

Fix it now.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202306110549.ynH2Juok-lkp@intel.com/
Signed-off-by: Baoquan He <bhe@redhat.com>
Cc: Catalin Marinas <catalin.marinas@arm.com>
---
 Documentation/arm64/index.rst | 1 +
 1 file changed, 1 insertion(+)

Comments

Bagas Sanjaya June 12, 2023, 1:14 a.m. UTC | #1 
On 6/12/23 06:03, Baoquan He wrote:
> Document kdump.rst was added into Documentation/arm64/, but not listed
> in Documentation/arm64/index.rst. That triggers below warning when
> executing "make htmldoc":
> 
>>> Documentation/arm64/kdump.rst: WARNING: document isn't included in any toctree
> 
> Fix it now.
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202306110549.ynH2Juok-lkp@intel.com/
> Signed-off-by: Baoquan He <bhe@redhat.com>
> Cc: Catalin Marinas <catalin.marinas@arm.com>

Let me add Fixes tag:

Fixes: 03dc0e05407f39 ("Documentation: add kdump.rst to present crashkernel reservation on arm64")

> ---
>  Documentation/arm64/index.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/arm64/index.rst b/Documentation/arm64/index.rst
> index ae21f8118830..e58391557f00 100644
> --- a/Documentation/arm64/index.rst
> +++ b/Documentation/arm64/index.rst
> @@ -15,6 +15,7 @@ ARM64 Architecture
>      cpu-feature-registers
>      elf_hwcaps
>      hugetlbpage
> +    kdump
>      legacy_instructions
>      memory
>      memory-tagging-extension

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Catalin Marinas June 13, 2023, 5:13 p.m. UTC | #2 
On Mon, 12 Jun 2023 07:03:58 +0800, Baoquan He wrote:
> Document kdump.rst was added into Documentation/arm64/, but not listed
> in Documentation/arm64/index.rst. That triggers below warning when
> executing "make htmldoc":
> 
> >> 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
diff mbox series

Patch

diff --git a/Documentation/arm64/index.rst b/Documentation/arm64/index.rst
index ae21f8118830..e58391557f00 100644
--- a/Documentation/arm64/index.rst
+++ b/Documentation/arm64/index.rst
@@ -15,6 +15,7 @@  ARM64 Architecture
     cpu-feature-registers
     elf_hwcaps
     hugetlbpage
+    kdump
     legacy_instructions
     memory
     memory-tagging-extension