2021-09-10 11:32:49

by Stephen Kitt

Subject: [PATCH] docs: block: fix discard_max_bytes references

When discard_max_hw_bytes was introduced, in commit 0034af036554
("block: make /sys/block/<dev>/queue/discard_max_bytes writeable"),
the discard_max_bytes documentation section was renamed to
discard_max_hw_bytes, but the references it contains to
discard_max_bytes weren't updated.

This patch refers to discard_max_hw_bytes instead. It also reflows the
paragraph so that sentences end lines.

Signed-off-by: Stephen Kitt <[email protected]>
---
Documentation/block/queue-sysfs.rst | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/Documentation/block/queue-sysfs.rst b/Documentation/block/queue-sysfs.rst
index 4dc7f0d499a8..5fb4299cdb23 100644
--- a/Documentation/block/queue-sysfs.rst
+++ b/Documentation/block/queue-sysfs.rst
@@ -40,10 +40,11 @@ discard_max_hw_bytes (RO)
-------------------------
Devices that support discard functionality may have internal limits on
the number of bytes that can be trimmed or unmapped in a single operation.
-The discard_max_bytes parameter is set by the device driver to the maximum
-number of bytes that can be discarded in a single operation. Discard
-requests issued to the device must not exceed this limit. A discard_max_bytes
-value of 0 means that the device does not support discard functionality.
+The `discard_max_hw_bytes` parameter is set by the device driver to the
+maximum number of bytes that can be discarded in a single operation.
+Discard requests issued to the device must not exceed this limit.
+A `discard_max_hw_bytes` value of 0 means that the device does not support
+discard functionality.

discard_max_bytes (RW)
----------------------

base-commit: 7c60610d476766e128cc4284bb6349732cbd6606
--
2.27.0

2021-09-14 20:52:55

by Jonathan Corbet

Subject: Re: [PATCH] docs: block: fix discard_max_bytes references

Stephen Kitt <[email protected]> writes:

> When discard_max_hw_bytes was introduced, in commit 0034af036554
> ("block: make /sys/block/<dev>/queue/discard_max_bytes writeable"),
> the discard_max_bytes documentation section was renamed to
> discard_max_hw_bytes, but the references it contains to
> discard_max_bytes weren't updated.
>
> This patch refers to discard_max_hw_bytes instead. It also reflows the
> paragraph so that sentences end lines.
>
> Signed-off-by: Stephen Kitt <[email protected]>
> ---
> Documentation/block/queue-sysfs.rst | 9 +++++----
> 1 file changed, 5 insertions(+), 4 deletions(-)

Applied, thanks.

jon