block: add documentation for io_timeout
Subsystems (2)
PATCH v2 1/1 block: add documentation for io_timeout
add documentation for /sys/block/<disk>/queue/io_timeout
Signed-off-by Weiping Zhang <[email protected]>
--- Documentation/ABI/testing/sysfs-block | 9 +++++++++ Documentation/block/queue-sysfs.txt | 6 ++++++ 2 files changed, 15 insertions(+)
Documentation/ABI/testing/sysfs-block +9 -0
@@ -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 <[email protected]> +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.
Documentation/block/queue-sysfs.txt +6 -0
@@ -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
Signature · 1 line
2.14.1
Quoted 1 line · Weiping Zhang
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.
Quoted 8 lines
+- +-What: /sys/block/<disk>/queue/io_timeout +-Date: November 2018 +-Contact: Weiping Zhang <[email protected]>>+-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.