diff options
author | Stephan Mueller <smueller@chronox.de> | 2016-10-21 05:57:27 +0300 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2016-12-14 02:38:05 +0300 |
commit | 0184cfe72d2f139c4feed7f3820ba2269f5de322 (patch) | |
tree | 5360134f8d64f7b5f3541164dcb146997235d592 /include/crypto/aead.h | |
parent | c441a4781ff1c5b78db1410f708aa96dceec5fa2 (diff) | |
download | linux-0184cfe72d2f139c4feed7f3820ba2269f5de322.tar.xz |
crypto: doc - fix source comments for Sphinx
Update comments to avoid any complaints from Sphinx during compilation.
Signed-off-by: Stephan Mueller <smueller@chronox.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'include/crypto/aead.h')
-rw-r--r-- | include/crypto/aead.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/include/crypto/aead.h b/include/crypto/aead.h index 12f84327ca36..e725155c6389 100644 --- a/include/crypto/aead.h +++ b/include/crypto/aead.h @@ -55,14 +55,14 @@ * The scatter list pointing to the input data must contain: * * * for RFC4106 ciphers, the concatenation of - * associated authentication data || IV || plaintext or ciphertext. Note, the - * same IV (buffer) is also set with the aead_request_set_crypt call. Note, - * the API call of aead_request_set_ad must provide the length of the AAD and - * the IV. The API call of aead_request_set_crypt only points to the size of - * the input plaintext or ciphertext. + * associated authentication data || IV || plaintext or ciphertext. Note, the + * same IV (buffer) is also set with the aead_request_set_crypt call. Note, + * the API call of aead_request_set_ad must provide the length of the AAD and + * the IV. The API call of aead_request_set_crypt only points to the size of + * the input plaintext or ciphertext. * * * for "normal" AEAD ciphers, the concatenation of - * associated authentication data || plaintext or ciphertext. + * associated authentication data || plaintext or ciphertext. * * It is important to note that if multiple scatter gather list entries form * the input data mentioned above, the first entry must not point to a NULL @@ -452,7 +452,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) */ |