linux-kernel - [PATCH 2/3] Documentation: ABI: tdx: grammar improv

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Date:   Wed, 17 Aug 2022 16:54:04 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     linux-doc@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org, kvm@...r.kernel.org,
        Paolo Bonzini <pbonzini@...hat.com>,
        Jonathan Corbet <corbet@....net>,
        Isaku Yamahata <isaku.yamahata@...el.com>,
        Xiaoyao Li <xiaoyao.li@...el.com>,
        Yu Zhang <yu.c.zhang@...ux.intel.com>,
        Chao Peng <chao.p.peng@...ux.intel.com>,
        Bagas Sanjaya <bagasdotme@...il.com>
Subject: [PATCH 2/3] Documentation: ABI: tdx: grammar improv

Improve the grammar used in TDX ABI documentation.

Fixes: 12cafff9983dad ("x86/virt/tdx: Export TDX keyid number and status of TDX module via sysfs")
Fixes: 5318e72c20e45a ("x86/virt/tdx: Export information about the TDX
module via sysfs")
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 Documentation/ABI/testing/sysfs-firmware-tdx | 32 +++++++++-----------
 1 file changed, 14 insertions(+), 18 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-firmware-tdx b/Documentation/ABI/testing/sysfs-firmware-tdx
index 8bf2079b83dd9f..08c477c1d00e15 100644
--- a/Documentation/ABI/testing/sysfs-firmware-tdx
+++ b/Documentation/ABI/testing/sysfs-firmware-tdx
@@ -8,11 +8,11 @@ Description:
                 malicious hosts and some physical attacks.  This directory
                 represents the entry point directory for the TDX.
 
-                the TDX requires the TDX firmware to load into an isolated
-                memory region.  It requires a two-step loading process.  It uses
-                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").
+                This feature requires the TDX firmware to load into an isolated
+                memory region.  It uses two-step loading process; the first
+                phase is NP-SEAMLDR loader that loads the next one and the
+                second phase is P-SEAMLDR loader that loads the TDX firmware
+                (a.k.a the "TDX module").
 
                 =============== ================================================
                 keyid_num       the number of SEAM keyid as an hexadecimal
@@ -25,16 +25,12 @@ KernelVersion:  5.17
 Contact:        Isaku Yamahata <isaku.yamahata@...el.com>, kvm@...r.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,
-                minor_version, major_version, etc.
-
-                Provides the information about the TDX module loaded on the
-                platform.  It contains the following read-only files.  The
-                information corresponds to the data structure, TDSYSINFO_STRUCT.
-                The admins or VMM management software like libvirt can refer to
-                that information, determine if TDX is supported, and identify
-                the loaded the TDX module.
+                The TDX feature requires a firmware that is known as the TDX
+                module. The module exposes its information in the following
+                read-only files. The information corresponds to the data
+                structure named TDSYSINFO_STRUCT. Administrators or VMM
+                managers like libvirt can refer to it to determine if TDX is
+                supported and identify the loaded module.
 
                 ================== ============================================
                 status             string of the TDX module status.
@@ -47,12 +43,12 @@ Description:
                                      initialized
                                    * "shutdown": the TDX module is shutdown due                                      to error during initialization.
 
-                attributes         32bit flags of the TDX module attributes as
+                attributes         32-bit 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 0-30 - Reserved - set to 0.
 
                 vendor_id          vendor ID as a hexadecimal number with the
                                    "0x" prefix.
@@ -61,7 +57,7 @@ Description:
                                    the "0x" prefix.
                 minor_version      minor version as a hexadecimal number with
                                    the "0x" prefix.
-                major_version      major versionas a hexadecimal number with
+                major_version      major version as a hexadecimal number with
                                    the "0x" prefix.
                 ================== ============================================
 
-- 
An old man doll... just what I always wanted! - Clara