[PATCH -next] scsi: docs: ABI: sysfs-driver-ufs: rectify table formatting

[PATCH -next] scsi: docs: ABI: sysfs-driver-ufs: rectify table formatting

[Lukas Bulwahn]

Commit 0b2894cd0fdf ("scsi: docs: ABI: sysfs-driver-ufs: Add DeepSleep
power mode") adds new entries in tables of sysfs-driver-ufs ABI
documentation, but formatted the table incorrectly.

Hence, make htmldocs warns:

  ./Documentation/ABI/testing/sysfs-driver-ufs:{915,956}:
  WARNING: Malformed table. Text in column margin in table line 15.

Rectify table formatting for DeepSleep power mode.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
Adrian, please ack.

Martin, please pick on your scsi-next tree.

 Documentation/ABI/testing/sysfs-driver-ufs | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-driver-ufs b/Documentation/ABI/testing/sysfs-driver-ufs
index e77fa784d6d8..75ccc5c62b3c 100644
--- a/Documentation/ABI/testing/sysfs-driver-ufs
+++ b/Documentation/ABI/testing/sysfs-driver-ufs
@@ -932,8 +932,9 @@ Description:	This entry could be used to set or show the UFS device
 		5   UFS device will be powered off, UIC link will
 		    be powered off
 		6   UFS device will be moved to deep sleep, UIC link
-		will be powered off. Note, deep sleep might not be
-		supported in which case this value will not be accepted
+		    will be powered off. Note, deep sleep might not be
+		    supported in which case this value will not be
+		    accepted
 		==  ====================================================
 
 What:		/sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state
@@ -973,8 +974,9 @@ Description:	This entry could be used to set or show the UFS device
 		5   UFS device will be powered off, UIC link will
 		    be powered off
 		6   UFS device will be moved to deep sleep, UIC link
-		will be powered off. Note, deep sleep might not be
-		supported in which case this value will not be accepted
+		    will be powered off. Note, deep sleep might not be
+		    supported in which case this value will not be
+		    accepted
 		==  ====================================================
 
 What:		/sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state
-- 
2.17.1

Re: [PATCH -next] scsi: docs: ABI: sysfs-driver-ufs: rectify table formatting

[Adrian Hunter]

On 11/01/21 12:22 pm, Lukas Bulwahn wrote:
> Commit 0b2894cd0fdf ("scsi: docs: ABI: sysfs-driver-ufs: Add DeepSleep
> power mode") adds new entries in tables of sysfs-driver-ufs ABI
> documentation, but formatted the table incorrectly.
> 
> Hence, make htmldocs warns:
> 
>   ./Documentation/ABI/testing/sysfs-driver-ufs:{915,956}:
>   WARNING: Malformed table. Text in column margin in table line 15.
> 
> Rectify table formatting for DeepSleep power mode.
> 
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>

Acked-by: Adrian Hunter <adrian.hunter@intel.com>

Thank you!

> ---
> Adrian, please ack.
> 
> Martin, please pick on your scsi-next tree.
> 
>  Documentation/ABI/testing/sysfs-driver-ufs | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-driver-ufs b/Documentation/ABI/testing/sysfs-driver-ufs
> index e77fa784d6d8..75ccc5c62b3c 100644
> --- a/Documentation/ABI/testing/sysfs-driver-ufs
> +++ b/Documentation/ABI/testing/sysfs-driver-ufs
> @@ -932,8 +932,9 @@ Description:	This entry could be used to set or show the UFS device
>  		5   UFS device will be powered off, UIC link will
>  		    be powered off
>  		6   UFS device will be moved to deep sleep, UIC link
> -		will be powered off. Note, deep sleep might not be
> -		supported in which case this value will not be accepted
> +		    will be powered off. Note, deep sleep might not be
> +		    supported in which case this value will not be
> +		    accepted
>  		==  ====================================================
>  
>  What:		/sys/bus/platform/drivers/ufshcd/*/rpm_target_dev_state
> @@ -973,8 +974,9 @@ Description:	This entry could be used to set or show the UFS device
>  		5   UFS device will be powered off, UIC link will
>  		    be powered off
>  		6   UFS device will be moved to deep sleep, UIC link
> -		will be powered off. Note, deep sleep might not be
> -		supported in which case this value will not be accepted
> +		    will be powered off. Note, deep sleep might not be
> +		    supported in which case this value will not be
> +		    accepted
>  		==  ====================================================
>  
>  What:		/sys/bus/platform/drivers/ufshcd/*/spm_target_dev_state
> 

Re: [PATCH -next] scsi: docs: ABI: sysfs-driver-ufs: rectify table formatting

[Martin K. Petersen]

On Mon, 11 Jan 2021 11:22:12 +0100, Lukas Bulwahn wrote:

> Commit 0b2894cd0fdf ("scsi: docs: ABI: sysfs-driver-ufs: Add DeepSleep
> power mode") adds new entries in tables of sysfs-driver-ufs ABI
> documentation, but formatted the table incorrectly.
> 
> Hence, make htmldocs warns:
> 
>   ./Documentation/ABI/testing/sysfs-driver-ufs:{915,956}:
>   WARNING: Malformed table. Text in column margin in table line 15.
> 
> [...]

Applied to 5.11/scsi-fixes, thanks!

[1/1] scsi: docs: ABI: sysfs-driver-ufs: rectify table formatting
      https://git.kernel.org/mkp/scsi/c/f2cb4b2397ca

-- 
Martin K. Petersen	Oracle Linux Engineering