diff mbox series

docs: sysfs-block: document size sysfs entry

Message ID 20240405165434.12673-1-ikegami.t@gmail.com (mailing list archive)
State New, archived
Headers show
Series docs: sysfs-block: document size sysfs entry | expand

Commit Message

Tokunori Ikegami April 5, 2024, 4:54 p.m. UTC
Document it since /sys/block/<disk>/size is undocumented.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
---
 Documentation/ABI/stable/sysfs-block | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Bart Van Assche April 5, 2024, 5:42 p.m. UTC | #1
On 4/5/24 09:54, Tokunori Ikegami wrote:
> Document it since /sys/block/<disk>/size is undocumented.
> 
> Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
> ---
>   Documentation/ABI/stable/sysfs-block | 7 +++++++
>   1 file changed, 7 insertions(+)
> 
> diff --git a/Documentation/ABI/stable/sysfs-block b/Documentation/ABI/stable/sysfs-block
> index 7718ed34777e..881049419054 100644
> --- a/Documentation/ABI/stable/sysfs-block
> +++ b/Documentation/ABI/stable/sysfs-block
> @@ -707,6 +707,13 @@ Description:
>   		zoned will report "none".
>   
>   
> +What:		/sys/block/<disk>/size
> +Date:		April 2024
> +Contact:	linux-block@vger.kernel.org
> +Description:
> +		[RO] This is the 512 bytes size sector number.

What is a "sector number"? Please change the description into something 
like the following:

   [RO] Size of the block device in units of 512 bytes.

Thanks,

Bart.
Tokunori Ikegami April 5, 2024, 9:26 p.m. UTC | #2
On 2024/04/06 2:42, Bart Van Assche wrote:
> On 4/5/24 09:54, Tokunori Ikegami wrote:
>> Document it since /sys/block/<disk>/size is undocumented.
>>
>> Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
>> ---
>>   Documentation/ABI/stable/sysfs-block | 7 +++++++
>>   1 file changed, 7 insertions(+)
>>
>> diff --git a/Documentation/ABI/stable/sysfs-block 
>> b/Documentation/ABI/stable/sysfs-block
>> index 7718ed34777e..881049419054 100644
>> --- a/Documentation/ABI/stable/sysfs-block
>> +++ b/Documentation/ABI/stable/sysfs-block
>> @@ -707,6 +707,13 @@ Description:
>>           zoned will report "none".
>>     +What:        /sys/block/<disk>/size
>> +Date:        April 2024
>> +Contact:    linux-block@vger.kernel.org
>> +Description:
>> +        [RO] This is the 512 bytes size sector number.
>
> What is a "sector number"? Please change the description into 
> something like the following:
>
>   [RO] Size of the block device in units of 512 bytes.
Thanks for your suggestion. Just fixed by the version 2 patch as mentioned.
>
> Thanks,
>
> Bart.
>
diff mbox series

Patch

diff --git a/Documentation/ABI/stable/sysfs-block b/Documentation/ABI/stable/sysfs-block
index 7718ed34777e..881049419054 100644
--- a/Documentation/ABI/stable/sysfs-block
+++ b/Documentation/ABI/stable/sysfs-block
@@ -707,6 +707,13 @@  Description:
 		zoned will report "none".
 
 
+What:		/sys/block/<disk>/size
+Date:		April 2024
+Contact:	linux-block@vger.kernel.org
+Description:
+		[RO] This is the 512 bytes size sector number.
+
+
 What:		/sys/block/<disk>/stat
 Date:		February 2008
 Contact:	Jerome Marchand <jmarchan@redhat.com>