From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, kvm@vger.kernel.org,
Paolo Bonzini <pbonzini@redhat.com>,
Jonathan Corbet <corbet@lwn.net>,
Isaku Yamahata <isaku.yamahata@intel.com>,
Xiaoyao Li <xiaoyao.li@intel.com>,
Yu Zhang <yu.c.zhang@linux.intel.com>,
Chao Peng <chao.p.peng@linux.intel.com>,
Bagas Sanjaya <bagasdotme@gmail.com>,
kernel test robot <lkp@intel.com>
Subject: [PATCH v2 1/3] Documentation: ABI: tdx: fix formatting in ABI documentation
Date: Wed, 17 Aug 2022 19:48:35 +0700 [thread overview]
Message-ID: <20220817124837.422695-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20220817124837.422695-1-bagasdotme@gmail.com>
Sphinx reported many warnings on ABI testing symbols doc entry:
Documentation/ABI/testing/sysfs-firmware-tdx:2: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-firmware-tdx:2: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:2: WARNING: Malformed table.
Bottom/header table border does not match top border.
=============== ================================================
<snipped>
================== ============================================
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Blank line required after table.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Definition list ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Definition list ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Malformed table.
No bottom table border found.
================== ============================================
<snipped>
Fix the table and lists formatting.
Link: https://lore.kernel.org/linux-doc/202208171918.9a38xuei-lkp@intel.com/
Fixes: 12cafff9983dad ("x86/virt/tdx: Export TDX keyid number and status of TDX module via sysfs")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/ABI/testing/sysfs-firmware-tdx | 32 ++++++++++++--------
1 file changed, 19 insertions(+), 13 deletions(-)
diff --git a/Documentation/ABI/testing/sysfs-firmware-tdx b/Documentation/ABI/testing/sysfs-firmware-tdx
index eba50870ba0e95..bd743d758d7d49 100644
--- a/Documentation/ABI/testing/sysfs-firmware-tdx
+++ b/Documentation/ABI/testing/sysfs-firmware-tdx
@@ -2,6 +2,7 @@ What: /sys/firmware/tdx/
Date: March 2022
KernelVersion: 5.17
Contact: Isaku Yamahata <isaku.yamahata@intel.com>, kvm@vger.kernel.org
+Users: libvirt
Description:
Intel's Trust Domain Extensions (TDX) protect guest VMs from
malicious hosts and some physical attacks. This directory
@@ -12,16 +13,17 @@ Description:
the first phase firmware loader (a.k.a NP-SEAMLDR) that loads
the next loader and the second phase firmware loader(a.k.a
P-SEAMLDR) that loads the TDX firmware(a.k.a the "TDX module").
+
=============== ================================================
keyid_num the number of SEAM keyid as an hexadecimal
number with the "0x" prefix.
=============== ================================================
-Users: libvirt
What: /sys/firmware/tdx/tdx_module/
Date: March 2022
KernelVersion: 5.17
Contact: Isaku Yamahata <isaku.yamahata@intel.com>, kvm@vger.kernel.org
+Users: libvirt
Description:
The TDX requires a firmware as known as the TDX module. It comes
with its attributes, vendor_id, build_data, build_num,
@@ -36,19 +38,23 @@ Description:
================== ============================================
status string of the TDX module status.
- "unknown"
- "none": the TDX module is not loaded
- "loaded": The TDX module is loaded, but not
- initialized
- "initialized": the TDX module is fully
- initialized
- "shutdown": the TDX module is shutdown due to
- error during initialization.
+
+ * "unknown", "none": the TDX module is not
+ loaded
+ * "loaded": The TDX module is loaded, but
+ not initialized
+ * "initialized": the TDX module is fully
+ initialized
+ * "shutdown": the TDX module is shutdown due
+ to error during initialization.
+
attributes 32bit flags of the TDX module attributes as
a hexadecimal number with the "0x" prefix.
- Bits 31 - a production module(0) or
- a debug module(1).
- Bits 30:0 Reserved - set to 0.
+
+ * Bits 31 - a production module(0) or
+ a debug module(1).
+ * Bits 30:0 Reserved - set to 0.
+
vendor_id vendor ID as a hexadecimal number with the
"0x" prefix.
build_date build date in yyyymmdd BCD format.
@@ -59,4 +65,4 @@ Description:
major_version major versionas a hexadecimal number with
the "0x" prefix.
================== ============================================
-Users: libvirt
\ No newline at end of file
+
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2022-08-17 12:49 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-17 12:48 [PATCH v2 0/3] Documentation fixes for kvm-upstream-workaround Bagas Sanjaya
2022-08-17 12:48 ` Bagas Sanjaya [this message]
2022-08-17 12:48 ` [PATCH v2 2/3] Documentation: ABI: tdx: grammar improv Bagas Sanjaya
2022-08-17 12:48 ` [PATCH v2 3/3] Documentation: kvm: enclose the final closing brace in code block Bagas Sanjaya
2022-08-23 5:57 ` [PATCH v2 0/3] Documentation fixes for kvm-upstream-workaround 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=20220817124837.422695-2-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=chao.p.peng@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=lkp@intel.com \
--cc=pbonzini@redhat.com \
--cc=xiaoyao.li@intel.com \
--cc=yu.c.zhang@linux.intel.com \
/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