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@xxxxxxxxx/ Fixes: 12cafff9983dad ("x86/virt/tdx: Export TDX keyid number and status of TDX module via sysfs") Reported-by: kernel test robot <lkp@xxxxxxxxx> Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx> --- 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@xxxxxxxxx>, kvm@xxxxxxxxxxxxxxx +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@xxxxxxxxx>, kvm@xxxxxxxxxxxxxxx +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
