public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org
Cc: Paolo Bonzini <pbonzini@redhat.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Thomas Gleixner <tglx@linutronix.de>,
	Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>,
	Dave Hansen <dave.hansen@linux.intel.com>,
	"H. Peter Anvin" <hpa@zytor.com>,
	Isaku Yamahata <isaku.yamahata@intel.com>,
	Kai Huang <kai.huang@intel.com>,
	x86@kernel.org, kvm@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH 02/12] Documentation: kvm: tdx: Use appropriate subbullet marker
Date: Sat,  9 Jul 2022 11:20:28 +0700	[thread overview]
Message-ID: <20220709042037.21903-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20220709042037.21903-1-bagasdotme@gmail.com>

Sphinx only supports dash (-) and asterisk (*) as bullet marker. Use
them instead of dot (.) and equal (=).

Fixes: 9e54fa1ac03df3 ("Documentation/virtual/kvm: Document on Trust Domain Extensions(TDX)")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/virt/kvm/intel-tdx.rst | 23 +++++++++++++----------
 1 file changed, 13 insertions(+), 10 deletions(-)

diff --git a/Documentation/virt/kvm/intel-tdx.rst b/Documentation/virt/kvm/intel-tdx.rst
index 46ad32f3248e40..7a7c17da3a045f 100644
--- a/Documentation/virt/kvm/intel-tdx.rst
+++ b/Documentation/virt/kvm/intel-tdx.rst
@@ -216,15 +216,16 @@ The main issue for it is that the logic of kvm_x86_ops callbacks for
 TDX is different from VMX. On the other hand, the variable,
 kvm_x86_ops, is global single variable. Not per-VM, not per-vcpu.
 
-Several points to be considered.
-  . No or minimal overhead when TDX is disabled(CONFIG_INTEL_TDX_HOST=n).
-  . Avoid overhead of indirect call via function pointers.
-  . Contain the changes under arch/x86/kvm/vmx directory and share logic
+Several points to be considered:
+
+  * No or minimal overhead when TDX is disabled(CONFIG_INTEL_TDX_HOST=n).
+  * Avoid overhead of indirect call via function pointers.
+  * Contain the changes under arch/x86/kvm/vmx directory and share logic
     with VMX for maintenance.
     Even though the ways to operation on VM (VMX instruction vs TDX
     SEAM call) is different, the basic idea remains same. So, many
     logic can be shared.
-  . Future maintenance
+  * Future maintenance
     The huge change of kvm_x86_ops in (near) future isn't expected.
     a centralized file is acceptable.
 
@@ -295,21 +296,23 @@ One bit of GPA (51 or 47 bit) is repurposed so that it means shared
 with host(if set to 1) or private to TD(if cleared to 0).
 
 - The current implementation
-  . Reuse the existing MMU code with minimal update.  Because the
+
+  * Reuse the existing MMU code with minimal update.  Because the
     execution flow is mostly same. But additional operation, TDX call
     for S-EPT, is needed. So add hooks for it to kvm_x86_ops.
-  . For performance, minimize TDX SEAM call to operate on S-EPT. When
+  * For performance, minimize TDX SEAM call to operate on S-EPT. When
     getting corresponding S-EPT pages/entry from faulting GPA, don't
     use TDX SEAM call to read S-EPT entry. Instead create shadow copy
     in host memory.
     Repurpose the existing kvm_mmu_page as shadow copy of S-EPT and
     associate S-EPT to it.
-  . Treats share bit as attributes. mask/unmask the bit where
+  * Treats share bit as attributes. mask/unmask the bit where
     necessary to keep the existing traversing code works.
     Introduce kvm.arch.gfn_shared_mask and use "if (gfn_share_mask)"
     for special case.
-    = 0 : for non-TDX case
-    = 51 or 47 bit set for TDX case.
+
+    * 0 : for non-TDX case
+    * 51 or 47 bit set for TDX case.
 
   Pros:
 
-- 
An old man doll... just what I always wanted! - Clara


  parent reply	other threads:[~2022-07-09  4:21 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-09  4:20 [PATCH 00/12] Documentation: tdx: documentation fixes Bagas Sanjaya
2022-07-09  4:20 ` [PATCH 01/12] Documentation: kvm: Pad bullet lists with blank line Bagas Sanjaya
2022-07-09  4:20 ` Bagas Sanjaya [this message]
2022-07-09  4:20 ` [PATCH 03/12] Documentation: kvm: tdx: Add footnote markers Bagas Sanjaya
2022-07-09  4:20 ` [PATCH 04/12] Documentation: kvm: tdx: Use bullet list for public kvm trees Bagas Sanjaya
2022-07-09  4:20 ` [PATCH 05/12] Documentation: kvm: tdx: title typofix Bagas Sanjaya
2022-07-09  4:20 ` [PATCH 06/12] Documentation: kvm: tdx-tdp-mmu: Add blank line padding for lists Bagas Sanjaya
2022-07-09  4:20 ` [PATCH 07/12] Documentation: kvm: tdx-tdp-mmu: Use literal code block for EPT violation diagrams Bagas Sanjaya
2022-07-09  4:20 ` [PATCH 08/12] Documentation: kvm: tdx-tdp-mmu: Properly format nested list for EPT state machine Bagas Sanjaya
2022-07-09  4:26   ` Bagas Sanjaya
2022-07-12 19:34     ` Isaku Yamahata
2022-07-09  4:20 ` [PATCH 09/12] Documentation: kvm: tdx-tdp-mmu: Add blank line padding to lists in concurrent sections Bagas Sanjaya
2022-07-09  4:20 ` [PATCH 10/12] Documentation: x86: Enclose TDX initialization code inside code block Bagas Sanjaya
2022-07-12  4:12   ` Kai Huang
2022-07-09  4:20 ` [PATCH 11/12] Documentation: x86: Use literal code block for TDX dmesg output Bagas Sanjaya
2022-07-12  4:11   ` Kai Huang
2022-07-09  4:20 ` [PATCH 12/12] Documentation: kvm: Add TDX documentation to KVM table of contents Bagas Sanjaya
2022-07-12 19:35 ` [PATCH 00/12] Documentation: tdx: documentation fixes Isaku Yamahata

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=20220709042037.21903-3-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=bp@alien8.de \
    --cc=corbet@lwn.net \
    --cc=dave.hansen@linux.intel.com \
    --cc=hpa@zytor.com \
    --cc=isaku.yamahata@intel.com \
    --cc=kai.huang@intel.com \
    --cc=kvm@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=tglx@linutronix.de \
    --cc=x86@kernel.org \
    /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