[PATCH v2] Documentation/virt/kvm: Fix TDX whitepaper footnote reference

[PATCH v2] Documentation/virt/kvm: Fix TDX whitepaper footnote reference

[Bagas Sanjaya]

Sphinx reports unreferenced footnote warning on TDX docs:

Documentation/virt/kvm/x86/intel-tdx.rst:255: WARNING: Footnote [1] is not referenced. [ref.footnote]

Fix footnote reference to the TDX docs on Intel website to squash away
the warning.

Fixes: 52f52ea79a4c ("Documentation/virt/kvm: Document on Trust Domain Extensions (TDX)")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20250409131356.48683f58@canb.auug.org.au/
Reviewed-by: Binbin Wu <binbin.wu@linux.intel.com>
Link: https://lore.kernel.org/r/20250410014057.14577-1-bagasdotme@gmail.com
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---

Changes since v1 [1]:
  - Add Reviewed-by: tag from Binbin Wu

[1]: https://lore.kernel.org/linux-doc/20250410014057.14577-1-bagasdotme@gmail.com/

 Documentation/virt/kvm/x86/intel-tdx.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/virt/kvm/x86/intel-tdx.rst b/Documentation/virt/kvm/x86/intel-tdx.rst
index de41d4c01e5c68..2ab90131a6402a 100644
--- a/Documentation/virt/kvm/x86/intel-tdx.rst
+++ b/Documentation/virt/kvm/x86/intel-tdx.rst
@@ -11,7 +11,7 @@ host and physical attacks.  A CPU-attested software module called 'the TDX
 module' runs inside a new CPU isolated range to provide the functionalities to
 manage and run protected VMs, a.k.a, TDX guests or TDs.
 
-Please refer to [1] for the whitepaper, specifications and other resources.
+Please refer to [1]_ for the whitepaper, specifications and other resources.
 
 This documentation describes TDX-specific KVM ABIs.  The TDX module needs to be
 initialized before it can be used by KVM to run any TDX guests.  The host

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

Re: [PATCH v2] Documentation/virt/kvm: Fix TDX whitepaper footnote reference

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 2344 bytes --]

On Fri, Apr 25, 2025 at 08:51:50AM +0700, Bagas Sanjaya wrote:
> Sphinx reports unreferenced footnote warning on TDX docs:
> 
> Documentation/virt/kvm/x86/intel-tdx.rst:255: WARNING: Footnote [1] is not referenced. [ref.footnote]
> 
> Fix footnote reference to the TDX docs on Intel website to squash away
> the warning.

Review ping...

> 
> Fixes: 52f52ea79a4c ("Documentation/virt/kvm: Document on Trust Domain Extensions (TDX)")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20250409131356.48683f58@canb.auug.org.au/
> Reviewed-by: Binbin Wu <binbin.wu@linux.intel.com>
> Link: https://lore.kernel.org/r/20250410014057.14577-1-bagasdotme@gmail.com
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> 
> Changes since v1 [1]:
>   - Add Reviewed-by: tag from Binbin Wu
> 
> [1]: https://lore.kernel.org/linux-doc/20250410014057.14577-1-bagasdotme@gmail.com/
> 
>  Documentation/virt/kvm/x86/intel-tdx.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/virt/kvm/x86/intel-tdx.rst b/Documentation/virt/kvm/x86/intel-tdx.rst
> index de41d4c01e5c68..2ab90131a6402a 100644
> --- a/Documentation/virt/kvm/x86/intel-tdx.rst
> +++ b/Documentation/virt/kvm/x86/intel-tdx.rst
> @@ -11,7 +11,7 @@ host and physical attacks.  A CPU-attested software module called 'the TDX
>  module' runs inside a new CPU isolated range to provide the functionalities to
>  manage and run protected VMs, a.k.a, TDX guests or TDs.
>  
> -Please refer to [1] for the whitepaper, specifications and other resources.
> +Please refer to [1]_ for the whitepaper, specifications and other resources.
>  
>  This documentation describes TDX-specific KVM ABIs.  The TDX module needs to be
>  initialized before it can be used by KVM to run any TDX guests.  The host
> 
> base-commit: 45eb29140e68ffe8e93a5471006858a018480a45

FYI: Stephen is still complaining [1].
Paolo: Would you like to take this patch through kvm tree? If there's no
response until 6.16 merge window, I'm intending to resend and route it
through docs tree as doc fixes for 6.16 after merge window.

Thanks.

[1]: https://lore.kernel.org/linux-next/20250516101604.7261c44a@canb.auug.org.au/

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH v2] Documentation/virt/kvm: Fix TDX whitepaper footnote reference

[Randy Dunlap]

On 4/24/25 6:51 PM, Bagas Sanjaya wrote:
> Sphinx reports unreferenced footnote warning on TDX docs:
> 
> Documentation/virt/kvm/x86/intel-tdx.rst:255: WARNING: Footnote [1] is not referenced. [ref.footnote]
> 
> Fix footnote reference to the TDX docs on Intel website to squash away
> the warning.
> 
> Fixes: 52f52ea79a4c ("Documentation/virt/kvm: Document on Trust Domain Extensions (TDX)")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20250409131356.48683f58@canb.auug.org.au/
> Reviewed-by: Binbin Wu <binbin.wu@linux.intel.com>
> Link: https://lore.kernel.org/r/20250410014057.14577-1-bagasdotme@gmail.com
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> 
> Changes since v1 [1]:
>   - Add Reviewed-by: tag from Binbin Wu
> 
> [1]: https://lore.kernel.org/linux-doc/20250410014057.14577-1-bagasdotme@gmail.com/
> 
>  Documentation/virt/kvm/x86/intel-tdx.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/virt/kvm/x86/intel-tdx.rst b/Documentation/virt/kvm/x86/intel-tdx.rst
> index de41d4c01e5c68..2ab90131a6402a 100644
> --- a/Documentation/virt/kvm/x86/intel-tdx.rst
> +++ b/Documentation/virt/kvm/x86/intel-tdx.rst
> @@ -11,7 +11,7 @@ host and physical attacks.  A CPU-attested software module called 'the TDX
>  module' runs inside a new CPU isolated range to provide the functionalities to
>  manage and run protected VMs, a.k.a, TDX guests or TDs.
>  
> -Please refer to [1] for the whitepaper, specifications and other resources.
> +Please refer to [1]_ for the whitepaper, specifications and other resources.
>  
>  This documentation describes TDX-specific KVM ABIs.  The TDX module needs to be
>  initialized before it can be used by KVM to run any TDX guests.  The host
> 
> base-commit: 45eb29140e68ffe8e93a5471006858a018480a45

-- 
~Randy