Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <2dd0d607e5430262ae81a3eb3c2e95412d9f7ef8.camel@linux.intel.com>
Subject: Re: [PATCH 1/4] Documentation/ABI: sysfs-driver-intel_sdsi: Fix
 sphinx warnings
From:   "David E. Box" <david.e.box@linux.intel.com>
Reply-To: david.e.box@linux.intel.com
To:     Hans de Goede <hdegoede@redhat.com>,
        Mark Gross <markgross@kernel.org>,
        Andy Shevchenko <andy@kernel.org>,
        Mark Pearson <markpearson@lenovo.com>,
        Thomas =?ISO-8859-1?Q?Wei=DFschuh?= <linux@weissschuh.net>,
        Sebastian Reichel <sre@kernel.org>
Cc:     Stephen Rothwell <sfr@canb.auug.org.au>,
        platform-driver-x86@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-pm@vger.kernel.org
Date:   Thu, 24 Mar 2022 13:06:24 -0700
In-Reply-To: <20220324164737.21765-2-hdegoede@redhat.com>
References: <20220324164737.21765-1-hdegoede@redhat.com>
         <20220324164737.21765-2-hdegoede@redhat.com>
Organization: David E. Box
Content-Type: text/plain; charset="UTF-8"
User-Agent: Evolution 3.36.5-0ubuntu1 
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Precedence: bulk

On Thu, 2022-03-24 at 17:47 +0100, Hans de Goede wrote:
> Fix the following warnings from "make htmldocs":
> 
> Documentation/ABI/testing/sysfs-driver-intel_sdsi:2:
>   WARNING: Unexpected indentation.
>   WARNING: Block quote ends without a blank line; unexpected unindent.
>   WARNING: Definition list ends without a blank line; unexpected unindent.
> 
> By turning the error-code table into a proper ReST table. While at it
> also fix the error-code table mixing tab and spaces for indentation
> (switch to all tabs).

Thanks for the fix and for clarifying how to reproduce.

David

> 
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Hans de Goede <hdegoede@redhat.com>
> ---
>  .../ABI/testing/sysfs-driver-intel_sdsi        | 18 ++++++++++--------
>  1 file changed, 10 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-driver-intel_sdsi
> b/Documentation/ABI/testing/sysfs-driver-intel_sdsi
> index ab122125ff9a..96b92c105ec4 100644
> --- a/Documentation/ABI/testing/sysfs-driver-intel_sdsi
> +++ b/Documentation/ABI/testing/sysfs-driver-intel_sdsi
> @@ -13,17 +13,19 @@ Description:
>  		Should the operation fail, one of the following error codes
>  		may be returned:
>  
> +		==========	=====
>  		Error Code	Cause
> -	        ----------	-----
> -	        EIO		General mailbox failure. Log may indicate
> cause.
> -	        EBUSY		Mailbox is owned by another agent.
> -	        EPERM		SDSI capability is not enabled in hardware.
> -	        EPROTO		Failure in mailbox protocol detected by
> driver.
> +		==========	=====
> +		EIO		General mailbox failure. Log may indicate
> cause.
> +		EBUSY		Mailbox is owned by another agent.
> +		EPERM		SDSI capability is not enabled in hardware.
> +		EPROTO		Failure in mailbox protocol detected by
> driver.
>  				See log for details.
> -	        EOVERFLOW	For provision commands, the size of the data
> +		EOVERFLOW	For provision commands, the size of the data
>  				exceeds what may be written.
> -	        ESPIPE		Seeking is not allowed.
> -	        ETIMEDOUT	Failure to complete mailbox transaction in time.
> +		ESPIPE		Seeking is not allowed.
> +		ETIMEDOUT	Failure to complete mailbox transaction in time.
> +		==========	=====
>  
>  What:		/sys/bus/auxiliary/devices/intel_vsec.sdsi.X/guid
>  Date:		Feb 2022