Skip to contentSkip to conversation

Documentation/virt/kvm: Fix TDX whitepaper footnote reference

PATCH In review Bagas Sanjaya 2 participants 3 messages Apr 25, 2025 – May 19, 2025

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

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

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.

---

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

[1]: https://lore.kernel.org/linux-doc/[email protected]/

 Documentation/virt/kvm/x86/intel-tdx.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/x86/intel-tdx.rst +1 -1
index de41d4c01e5c68..2ab90131a6402a 100644
@@ -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

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw
Quoted 6 lines · 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.

Review ping...

Quoted 31 lines

---

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

[1]: https://lore.kernel.org/linux-doc/[email protected]/

 Documentation/virt/kvm/x86/intel-tdx.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/x86/intel-tdx.rst +1 -1
index de41d4c01e5c68..2ab90131a6402a 100644
@@ -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
Quoted 1 line

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/[email protected]/

Signature · 1 line
An old man doll... just what I always wanted! - Clara
reviewer Acked-by Tested-by on v2 1/1
#2 lore raw
In reply to Bagas Sanjaya
Quoted 7 lines · 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.

Quoted 6 lines

Thanks.

Quoted 25 lines

---

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

[1]: https://lore.kernel.org/linux-doc/[email protected]/

 Documentation/virt/kvm/x86/intel-tdx.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/x86/intel-tdx.rst +1 -1
index de41d4c01e5c68..2ab90131a6402a 100644
@@ -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

Signature · 1 line
~Randy