[PATCH v2] block: add documentation for io_timeout

[PATCH v2] block: add documentation for io_timeout

[Weiping Zhang]

add documentation for /sys/block/<disk>/queue/io_timeout

Signed-off-by: Weiping Zhang <zhangweiping@didiglobal.com>
---
 Documentation/ABI/testing/sysfs-block | 9 +++++++++
 Documentation/block/queue-sysfs.txt   | 6 ++++++
 2 files changed, 15 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-block b/Documentation/ABI/testing/sysfs-block
index dea212db9df3..6befa2ce667d 100644
--- a/Documentation/ABI/testing/sysfs-block
+++ b/Documentation/ABI/testing/sysfs-block
@@ -271,3 +271,12 @@ Description:
 		size of 512B sectors of the zones of the device, with
 		the eventual exception of the last zone of the device
 		which may be smaller.
+
+What:		/sys/block/<disk>/queue/io_timeout
+Date:		November 2018
+Contact:	Weiping Zhang <zhangweiping@didiglobal.com>
+Description:
+		io_timeout is the timeout in milliseconds of a request in
+		block layer. The block layer will start a timer when low
+		level device driver start the request, and cancel timer
+		when request completes.
diff --git a/Documentation/block/queue-sysfs.txt b/Documentation/block/queue-sysfs.txt
index 2c1e67058fd3..c0f2a9c92cce 100644
--- a/Documentation/block/queue-sysfs.txt
+++ b/Documentation/block/queue-sysfs.txt
@@ -67,6 +67,12 @@ If set to a value larger than 0, the kernel will put the process issuing
 IO to sleep for this amont of microseconds before entering classic
 polling.
 
+io_timeout (RW)
+---------------
+This is the timeout in milliseconds of a request in block layer.
+The block layer will start a timer when low level device driver start
+the request, and cancel timer when request completes.
+
 iostats (RW)
 -------------
 This file is used to control (on/off) the iostats accounting of the
-- 
2.14.1

Re: [PATCH v2] block: add documentation for io_timeout

[Bart Van Assche]

On Thu, 2018-11-29 at 18:22 +0800, Weiping Zhang wrote:
> add documentation for /sys/block/<disk>/queue/io_timeout

Patch descriptions should consist of full sentences. That means that these
should start with a capital letter and end with a period.

> +
> +What:		/sys/block/<disk>/queue/io_timeout
> +Date:		November 2018
> +Contact:	Weiping Zhang <zhangweiping@didiglobal.com>
> +Description:
> +		io_timeout is the timeout in milliseconds of a request in
> +		block layer. The block layer will start a timer when low
> +		level device driver start the request, and cancel timer
> +		when request completes.

The grammar of that explanation needs to be improved ... I can spot three
grammatical issues.

Thanks,

Bart.