From: Stephan Mueller <smueller@chronox.de>
To: herbert@gondor.apana.org.au
Cc: linux-crypto@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH 3/7] crypto: doc - fix source comments for Sphinx
Date: Sun, 16 Oct 2016 05:18:00 +0200 [thread overview]
Message-ID: <2601538.cyVHbpjp9L@positron.chronox.de> (raw)
In-Reply-To: <2721226.4nLlHD9uQ6@positron.chronox.de>
Update comments to avoid any complaints from Sphinx during compilation.
Signed-off-by: Stephan Mueller <smueller@chronox.de>
---
include/crypto/aead.h | 14 +++++++-------
include/crypto/hash.h | 2 +-
include/crypto/skcipher.h | 4 ++--
include/linux/crypto.h | 4 ++--
4 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/include/crypto/aead.h b/include/crypto/aead.h
index 12f8432..1bd3a2f 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
@@ -454,7 +454,7 @@ static inline void aead_request_free(struct aead_request *req)
* The callback function is registered with the aead_request handle and
* 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)
*/
static inline void aead_request_set_callback(struct aead_request *req,
u32 flags,
diff --git a/include/crypto/hash.h b/include/crypto/hash.h
index 2660588..23f15d0 100644
--- a/include/crypto/hash.h
+++ b/include/crypto/hash.h
@@ -607,7 +607,7 @@ static inline struct ahash_request *ahash_request_cast(
* The callback function is registered with the &ahash_request handle and
* 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)
*/
static inline void ahash_request_set_callback(struct ahash_request *req,
u32 flags,
diff --git a/include/crypto/skcipher.h b/include/crypto/skcipher.h
index cc4d98a..78a1de0 100644
--- a/include/crypto/skcipher.h
+++ b/include/crypto/skcipher.h
@@ -516,7 +516,7 @@ static inline void skcipher_request_zero(struct skcipher_request *req)
* skcipher_request_set_callback() - set asynchronous callback function
* @req: request handle
* @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;
* CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep
* @compl: callback function pointer to be registered with the request handle
@@ -535,7 +535,7 @@ static inline void skcipher_request_zero(struct skcipher_request *req)
* The callback function is registered with the skcipher_request handle and
* 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)
*/
static inline void skcipher_request_set_callback(struct skcipher_request *req,
u32 flags,
diff --git a/include/linux/crypto.h b/include/linux/crypto.h
index 7cee555..615a326 100644
--- a/include/linux/crypto.h
+++ b/include/linux/crypto.h
@@ -960,7 +960,7 @@ static inline void ablkcipher_request_free(struct ablkcipher_request *req)
* ablkcipher_request_set_callback() - set asynchronous callback function
* @req: request handle
* @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;
* CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep
* @compl: callback function pointer to be registered with the request handle
@@ -979,7 +979,7 @@ static inline void ablkcipher_request_free(struct ablkcipher_request *req)
* The callback function is registered with the ablkcipher_request handle and
* 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)
*/
static inline void ablkcipher_request_set_callback(
struct ablkcipher_request *req,
--
2.7.4
next prev parent reply other threads:[~2016-10-16 3:18 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-16 3:15 [PATCH 0/7] Conversion crypto API documentation to Sphinx Stephan Mueller
2016-10-16 3:16 ` [PATCH 1/7] crypto: doc - convert " Stephan Mueller
2016-10-16 3:17 ` [PATCH 2/7] crypto: doc - remove crypto API DocBook Stephan Mueller
2016-10-16 3:18 ` Stephan Mueller [this message]
2016-10-16 12:56 ` [PATCH 3/7] crypto: doc - fix source comments for Sphinx Markus Heiser
2016-10-16 13:03 ` Stephan Mueller
2016-10-16 13:42 ` Markus Heiser
2016-10-16 3:18 ` [PATCH 4/7] crypto: doc - fix separation of cipher / req API Stephan Mueller
2016-10-17 11:04 ` Jani Nikula
2016-10-17 12:35 ` Stephan Mueller
2016-10-17 13:20 ` Jani Nikula
2016-10-16 3:19 ` [PATCH 5/7] crypto: doc - add KPP documentation Stephan Mueller
2016-10-16 3:19 ` [PATCH 6/7] crypto: doc - remove crypto_alloc_ablkcipher Stephan Mueller
2016-10-16 3:22 ` [PATCH 7/7] crypto: doc - clarify AEAD memory structure Stephan Mueller
2016-10-16 13:11 ` Markus Heiser
2016-10-16 13:20 ` Stephan Mueller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2601538.cyVHbpjp9L@positron.chronox.de \
--to=smueller@chronox.de \
--cc=herbert@gondor.apana.org.au \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.