[v3] docs: powerpc: Add htm.rst to table of contents

[PATCH v3] docs: powerpc: Add htm.rst to table of contents

Posted by Brigham Campbell 6 months, 2 weeks ago

Fix the following documentation build error, which was introduced when
Documentation/arch/powerpc/htm.rst was added to the repository without
any reference to the document.

Documentation/arch/powerpc/htm.rst: WARNING: document isn't included in any toctree [toc.not_included]

Fixes: ab1456c5aa7a ("powerpc/pseries/htmdump: Add documentation for H_HTM debugfs interface")
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Brigham Campbell <me@brighamcampbell.com>
---
Changes in v3:
 - Edit commit message to conform better to de facto kernel development style.
 - No changes to the diff.

 Documentation/arch/powerpc/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/arch/powerpc/index.rst b/Documentation/arch/powerpc/index.rst
index 0560cbae5fa1..53fc9f89f3e4 100644
--- a/Documentation/arch/powerpc/index.rst
+++ b/Documentation/arch/powerpc/index.rst
@@ -19,6 +19,7 @@ powerpc
     elf_hwcaps
     elfnote
     firmware-assisted-dump
+    htm
     hvcs
     imc
     isa-versions
-- 
2.49.0

Re: [PATCH v3] docs: powerpc: Add htm.rst to table of contents

Posted by Jonathan Corbet 6 months, 1 week ago

Brigham Campbell <me@brighamcampbell.com> writes:

> Fix the following documentation build error, which was introduced when
> Documentation/arch/powerpc/htm.rst was added to the repository without
> any reference to the document.
>
> Documentation/arch/powerpc/htm.rst: WARNING: document isn't included in any toctree [toc.not_included]
>
> Fixes: ab1456c5aa7a ("powerpc/pseries/htmdump: Add documentation for H_HTM debugfs interface")
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Tested-by: Randy Dunlap <rdunlap@infradead.org>
> Signed-off-by: Brigham Campbell <me@brighamcampbell.com>
> ---
> Changes in v3:
>  - Edit commit message to conform better to de facto kernel development style.
>  - No changes to the diff.
>
>  Documentation/arch/powerpc/index.rst | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/arch/powerpc/index.rst b/Documentation/arch/powerpc/index.rst
> index 0560cbae5fa1..53fc9f89f3e4 100644
> --- a/Documentation/arch/powerpc/index.rst
> +++ b/Documentation/arch/powerpc/index.rst
> @@ -19,6 +19,7 @@ powerpc
>      elf_hwcaps
>      elfnote
>      firmware-assisted-dump
> +    htm
>      hvcs

Applied, thanks.

jon

Re: [PATCH v3] docs: powerpc: Add htm.rst to table of contents

Posted by Athira Rajeev 6 months, 2 weeks ago


> On 28 May 2025, at 11:11 AM, Brigham Campbell <me@brighamcampbell.com> wrote:
> 
> Fix the following documentation build error, which was introduced when
> Documentation/arch/powerpc/htm.rst was added to the repository without
> any reference to the document.
> 
> Documentation/arch/powerpc/htm.rst: WARNING: document isn't included in any toctree [toc.not_included]
> 
> Fixes: ab1456c5aa7a ("powerpc/pseries/htmdump: Add documentation for H_HTM debugfs interface")
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Tested-by: Randy Dunlap <rdunlap@infradead.org>
> Signed-off-by: Brigham Campbell <me@brighamcampbell.com>
Thanks for the fix

Tested-by: Athira Rajeev <atrajeev@linux.ibm.com>

Thanks
Athira
> ---
> Changes in v3:
> - Edit commit message to conform better to de facto kernel development style.
> - No changes to the diff.
> 
> Documentation/arch/powerpc/index.rst | 1 +
> 1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/arch/powerpc/index.rst b/Documentation/arch/powerpc/index.rst
> index 0560cbae5fa1..53fc9f89f3e4 100644
> --- a/Documentation/arch/powerpc/index.rst
> +++ b/Documentation/arch/powerpc/index.rst
> @@ -19,6 +19,7 @@ powerpc
>     elf_hwcaps
>     elfnote
>     firmware-assisted-dump
> +    htm
>     hvcs
>     imc
>     isa-versions
> -- 
> 2.49.0
> 
> 
>