diff mbox series

Documentation: dm-crypt.rst warning + error fix

Message ID 20240807090121.61064-1-danielyangkang@gmail.com (mailing list archive)
State Accepted, archived
Delegated to: Mikulas Patocka
Headers show
Series Documentation: dm-crypt.rst warning + error fix | expand

Commit Message

Daniel Yang Aug. 7, 2024, 9:01 a.m. UTC
Signed-off-by: Daniel Yang <danielyangkang@gmail.com>
---
 .../admin-guide/device-mapper/dm-crypt.rst        | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

Comments

Jonathan Corbet Aug. 7, 2024, 7:33 p.m. UTC | #1
Daniel Yang <danielyangkang@gmail.com> writes:

> Signed-off-by: Daniel Yang <danielyangkang@gmail.com>
> ---
>  .../admin-guide/device-mapper/dm-crypt.rst        | 15 ++++++++-------
>  1 file changed, 8 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/admin-guide/device-mapper/dm-crypt.rst b/Documentation/admin-guide/device-mapper/dm-crypt.rst
> index e625830d335..552c9155165 100644
> --- a/Documentation/admin-guide/device-mapper/dm-crypt.rst
> +++ b/Documentation/admin-guide/device-mapper/dm-crypt.rst
> @@ -162,13 +162,14 @@ iv_large_sectors
>  
>  
>  Module parameters::
> -max_read_size
> -max_write_size
> -   Maximum size of read or write requests. When a request larger than this size
> -   is received, dm-crypt will split the request. The splitting improves
> -   concurrency (the split requests could be encrypted in parallel by multiple
> -   cores), but it also causes overhead. The user should tune these parameters to
> -   fit the actual workload.
> +
> +   max_read_size
> +   max_write_size
> +      Maximum size of read or write requests. When a request larger than this size
> +      is received, dm-crypt will split the request. The splitting improves
> +      concurrency (the split requests could be encrypted in parallel by multiple
> +      cores), but it also causes overhead. The user should tune these parameters to
> +      fit the actual workload.

Thanks for the patch.  It would have been better to include a proper
changelog, even for a simple change like this.  Unfortunately, I got
another fix for this error a few days ago, and have applied that.

jon
diff mbox series

Patch

diff --git a/Documentation/admin-guide/device-mapper/dm-crypt.rst b/Documentation/admin-guide/device-mapper/dm-crypt.rst
index e625830d335..552c9155165 100644
--- a/Documentation/admin-guide/device-mapper/dm-crypt.rst
+++ b/Documentation/admin-guide/device-mapper/dm-crypt.rst
@@ -162,13 +162,14 @@  iv_large_sectors
 
 
 Module parameters::
-max_read_size
-max_write_size
-   Maximum size of read or write requests. When a request larger than this size
-   is received, dm-crypt will split the request. The splitting improves
-   concurrency (the split requests could be encrypted in parallel by multiple
-   cores), but it also causes overhead. The user should tune these parameters to
-   fit the actual workload.
+
+   max_read_size
+   max_write_size
+      Maximum size of read or write requests. When a request larger than this size
+      is received, dm-crypt will split the request. The splitting improves
+      concurrency (the split requests could be encrypted in parallel by multiple
+      cores), but it also causes overhead. The user should tune these parameters to
+      fit the actual workload.
 
 
 Example scripts