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

From: Sathyanarayanan Kuppuswamy  <sathyanarayanan.kuppuswamy@linux.intel.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Thomas Gleixner <tglx@linutronix.de>,
	Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>,
	Dave Hansen <dave.hansen@linux.intel.com>,
	x86@kernel.org, Shuah Khan <shuah@kernel.org>,
	"H . Peter Anvin" <hpa@zytor.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	"Kirill A . Shutemov" <kirill.shutemov@linux.intel.com>,
	Tony Luck <tony.luck@intel.com>, Andi Kleen <ak@linux.intel.com>,
	Kai Huang <kai.huang@intel.com>,
	Wander Lairson Costa <wander@redhat.com>,
	Isaku Yamahata <isaku.yamahata@gmail.com>,
	marcelo.cerri@canonical.com, tim.gardner@canonical.com,
	khalid.elmously@canonical.com, philip.cox@canonical.com,
	linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH v11 3/3] Documentation/x86: Document TDX attestation process
Date: Sun, 28 Aug 2022 20:05:22 -0700	[thread overview]
Message-ID: <17611541-38a7-7100-aa49-5321c1613fce@linux.intel.com> (raw)
In-Reply-To: <YwwpdsNazNBjRnVU@debian.me>

On 8/28/22 7:50 PM, Bagas Sanjaya wrote:
> 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:

Thanks. I will include it in next version.

> 
> ---- >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.
> 

-- 
Sathyanarayanan Kuppuswamy
Linux Kernel Developer