Re: [PATCH 1/4] Documentation/ABI: sysfs-driver-intel_sdsi: Fix sphinx warnings

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxxxxxxxx>
> Signed-off-by: Hans de Goede <hdegoede@xxxxxxxxxx>
> ---
>  .../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




[Index of Archives]     [Linux Kernel Development]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux