summaryrefslogtreecommitdiff
path: root/Documentation/block
diff options
context:
space:
mode:
authorBart Van Assche <bvanassche@acm.org>2019-06-28 13:07:44 -0700
committerJens Axboe <axboe@kernel.dk>2019-06-29 09:38:03 -0600
commit0c766e78bda6d4edf40779fc0cd48d0867a04d84 (patch)
tree00a07d6b3a565d99013694be825f56c81005b42e /Documentation/block
parent6728ac3396265184abe93f18b32aca329981e5ce (diff)
downloadlwn-0c766e78bda6d4edf40779fc0cd48d0867a04d84.tar.gz
lwn-0c766e78bda6d4edf40779fc0cd48d0867a04d84.zip
block, documentation: Explain the word 'segments'
Several block layer users who are not kernel developers do not know that the word 'segment' refers to an element in a DMA scatter/gather list. Make the block layer documentation easier to understand by stating explicitly what the word 'segment' stands for. Reviewed-by: Martin K. Petersen <martin.petersen@oracle.com> Signed-off-by: Bart Van Assche <bvanassche@acm.org> Signed-off-by: Jens Axboe <axboe@kernel.dk>
Diffstat (limited to 'Documentation/block')
-rw-r--r--Documentation/block/queue-sysfs.txt10
1 files changed, 6 insertions, 4 deletions
diff --git a/Documentation/block/queue-sysfs.txt b/Documentation/block/queue-sysfs.txt
index f6da2efe2105..1515dcf3dec4 100644
--- a/Documentation/block/queue-sysfs.txt
+++ b/Documentation/block/queue-sysfs.txt
@@ -98,8 +98,9 @@ This is the maximum number of kilobytes supported in a single data transfer.
max_integrity_segments (RO)
---------------------------
-When read, this file shows the max limit of integrity segments as
-set by block layer which a hardware controller can handle.
+Maximum number of elements in a DMA scatter/gather list with integrity
+data that will be submitted by the block layer core to the associated
+block driver.
max_sectors_kb (RW)
-------------------
@@ -109,11 +110,12 @@ size allowed by the hardware.
max_segments (RO)
-----------------
-Maximum number of segments of the device.
+Maximum number of elements in a DMA scatter/gather list that is submitted
+to the associated block driver.
max_segment_size (RO)
---------------------
-Maximum segment size of the device.
+Maximum size in bytes of a single element in a DMA scatter/gather list.
minimum_io_size (RO)
--------------------