[PATCH] dm-crypt: documentation: fix Unexpected indentation error.

Eslam Khafagy posted 1 patch 1 year, 6 months ago
Documentation/admin-guide/device-mapper/dm-crypt.rst | 1 +
1 file changed, 1 insertion(+)
[PATCH] dm-crypt: documentation: fix Unexpected indentation error.
Posted by Eslam Khafagy 1 year, 6 months ago
this fixes indentation error at Documentation/admin-guide/device-mapper/dm-crypt.rst
when compiling the documentation as per sphinx documentation: Nested lists must be separated
from the parent list items by blank lines

Signed-off-by: Eslam Khafagy <eslam.medhat1993@gmail.com>
---
 Documentation/admin-guide/device-mapper/dm-crypt.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/admin-guide/device-mapper/dm-crypt.rst b/Documentation/admin-guide/device-mapper/dm-crypt.rst
index e625830d335e..dc6ded632b22 100644
--- a/Documentation/admin-guide/device-mapper/dm-crypt.rst
+++ b/Documentation/admin-guide/device-mapper/dm-crypt.rst
@@ -164,6 +164,7 @@ 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
-- 
2.34.1
Re: [PATCH] dm-crypt: documentation: fix Unexpected indentation error.
Posted by Shuah Khan 1 year, 5 months ago
On 8/10/24 15:15, Eslam Khafagy wrote:
> this fixes indentation error at Documentation/admin-guide/device-mapper/dm-crypt.rst
> when compiling the documentation as per sphinx documentation: Nested lists must be separated
> from the parent list items by blank lines

Include information on how you found this problem. Write change log to say
what is fixed. Check submitting_patches document details on:

"Describe your changes in imperative mood"

You are missing documentation maintainer and others - run get_maintainer.pl
script.

> 
> Signed-off-by: Eslam Khafagy <eslam.medhat1993@gmail.com>
> ---
>   Documentation/admin-guide/device-mapper/dm-crypt.rst | 1 +
>   1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/admin-guide/device-mapper/dm-crypt.rst b/Documentation/admin-guide/device-mapper/dm-crypt.rst
> index e625830d335e..dc6ded632b22 100644
> --- a/Documentation/admin-guide/device-mapper/dm-crypt.rst
> +++ b/Documentation/admin-guide/device-mapper/dm-crypt.rst
> @@ -164,6 +164,7 @@ 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

thanks,
-- Shuah