Skip to contentSkip to conversation

scsi: docs: ABI: sysfs-driver-ufs: rectify table formatting

PATCH Applied Lukas Bulwahn 3 participants 3 messages Jan 11, 2021 – Jan 13, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 scsi: docs: ABI: sysfs-driver-ufs: rectify table formatting

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.

---
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(-)
Documentation/ABI/testing/sysfs-driver-ufs +6 -4
index e77fa784d6d8..75ccc5c62b3c 100644
@@ -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
Signature · 1 line
2.17.1
Acked-by on v1 1/1
#1 lore raw
Quoted 4 lines · 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.

Quoted 8 lines

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.

Thank you!

Quoted 37 lines

---
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(-)
Documentation/ABI/testing/sysfs-driver-ufs +6 -4
index e77fa784d6d8..75ccc5c62b3c 100644
@@ -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 lore raw
In reply to Lukas Bulwahn
Quoted 10 lines · 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.

[...]

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
Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering