[PATCH] Removal of unexpected indentation error

[PATCH] Removal of unexpected indentation error

[Shibu Kumar]

While building kernel documention using make htmldocs command, I was getting unexpected indentation error. Single description was given for two module parameters with wrong indentation.So,I corrected the indentation of both the parameter and description and also added the description separately for both the module param.

Signed-off-by: Shibu kumar shibukumar.bit@gmail.com
---
 .../admin-guide/device-mapper/dm-crypt.rst    | 20 ++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/Documentation/admin-guide/device-mapper/dm-crypt.rst b/Documentation/admin-guide/device-mapper/dm-crypt.rst
index e625830d335e..48a48bd09372 100644
--- a/Documentation/admin-guide/device-mapper/dm-crypt.rst
+++ b/Documentation/admin-guide/device-mapper/dm-crypt.rst
@@ -162,13 +162,19 @@ 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
+      Maximum size of read 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 this parameters to
+      fit the actual workload.
+
+   max_write_size
+      Maximum size of 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 this parameters to
+      fit the actual workload.
 
 
 Example scripts
-- 
2.43.0

Re: [PATCH] Removal of unexpected indentation error

[Jonathan Corbet]

Shibu Kumar <shibukumar.bit@gmail.com> writes:

> While building kernel documention using make htmldocs command, I was getting unexpected indentation error. Single description was given for two module parameters with wrong indentation.So,I corrected the indentation of both the parameter and description and also added the description separately for both the module param.
>
> Signed-off-by: Shibu kumar shibukumar.bit@gmail.com
> ---
>  .../admin-guide/device-mapper/dm-crypt.rst    | 20 ++++++++++++-------
>  1 file changed, 13 insertions(+), 7 deletions(-)

Thanks for your patch, I have applied it.  Please keep the following in
mind for future changes, though:

- A patch should make a single change; this one made two (fixing the
  indentation error and splitting the documentation for the two
  parameters).  For anything more significant than this, combining two
  changes in this way could have resulted in the patch being rejected.

- Please read our documentation on the writing of commit messages
  (Documentation/process/submitting-patches.rst in particular) and
  line-wrap your changelogs at a reasonable length.

I rewrote the changelog as:

> docs: dm-crypt: Removal of unexpected indentation error
> 
> Add the required indentation to fix this docs build error:
> 
>   Documentation/admin-guide/device-mapper/dm-crypt.rst:167: ERROR: Unexpected indentation.
> 
> Also split the documentation for read and write into separate blocks.

Thanks,

jon