From: Bart Van Assche <bvanassche@acm.org>
To: Jens Axboe <axboe@kernel.dk>
Cc: linux-block@vger.kernel.org, Christoph Hellwig <hch@lst.de>,
Bart Van Assche <bvanassche@acm.org>,
"Martin K . Petersen" <martin.petersen@oracle.com>
Subject: [PATCH 3/4] block, documentation: Explain the word 'segments'
Date: Fri, 28 Jun 2019 13:07:44 -0700 [thread overview]
Message-ID: <20190628200745.206110-4-bvanassche@acm.org> (raw)
In-Reply-To: <20190628200745.206110-1-bvanassche@acm.org>
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.
Cc: Martin K. Petersen <martin.petersen@oracle.com>
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
Documentation/block/queue-sysfs.txt | 10 ++++++----
1 file 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)
--------------------
--
2.22.0.410.gd8fdbe21b5-goog
next prev parent reply other threads:[~2019-06-28 20:08 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-28 20:07 [PATCH 0/4] Improve block layer request queue sysfs parameter documentation Bart Van Assche
2019-06-28 20:07 ` [PATCH 1/4] block, documentation: Fix wbt_lat_usec documentation Bart Van Assche
2019-06-28 20:22 ` Martin K. Petersen
2019-06-28 20:07 ` [PATCH 2/4] block, documentation: Sort queue sysfs attribute names alphabetically Bart Van Assche
2019-06-28 20:22 ` Martin K. Petersen
2019-06-28 20:07 ` Bart Van Assche [this message]
2019-06-28 20:14 ` [PATCH 3/4] block, documentation: Explain the word 'segments' Martin K. Petersen
2019-06-28 20:07 ` [PATCH 4/4] block, documentation: Document discard_zeroes_data, fua, max_discard_segments and write_zeroes_max_bytes Bart Van Assche
2019-06-28 20:23 ` Martin K. Petersen
2019-06-29 15:38 ` [PATCH 0/4] Improve block layer request queue sysfs parameter documentation Jens Axboe
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190628200745.206110-4-bvanassche@acm.org \
--to=bvanassche@acm.org \
--cc=axboe@kernel.dk \
--cc=hch@lst.de \
--cc=linux-block@vger.kernel.org \
--cc=martin.petersen@oracle.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).