diff mbox series

Documentation: dm-crypt: fix Unexpected indentation error.

Message ID 20240814174812.3695813-1-eslam.medhat1993@gmail.com (mailing list archive)
State Rejected, archived
Delegated to: Mike Snitzer
Headers show
Series Documentation: dm-crypt: fix Unexpected indentation error. | expand

Commit Message

Eslam Khafagy Aug. 14, 2024, 5:48 p.m. UTC
Fix 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

to reproduce:
	just run "make htmldocs"
observed error:
	Documentation/admin-guide/device-mapper/dm-crypt.rst:167: ERROR:
	Unexpected indentation.

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

Comments

Mikulas Patocka Aug. 14, 2024, 6:06 p.m. UTC | #1
On Wed, 14 Aug 2024, Eslam Khafagy wrote:

> Fix 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
> 
> to reproduce:
> 	just run "make htmldocs"
> observed error:
> 	Documentation/admin-guide/device-mapper/dm-crypt.rst:167: ERROR:
> 	Unexpected indentation.
> 
> 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.25.1

Hi

Daniel Yang <danielyangkang@gmail.com> already fixed it in 
git://git.kernel.org/pub/scm/linux/kernel/git/device-mapper/linux-dm.git 
branch remotes/origin/dm-6.11

If you think that his fix is insufficient, send a patch against his 
version.

Mikulas
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 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