Commit 0184cfe7 authored by Stephan Mueller's avatar Stephan Mueller Committed by Jonathan Corbet

crypto: doc - fix source comments for Sphinx

Update comments to avoid any complaints from Sphinx during compilation.
Signed-off-by: default avatarStephan Mueller <smueller@chronox.de>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent c441a478
...@@ -55,14 +55,14 @@ ...@@ -55,14 +55,14 @@
* The scatter list pointing to the input data must contain: * The scatter list pointing to the input data must contain:
* *
* * for RFC4106 ciphers, the concatenation of * * for RFC4106 ciphers, the concatenation of
* associated authentication data || IV || plaintext or ciphertext. Note, the * associated authentication data || IV || plaintext or ciphertext. Note, the
* same IV (buffer) is also set with the aead_request_set_crypt call. Note, * 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 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 IV. The API call of aead_request_set_crypt only points to the size of
* the input plaintext or ciphertext. * the input plaintext or ciphertext.
* *
* * for "normal" AEAD ciphers, the concatenation of * * 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 * 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 * 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) ...@@ -452,7 +452,7 @@ static inline void aead_request_free(struct aead_request *req)
* completes * completes
* *
* The callback function is registered with the aead_request handle and * 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) * void callback_function(struct crypto_async_request *req, int error)
*/ */
......
...@@ -605,7 +605,7 @@ static inline struct ahash_request *ahash_request_cast( ...@@ -605,7 +605,7 @@ static inline struct ahash_request *ahash_request_cast(
* the cipher operation completes. * the cipher operation completes.
* *
* The callback function is registered with the &ahash_request handle and * The callback function is registered with the &ahash_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) * void callback_function(struct crypto_async_request *req, int error)
*/ */
......
...@@ -516,7 +516,7 @@ static inline void skcipher_request_zero(struct skcipher_request *req) ...@@ -516,7 +516,7 @@ static inline void skcipher_request_zero(struct skcipher_request *req)
* skcipher_request_set_callback() - set asynchronous callback function * skcipher_request_set_callback() - set asynchronous callback function
* @req: request handle * @req: request handle
* @flags: specify zero or an ORing of the flags * @flags: specify zero or an ORing of the flags
* CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and * CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and
* increase the wait queue beyond the initial maximum size; * increase the wait queue beyond the initial maximum size;
* CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep * CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep
* @compl: callback function pointer to be registered with the request handle * @compl: callback function pointer to be registered with the request handle
...@@ -533,7 +533,7 @@ static inline void skcipher_request_zero(struct skcipher_request *req) ...@@ -533,7 +533,7 @@ static inline void skcipher_request_zero(struct skcipher_request *req)
* cipher operation completes. * cipher operation completes.
* *
* The callback function is registered with the skcipher_request handle and * The callback function is registered with the skcipher_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) * void callback_function(struct crypto_async_request *req, int error)
*/ */
......
...@@ -960,7 +960,7 @@ static inline void ablkcipher_request_free(struct ablkcipher_request *req) ...@@ -960,7 +960,7 @@ static inline void ablkcipher_request_free(struct ablkcipher_request *req)
* ablkcipher_request_set_callback() - set asynchronous callback function * ablkcipher_request_set_callback() - set asynchronous callback function
* @req: request handle * @req: request handle
* @flags: specify zero or an ORing of the flags * @flags: specify zero or an ORing of the flags
* CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and * CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and
* increase the wait queue beyond the initial maximum size; * increase the wait queue beyond the initial maximum size;
* CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep * CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep
* @compl: callback function pointer to be registered with the request handle * @compl: callback function pointer to be registered with the request handle
...@@ -977,7 +977,7 @@ static inline void ablkcipher_request_free(struct ablkcipher_request *req) ...@@ -977,7 +977,7 @@ static inline void ablkcipher_request_free(struct ablkcipher_request *req)
* cipher operation completes. * cipher operation completes.
* *
* The callback function is registered with the ablkcipher_request handle and * 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) * void callback_function(struct crypto_async_request *req, int error)
*/ */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment