Skip to contentSkip to conversation

dm-crypt: documentation: fix Unexpected indentation error.

PATCH In review Eslam Khafagy 3 participants 4 messages Aug 10, 2024 – Aug 14, 2024

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

PATCH 1/1 dm-crypt: documentation: fix Unexpected indentation error.

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

---
 Documentation/admin-guide/device-mapper/dm-crypt.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/dm-crypt.rst +1 -0
index e625830d335e..dc6ded632b22 100644
@@ -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
Signature · 1 line
2.34.1
reviewer
#1 lore raw
Quoted 3 lines · Eslam Khafagy

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.

Quoted 11 lines
---
  Documentation/admin-guide/device-mapper/dm-crypt.rst | 1 +
  1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/dm-crypt.rst +0 -0
index e625830d335e..dc6ded632b22 100644

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

Quoted 7 lines
Documentation/admin-guide/device-mapper/dm-crypt.rst +1 -0
@@ -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

#2 lore raw

PATCH 1/1 Documentation: dm-crypt: fix Unexpected indentation error.

In reply to Eslam Khafagy

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.

---
 Documentation/admin-guide/device-mapper/dm-crypt.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/dm-crypt.rst +1 -0
index e625830d335e..dc6ded632b22 100644
@@ -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
Signature · 1 line
2.25.1
maintainer
#3 lore raw

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

Quoted 31 lines · Eslam Khafagy

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.

---
 Documentation/admin-guide/device-mapper/dm-crypt.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/dm-crypt.rst +1 -0
index e625830d335e..dc6ded632b22 100644
@@ -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
Signature · 1 line
2.25.1

Hi

Daniel Yang <[email protected]> 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