LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH] crypto: Documentation: remove colons in comments
@ 2015-01-18 23:13 Stephan Mueller
  2015-01-20  3:47 ` Herbert Xu
  0 siblings, 1 reply; 3+ messages in thread
From: Stephan Mueller @ 2015-01-18 23:13 UTC (permalink / raw)
  To: 'Herbert Xu'; +Cc: linux-crypto, 'LKML'

As documented in Documentation/kernel-doc-nano-HOWTO.txt lines
terminated with a colon are treated as headings.

The current layout of the documentation when compiling the kernel
crypto API DocBook documentation is messed up by by treating some lines
as headings. The patch removes colons from comments that shall not be
treated as headings.

Signed-off-by: Stephan Mueller <smueller@chronox.de>
---
 include/linux/crypto.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/linux/crypto.h b/include/linux/crypto.h
index 9099834..fb5ef16 100644
--- a/include/linux/crypto.h
+++ b/include/linux/crypto.h
@@ -1147,7 +1147,7 @@ static inline void ablkcipher_request_free(struct ablkcipher_request *req)
  * cipher operation completes.
  *
  * The callback function is registered with the ablkcipher_request handle and
- * must comply with the following template:
+ * must comply with the following template
  *
  *	void callback_function(struct crypto_async_request *req, int error)
  */
@@ -1174,7 +1174,7 @@ static inline void ablkcipher_request_set_callback(
  *
  * For encryption, the source is treated as the plaintext and the
  * destination is the ciphertext. For a decryption operation, the use is
- * reversed: the source is the ciphertext and the destination is the plaintext.
+ * reversed - the source is the ciphertext and the destination is the plaintext.
  */
 static inline void ablkcipher_request_set_crypt(
 	struct ablkcipher_request *req,
@@ -1509,7 +1509,7 @@ static inline void aead_request_free(struct aead_request *req)
  * completes
  *
  * The callback function is registered with the aead_request handle and
- * must comply with the following template:
+ * must comply with the following template
  *
  *	void callback_function(struct crypto_async_request *req, int error)
  */
@@ -1536,7 +1536,7 @@ static inline void aead_request_set_callback(struct aead_request *req,
  *
  * For encryption, the source is treated as the plaintext and the
  * destination is the ciphertext. For a decryption operation, the use is
- * reversed: the source is the ciphertext and the destination is the plaintext.
+ * reversed - the source is the ciphertext and the destination is the plaintext.
  *
  * IMPORTANT NOTE AEAD requires an authentication tag (MAC). For decryption,
  *		  the caller must concatenate the ciphertext followed by the
-- 
2.1.0



^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] crypto: Documentation: remove colons in comments
  2015-01-18 23:13 [PATCH] crypto: Documentation: remove colons in comments Stephan Mueller
@ 2015-01-20  3:47 ` Herbert Xu
  2015-01-21  0:28   ` Randy Dunlap
  0 siblings, 1 reply; 3+ messages in thread
From: Herbert Xu @ 2015-01-20  3:47 UTC (permalink / raw)
  To: Stephan Mueller; +Cc: linux-crypto, 'LKML'

On Mon, Jan 19, 2015 at 12:13:39AM +0100, Stephan Mueller wrote:
> As documented in Documentation/kernel-doc-nano-HOWTO.txt lines
> terminated with a colon are treated as headings.
> 
> The current layout of the documentation when compiling the kernel
> crypto API DocBook documentation is messed up by by treating some lines
> as headings. The patch removes colons from comments that shall not be
> treated as headings.
> 
> Signed-off-by: Stephan Mueller <smueller@chronox.de>

Applied.
-- 
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] crypto: Documentation: remove colons in comments
  2015-01-20  3:47 ` Herbert Xu
@ 2015-01-21  0:28   ` Randy Dunlap
  0 siblings, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2015-01-21  0:28 UTC (permalink / raw)
  To: Herbert Xu, Stephan Mueller; +Cc: linux-crypto, 'LKML'

On 01/19/15 19:47, Herbert Xu wrote:
> On Mon, Jan 19, 2015 at 12:13:39AM +0100, Stephan Mueller wrote:
>> As documented in Documentation/kernel-doc-nano-HOWTO.txt lines
>> terminated with a colon are treated as headings.
>>
>> The current layout of the documentation when compiling the kernel
>> crypto API DocBook documentation is messed up by by treating some lines
>> as headings. The patch removes colons from comments that shall not be
>> treated as headings.
>>
>> Signed-off-by: Stephan Mueller <smueller@chronox.de>
> 
> Applied.
> 

Ack. Thanks.

-- 
~Randy

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2015-01-21  0:28 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-01-18 23:13 [PATCH] crypto: Documentation: remove colons in comments Stephan Mueller
2015-01-20  3:47 ` Herbert Xu
2015-01-21  0:28   ` Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).