[patch] block: fix up io_poll documentation

[patch] block: fix up io_poll documentation

[Jeff Moyer]

/sys/block/<dev>/queue/io_poll is a boolean.  Fix the docs.

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>

diff --git a/Documentation/block/queue-sysfs.txt b/Documentation/block/queue-sysfs.txt
index 5164215..c0a3bb5 100644
--- a/Documentation/block/queue-sysfs.txt
+++ b/Documentation/block/queue-sysfs.txt
@@ -54,9 +54,9 @@ This is the hardware sector size of the device, in bytes.
 
 io_poll (RW)
 ------------
-When read, this file shows the total number of block IO polls and how
-many returned success.  Writing '0' to this file will disable polling
-for this device.  Writing any non-zero value will enable this feature.
+When read, this file shows whether polling is enabled (1) or disabled
+(0).  Writing '0' to this file will disable polling for this device.
+Writing any non-zero value will enable this feature.
 
 io_poll_delay (RW)
 ------------------

Re: [patch] block: fix up io_poll documentation

[Jens Axboe]

On 01/03/2017 03:51 PM, Jeff Moyer wrote:
> 
> /sys/block/<dev>/queue/io_poll is a boolean.  Fix the docs.
> 
> Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
> 
> diff --git a/Documentation/block/queue-sysfs.txt b/Documentation/block/queue-sysfs.txt
> index 5164215..c0a3bb5 100644
> --- a/Documentation/block/queue-sysfs.txt
> +++ b/Documentation/block/queue-sysfs.txt
> @@ -54,9 +54,9 @@ This is the hardware sector size of the device, in bytes.
>  
>  io_poll (RW)
>  ------------
> -When read, this file shows the total number of block IO polls and how
> -many returned success.  Writing '0' to this file will disable polling
> -for this device.  Writing any non-zero value will enable this feature.
> +When read, this file shows whether polling is enabled (1) or disabled
> +(0).  Writing '0' to this file will disable polling for this device.
> +Writing any non-zero value will enable this feature.

It seems to be describing the mq hw queue io_poll file description when
read, for the queue/ one it's different. I'll apply the patch, thanks.

-- 
Jens Axboe

Re: [patch] block: fix up io_poll documentation

[Jeff Moyer]

Jens Axboe <axboe@kernel.dk> writes:

> On 01/03/2017 03:51 PM, Jeff Moyer wrote:
>> 
>> /sys/block/<dev>/queue/io_poll is a boolean.  Fix the docs.
>> 
>> Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
>> 
>> diff --git a/Documentation/block/queue-sysfs.txt b/Documentation/block/queue-sysfs.txt
>> index 5164215..c0a3bb5 100644
>> --- a/Documentation/block/queue-sysfs.txt
>> +++ b/Documentation/block/queue-sysfs.txt
>> @@ -54,9 +54,9 @@ This is the hardware sector size of the device, in bytes.
>>  
>>  io_poll (RW)
>>  ------------
>> -When read, this file shows the total number of block IO polls and how
>> -many returned success.  Writing '0' to this file will disable polling
>> -for this device.  Writing any non-zero value will enable this feature.
>> +When read, this file shows whether polling is enabled (1) or disabled
>> +(0).  Writing '0' to this file will disable polling for this device.
>> +Writing any non-zero value will enable this feature.
>
> It seems to be describing the mq hw queue io_poll file description when
> read, for the queue/ one it's different. I'll apply the patch, thanks.

Right.  It's probably time to create an mq-sysfs.txt file.

-Jeff