Documentation: tpm: Add TPM security docs toctree entry

[PATCH] Documentation: tpm: Add TPM security docs toctree entry

Posted by Bagas Sanjaya 1 year, 7 months ago

Stephen Rothwell reports htmldocs warning when merging tpmdd tree for
linux-next:

Documentation/security/tpm/tpm-security.rst: WARNING: document isn't included in any toctree

Add toctree entry for TPM security docs to fix above warning.

Fixes: ddfb3687c538 ("Documentation: add tpm-security.rst")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20240506162105.42ce2ff7@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/security/tpm/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/security/tpm/index.rst b/Documentation/security/tpm/index.rst
index f27a17f60a9602..fa593d960040a9 100644
--- a/Documentation/security/tpm/index.rst
+++ b/Documentation/security/tpm/index.rst
@@ -5,6 +5,7 @@ Trusted Platform Module documentation
 .. toctree::
 
    tpm_event_log
+   tpm-security
    tpm_tis
    tpm_vtpm_proxy
    xen-tpmfront

base-commit: 152585665f0f6b89e67ed6d04c17b18d1f0f4077
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] Documentation: tpm: Add TPM security docs toctree entry

Posted by Jarkko Sakkinen 1 year, 7 months ago

On Mon May 6, 2024 at 1:59 PM EEST, Bagas Sanjaya wrote:
> Stephen Rothwell reports htmldocs warning when merging tpmdd tree for
> linux-next:
>
> Documentation/security/tpm/tpm-security.rst: WARNING: document isn't included in any toctree
>
> Add toctree entry for TPM security docs to fix above warning.
>
> Fixes: ddfb3687c538 ("Documentation: add tpm-security.rst")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20240506162105.42ce2ff7@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/security/tpm/index.rst | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/security/tpm/index.rst b/Documentation/security/tpm/index.rst
> index f27a17f60a9602..fa593d960040a9 100644
> --- a/Documentation/security/tpm/index.rst
> +++ b/Documentation/security/tpm/index.rst
> @@ -5,6 +5,7 @@ Trusted Platform Module documentation
>  .. toctree::
>  
>     tpm_event_log
> +   tpm-security
>     tpm_tis
>     tpm_vtpm_proxy
>     xen-tpmfront
>
> base-commit: 152585665f0f6b89e67ed6d04c17b18d1f0f4077

Reviewed-by: Jarkko Sakkinen <jarkko@kernel.org>

I'll apply asap

BR, Jarkko