| Message ID | 20250410014057.14577-1-bagasdotme@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Documentation/virt/kvm: Fix TDX whitepaper footnote reference | expand |
On 4/10/2025 9:40 AM, 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/ > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Reviewed-by: Binbin Wu <binbin.wu@linux.intel.com> And thanks for the fix. > --- > 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: fd02aa45bda6d2f2fedcab70e828867332ef7e1c
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
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/ Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- Documentation/virt/kvm/x86/intel-tdx.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) base-commit: fd02aa45bda6d2f2fedcab70e828867332ef7e1c