Skip to content

Commit 72f4d6f

Browse files
rddunlapaxboe
authored andcommitted
blk-mq: ABI/sysfs-block: fix docs build warnings
Clean up the async_depth documentation: - insert blank lines before and after lists where needed - convert verb tense in a few places - make lines fit within 80 characters Documentation/ABI/stable/sysfs-block:612: ERROR: Unexpected indentation. [docutils] Documentation/ABI/stable/sysfs-block:612: ERROR: Unexpected indentation. [docutils] Documentation/ABI/stable/sysfs-block:612: ERROR: Unexpected indentation. [docutils] Fixes: 2c04718 ("blk-mq: add documentation for new queue attribute async_dpeth") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jens Axboe <axboe@kernel.dk>
1 parent 5d3ae80 commit 72f4d6f

1 file changed

Lines changed: 22 additions & 11 deletions

File tree

Documentation/ABI/stable/sysfs-block

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -613,34 +613,45 @@ What: /sys/block/<disk>/queue/async_depth
613613
Date: August 2025
614614
Contact: linux-block@vger.kernel.org
615615
Description:
616-
[RW] Controls how many asynchronous requests may be allocated in the
617-
block layer. The value is always capped at nr_requests.
616+
[RW] Controls how many asynchronous requests may be allocated
617+
in the block layer. The value is always capped at nr_requests.
618618

619619
When no elevator is active (none):
620+
620621
- async_depth is always equal to nr_requests.
621622

622623
For bfq scheduler:
624+
623625
- By default, async_depth is set to 75% of nr_requests.
624626
Internal limits are then derived from this value:
627+
625628
* Sync writes: limited to async_depth (≈75% of nr_requests).
626-
* Async I/O: limited to ~2/3 of async_depth (≈50% of nr_requests).
629+
* Async I/O: limited to ~2/3 of async_depth (≈50% of
630+
nr_requests).
627631

628632
If a bfq_queue is weight-raised:
629-
* Sync writes: limited to ~1/2 of async_depth (≈37% of nr_requests).
630-
* Async I/O: limited to ~1/4 of async_depth (≈18% of nr_requests).
631633

632-
- If the user writes a custom value to async_depth, BFQ will recompute
633-
these limits proportionally based on the new value.
634+
* Sync writes: limited to ~1/2 of async_depth (≈37% of
635+
nr_requests).
636+
* Async I/O: limited to ~1/4 of async_depth (≈18% of
637+
nr_requests).
638+
639+
- If the user writes a custom value to async_depth, BFQ will
640+
recompute these limits proportionally based on the new value.
634641

635642
For Kyber:
643+
636644
- By default async_depth is set to 75% of nr_requests.
637-
- If the user writes a custom value to async_depth, then it override the
638-
default and directly control the limit for writes and async I/O.
645+
- If the user writes a custom value to async_depth, then it
646+
overrides the default and directly controls the limit for
647+
writes and async I/O.
639648

640649
For mq-deadline:
650+
641651
- By default async_depth is set to nr_requests.
642-
- If the user writes a custom value to async_depth, then it override the
643-
default and directly control the limit for writes and async I/O.
652+
- If the user writes a custom value to async_depth, then it
653+
overrides the default and directly controls the limit for
654+
writes and async I/O.
644655

645656

646657
What: /sys/block/<disk>/queue/nr_zones

0 commit comments

Comments
 (0)