linux-kernel - Re: [PATCH v11 3/3] Documentation/x86: Document TDX attestation process

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]

Message-ID: <YwwpdsNazNBjRnVU@debian.me>
Date:   Mon, 29 Aug 2022 09:50:30 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Kuppuswamy Sathyanarayanan 
        <sathyanarayanan.kuppuswamy@...ux.intel.com>
Cc:     Thomas Gleixner <tglx@...utronix.de>,
        Ingo Molnar <mingo@...hat.com>, Borislav Petkov <bp@...en8.de>,
        Dave Hansen <dave.hansen@...ux.intel.com>, x86@...nel.org,
        Shuah Khan <shuah@...nel.org>,
        "H . Peter Anvin" <hpa@...or.com>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        "Kirill A . Shutemov" <kirill.shutemov@...ux.intel.com>,
        Tony Luck <tony.luck@...el.com>,
        Andi Kleen <ak@...ux.intel.com>,
        Kai Huang <kai.huang@...el.com>,
        Wander Lairson Costa <wander@...hat.com>,
        Isaku Yamahata <isaku.yamahata@...il.com>,
        marcelo.cerri@...onical.com, tim.gardner@...onical.com,
        khalid.elmously@...onical.com, philip.cox@...onical.com,
        linux-kernel@...r.kernel.org, linux-kselftest@...r.kernel.org,
        linux-doc@...r.kernel.org
Subject: Re: [PATCH v11 3/3] Documentation/x86: Document TDX attestation
 process

On Fri, Aug 26, 2022 at 08:06:38AM -0700, Kuppuswamy Sathyanarayanan wrote:
> +Input parameters: Parameters passed to the IOCTL and related details.
> +Output          : Details about output data and return value (with details
> +                  about the non common error values).
> +
> +TDX_CMD_GET_REPORT
> +------------------
> +
> +:Input parameters: struct tdx_report_req
> +:Output          : Upon successful execution, TDREPORT data is copied to
> +                   tdx_report_req.tdreport and returns 0 or returns
> +                   -EIO on TDCALL failure and standard error number on
> +                   other common failures.

Hi,

The field lists above trigger htmldocs warnings:

Documentation/x86/tdx.rst:269: WARNING: Unexpected indentation.
Documentation/x86/tdx.rst:275: WARNING: Field list ends without a blank line; unexpected unindent.

I have applied the fixup:

---- >8 ----
diff --git a/Documentation/x86/tdx.rst b/Documentation/x86/tdx.rst
index 45db1201b62433..c9e3ecf86e0b43 100644
--- a/Documentation/x86/tdx.rst
+++ b/Documentation/x86/tdx.rst
@@ -264,18 +264,18 @@ device to allow user space to get certain TDX guest specific details
 In this section, for each supported IOCTL, following information is
 provided along with generic description.
 
-Input parameters: Parameters passed to the IOCTL and related details.
-Output          : Details about output data and return value (with details
-                  about the non common error values).
+:Input parameters: Parameters passed to the IOCTL and related details.
+:Output: Details about output data and return value (with details
+         about the non common error values).
 
 TDX_CMD_GET_REPORT
 ------------------
 
 :Input parameters: struct tdx_report_req
-:Output          : Upon successful execution, TDREPORT data is copied to
-                   tdx_report_req.tdreport and returns 0 or returns
-                   -EIO on TDCALL failure and standard error number on
-                   other common failures.
+:Output: Upon successful execution, TDREPORT data is copied to
+         tdx_report_req.tdreport and returns 0 or returns
+         -EIO on TDCALL failure and standard error number on
+         other common failures.
 
 The TDX_CMD_GET_REPORT IOCTL can be used by the attestation software to
 get the TDX guest measurements data (with few other info) in the format

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

Download attachment "signature.asc" of type "application/pgp-signature" (229 bytes)