lists.openwall.net   lists  /  announce  owl-users  owl-dev  john-users  john-dev  passwdqc-users  yescrypt  popa3d-users  /  oss-security  kernel-hardening  musl  sabotage  tlsify  passwords  /  crypt-dev  xvendor  /  Bugtraq  Full-Disclosure  linux-kernel  linux-netdev  linux-ext4  linux-hardening  linux-cve-announce  PHC 
Open Source and information security mailing list archives
 
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <87cymkrv24.fsf@trenco.lwn.net>
Date: Wed, 07 Aug 2024 13:29:07 -0600
From: Jonathan Corbet <corbet@....net>
To: Shibu Kumar <shibukumar.bit@...il.com>, agk@...hat.com,
 snitzer@...nel.org, mpatocka@...hat.com
Cc: Shibu Kumar <shibukumar.bit@...il.com>, dm-devel@...ts.linux.dev,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] Removal of unexpected indentation error

Shibu Kumar <shibukumar.bit@...il.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@...il.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

Powered by blists - more mailing lists

Powered by Openwall GNU/*/Linux Powered by OpenVZ