Skip to contentSkip to conversation

Documentation: dm-crypt.rst warning + error fix

PATCH In review Daniel Yang 2 participants 2 messages Aug 7, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: dm-crypt.rst warning + error fix

---
 .../admin-guide/device-mapper/dm-crypt.rst        | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)
Documentation/admin-guide/device-mapper/dm-crypt.rst +8 -7
index e625830d335..552c9155165 100644
@@ -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
Signature · 1 line
2.39.2
maintainer
#1 lore raw
Quoted 18 lines · Daniel Yang
---
 .../admin-guide/device-mapper/dm-crypt.rst        | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)
Documentation/admin-guide/device-mapper/dm-crypt.rst +0 -5
index e625830d335..552c9155165 100644
@@ -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

Documentation/admin-guide/device-mapper/dm-crypt.rst iv_large_sectors · line 172

Quoted 10 lines
Documentation/admin-guide/device-mapper/dm-crypt.rst +8 -2
-   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