linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux KVM <kvm@vger.kernel.org>
Cc: Paolo Bonzini <pbonzini@redhat.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Binbin Wu <binbin.wu@linux.intel.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>,
	Isaku Yamahata <isaku.yamahata@intel.com>,
	Stephen Rothwell <sfr@canb.auug.org.au>
Subject: [PATCH v2] Documentation/virt/kvm: Fix TDX whitepaper footnote reference
Date: Fri, 25 Apr 2025 08:51:50 +0700	[thread overview]
Message-ID: <20250425015150.7228-1-bagasdotme@gmail.com> (raw)

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


             reply	other threads:[~2025-04-25  1:52 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-25  1:51 Bagas Sanjaya [this message]
2025-05-16  7:36 ` [PATCH v2] Documentation/virt/kvm: Fix TDX whitepaper footnote reference Bagas Sanjaya
2025-05-19 20:31 ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250425015150.7228-1-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=binbin.wu@linux.intel.com \
    --cc=corbet@lwn.net \
    --cc=isaku.yamahata@intel.com \
    --cc=kvm@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pbonzini@redhat.com \
    --cc=sfr@canb.auug.org.au \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).