Shibu Kumar <[email protected]> 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 [email protected] > --- > .../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
