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

Bagas Sanjaya
2022-08-29T02:50:41Z

[-- Attachment #1: Type: text/plain, Size: 2509 bytes --]

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]