2022-07-23 11:15:01

by Maxim Devaev

[permalink] [raw]
Subject: [PATCH v3] docs: fixed table margin in configfs-usb-gadget-mass-storage

After merging forced_eject patch, there was a broken margin
in the configfs parameters table in the ABI documentation.
This patch fixes it.

Fixes: 421c8d9a20da ("usb: gadget: f_mass_storage: forced_eject attribute")
Reported-by: Stephen Rothwell <[email protected]>
Signed-off-by: Maxim Devaev <[email protected]>
---

v2 -> v3: Added commit description and Reported-by
v1 -> v2: Added Greg KH to CC so that he can accept this into his branch
Documentation/ABI/testing/configfs-usb-gadget-mass-storage | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-mass-storage b/Documentation/ABI/testing/configfs-usb-gadget-mass-storage
index d899adb57e81..fc0328069267 100644
--- a/Documentation/ABI/testing/configfs-usb-gadget-mass-storage
+++ b/Documentation/ABI/testing/configfs-usb-gadget-mass-storage
@@ -19,7 +19,7 @@ KernelVersion: 3.13
Description:
The attributes:

- =========== ==============================================
+ ============ ==============================================
file The path to the backing file for the LUN.
Required if LUN is not marked as removable.
ro Flag specifying access to the LUN shall be
@@ -38,4 +38,4 @@ Description:
regardless of whether the host has allowed it.
Any non-zero number of bytes written will
result in ejection.
- =========== ==============================================
+ ============ ==============================================
--
2.37.1


2022-07-24 02:55:10

by Bagas Sanjaya

[permalink] [raw]
Subject: Re: [PATCH v3] docs: fixed table margin in configfs-usb-gadget-mass-storage

On 7/23/22 17:14, Maxim Devaev wrote:
> After merging forced_eject patch, there was a broken margin
> in the configfs parameters table in the ABI documentation.
> This patch fixes it.
>

Hi Maxim,

I think the patch message can be improved, like:

"Commit 421c8d9a20da ("usb: gadget: f_mass_storage: forced_eject attribute")
adds force_eject entry to config-usb-gadget-mass-storage table.
However, the table border for attribute name is short by one `=`,
which triggers Sphinx warning.

Extend the border to cover the now-longest entry."

Thanks.

--
An old man doll... just what I always wanted! - Clara