Skip to content

Commit 0184cfe

Browse files
smuellerDDJonathan Corbet
authored andcommitted
crypto: doc - fix source comments for Sphinx
Update comments to avoid any complaints from Sphinx during compilation. Signed-off-by: Stephan Mueller <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
1 parent c441a47 commit 0184cfe

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

include/crypto/aead.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,14 @@
5555
* The scatter list pointing to the input data must contain:
5656
*
5757
* * for RFC4106 ciphers, the concatenation of
58-
* associated authentication data || IV || plaintext or ciphertext. Note, the
59-
* same IV (buffer) is also set with the aead_request_set_crypt call. Note,
60-
* the API call of aead_request_set_ad must provide the length of the AAD and
61-
* the IV. The API call of aead_request_set_crypt only points to the size of
62-
* the input plaintext or ciphertext.
58+
* associated authentication data || IV || plaintext or ciphertext. Note, the
59+
* same IV (buffer) is also set with the aead_request_set_crypt call. Note,
60+
* the API call of aead_request_set_ad must provide the length of the AAD and
61+
* the IV. The API call of aead_request_set_crypt only points to the size of
62+
* the input plaintext or ciphertext.
6363
*
6464
* * for "normal" AEAD ciphers, the concatenation of
65-
* associated authentication data || plaintext or ciphertext.
65+
* associated authentication data || plaintext or ciphertext.
6666
*
6767
* It is important to note that if multiple scatter gather list entries form
6868
* 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)
452452
* completes
453453
*
454454
* The callback function is registered with the aead_request handle and
455-
* must comply with the following template
455+
* must comply with the following template::
456456
*
457457
* void callback_function(struct crypto_async_request *req, int error)
458458
*/

include/crypto/hash.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -605,7 +605,7 @@ static inline struct ahash_request *ahash_request_cast(
605605
* the cipher operation completes.
606606
*
607607
* The callback function is registered with the &ahash_request handle and
608-
* must comply with the following template
608+
* must comply with the following template::
609609
*
610610
* void callback_function(struct crypto_async_request *req, int error)
611611
*/

include/crypto/skcipher.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ static inline void skcipher_request_zero(struct skcipher_request *req)
516516
* skcipher_request_set_callback() - set asynchronous callback function
517517
* @req: request handle
518518
* @flags: specify zero or an ORing of the flags
519-
* CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and
519+
* CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and
520520
* increase the wait queue beyond the initial maximum size;
521521
* CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep
522522
* @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)
533533
* cipher operation completes.
534534
*
535535
* The callback function is registered with the skcipher_request handle and
536-
* must comply with the following template
536+
* must comply with the following template::
537537
*
538538
* void callback_function(struct crypto_async_request *req, int error)
539539
*/

include/linux/crypto.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -960,7 +960,7 @@ static inline void ablkcipher_request_free(struct ablkcipher_request *req)
960960
* ablkcipher_request_set_callback() - set asynchronous callback function
961961
* @req: request handle
962962
* @flags: specify zero or an ORing of the flags
963-
* CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and
963+
* CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and
964964
* increase the wait queue beyond the initial maximum size;
965965
* CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep
966966
* @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)
977977
* cipher operation completes.
978978
*
979979
* The callback function is registered with the ablkcipher_request handle and
980-
* must comply with the following template
980+
* must comply with the following template::
981981
*
982982
* void callback_function(struct crypto_async_request *req, int error)
983983
*/

0 commit comments

Comments
 (0)