Skip to contentSkip to conversation

block: doc: add slice_idle_us to bfq documentation

PATCH Applied John Pittman 3 participants 4 messages Jan 8, 2019 – Jan 9, 2019

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 block: doc: add slice_idle_us to bfq documentation

Of the tunables available for the bfq I/O scheduler, the only one missing from the documentation in 'Documentation/block/bfq-iosched.txt' is slice_idle_us. Add this tunable to the documentation and a short explanation of its purpose.

---
 Documentation/block/bfq-iosched.txt | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/block/bfq-iosched.txt +7 -0
index 8d8d8f06cab2..98a8dd5ee385 100644
@@ -357,6 +357,13 @@ video playing/streaming, a very low drop rate may be more important
 than maximum throughput. In these cases, consider setting the
 strict_guarantees parameter.
 
+slice_idle_us
+-------------
+
+Controls the same tuning parameter as slice_idle, but in microseconds.
+Either tunable can be used to set idling behavior.  Afterwards, the
+other tunable will reflect the newly set value in sysfs.
+
 strict_guarantees
 -----------------
 
Signature · 1 line
2.17.2
Acked-by on v1 1/1
#1 lore raw
Quoted 11 lines

Il giorno 8 gen 2019, alle ore 22:56, John Pittman <[email protected]> ha scritto:

Of the tunables available for the bfq I/O scheduler, the only one missing from the documentation in 'Documentation/block/bfq-iosched.txt' is slice_idle_us. Add this tunable to the documentation and a short explanation of its purpose.

Thank you for adding this missing piece,
Paolo

Quoted 25 lines

---
Documentation/block/bfq-iosched.txt | 7 +++++++

1 file changed, 7 insertions(+)
Documentation/block/bfq-iosched.txt +0 -0
index 8d8d8f06cab2..98a8dd5ee385 100644
@@ -357,6 +357,13 @@ video playing/streaming, a very low drop rate may be more important

than maximum throughput. In these cases, consider setting the strict_guarantees parameter.

Documentation/block/bfq-iosched.txt +7 -0
+slice_idle_us
+-------------
+
+Controls the same tuning parameter as slice_idle, but in microseconds.
+Either tunable can be used to set idling behavior.  Afterwards, the
+other tunable will reflect the newly set value in sysfs.
+

strict_guarantees
-----------------

Signature · 1 line
2.17.2
maintainer Applied
#2 lore raw
In reply to John Pittman
Quoted 5 lines · John Pittman

Of the tunables available for the bfq I/O scheduler, the only one missing from the documentation in 'Documentation/block/bfq-iosched.txt' is slice_idle_us. Add this tunable to the documentation and a short explanation of its purpose.

Applied, but I fixed up your commit message. You should use 72 chars lengths.

Signature · 1 line
Jens Axboe
#3 lore raw

Thanks; noted.

Quoted 14 lines · Jens Axboe
Quoted 5 lines · John Pittman

Of the tunables available for the bfq I/O scheduler, the only one missing from the documentation in 'Documentation/block/bfq-iosched.txt' is slice_idle_us. Add this tunable to the documentation and a short explanation of its purpose.

Applied, but I fixed up your commit message. You should use 72 chars lengths.

--
Jens Axboe