summaryrefslogtreecommitdiff
path: root/Documentation/crypto/api-skcipher.rst
diff options
context:
space:
mode:
authorStephan Mueller <smueller@chronox.de>2016-10-21 05:00:02 +0200
committerJonathan Corbet <corbet@lwn.net>2016-12-13 16:38:07 -0700
commit3fa71d0f58a9b9df84e8e79196f961bcfbf01b2e (patch)
treebeb00f800c10297418633bea8b96749a2ba17024 /Documentation/crypto/api-skcipher.rst
parent3f692d5f97cb834a42bcfb3cc10f5e390a9d7867 (diff)
crypto: doc - optimize compilation
The :functions: definition allows the specification of multiple function references which prevents parsing the header file multiple times. Reported-by: Jani Nikula <jani.nikula@linux.intel.com> Signed-off-by: Stephan Mueller <smueller@chronox.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/crypto/api-skcipher.rst')
-rw-r--r--Documentation/crypto/api-skcipher.rst152
1 files changed, 7 insertions, 145 deletions
diff --git a/Documentation/crypto/api-skcipher.rst b/Documentation/crypto/api-skcipher.rst
index cd8830ba23af..b20028a361a9 100644
--- a/Documentation/crypto/api-skcipher.rst
+++ b/Documentation/crypto/api-skcipher.rst
@@ -5,16 +5,7 @@ Block Cipher Algorithm Definitions
:doc: Block Cipher Algorithm Definitions
.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_alg
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: ablkcipher_alg
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: blkcipher_alg
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: cipher_alg
+ :functions: crypto_alg ablkcipher_alg blkcipher_alg cipher_alg
Symmetric Key Cipher API
------------------------
@@ -23,31 +14,7 @@ Symmetric Key Cipher API
:doc: Symmetric Key Cipher API
.. kernel-doc:: include/crypto/skcipher.h
- :functions: crypto_alloc_skcipher
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: crypto_free_skcipher
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: crypto_has_skcipher
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: crypto_skcipher_ivsize
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: crypto_skcipher_blocksize
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: crypto_skcipher_setkey
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: crypto_skcipher_reqtfm
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: crypto_skcipher_encrypt
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: crypto_skcipher_decrypt
+ :functions: crypto_alloc_skcipher crypto_free_skcipher crypto_has_skcipher crypto_skcipher_ivsize crypto_skcipher_blocksize crypto_skcipher_setkey crypto_skcipher_reqtfm crypto_skcipher_encrypt crypto_skcipher_decrypt
Symmetric Key Cipher Request Handle
-----------------------------------
@@ -56,22 +23,7 @@ Symmetric Key Cipher Request Handle
:doc: Symmetric Key Cipher Request Handle
.. kernel-doc:: include/crypto/skcipher.h
- :functions: crypto_skcipher_reqsize
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: skcipher_request_set_tfm
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: skcipher_request_alloc
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: skcipher_request_free
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: skcipher_request_set_callback
-
-.. kernel-doc:: include/crypto/skcipher.h
- :functions: skcipher_request_set_crypt
+ :functions: crypto_skcipher_reqsize skcipher_request_set_tfm skcipher_request_alloc skcipher_request_free skcipher_request_set_callback skcipher_request_set_crypt
Single Block Cipher API
-----------------------
@@ -80,25 +32,7 @@ Single Block Cipher API
:doc: Single Block Cipher API
.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_alloc_cipher
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_free_cipher
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_has_cipher
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_cipher_blocksize
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_cipher_setkey
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_cipher_encrypt_one
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_cipher_decrypt_one
+ :functions: crypto_alloc_cipher crypto_free_cipher crypto_has_cipher crypto_cipher_blocksize crypto_cipher_setkey crypto_cipher_encrypt_one crypto_cipher_decrypt_one
Asynchronous Block Cipher API - Deprecated
------------------------------------------
@@ -107,28 +41,7 @@ Asynchronous Block Cipher API - Deprecated
:doc: Asynchronous Block Cipher API
.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_free_ablkcipher
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_has_ablkcipher
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_ablkcipher_ivsize
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_ablkcipher_blocksize
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_ablkcipher_setkey
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_ablkcipher_reqtfm
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_ablkcipher_encrypt
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_ablkcipher_decrypt
+ :functions: crypto_free_ablkcipher crypto_has_ablkcipher crypto_ablkcipher_ivsize crypto_ablkcipher_blocksize crypto_ablkcipher_setkey crypto_ablkcipher_reqtfm crypto_ablkcipher_encrypt crypto_ablkcipher_decrypt
Asynchronous Cipher Request Handle - Deprecated
-----------------------------------------------
@@ -137,22 +50,7 @@ Asynchronous Cipher Request Handle - Deprecated
:doc: Asynchronous Cipher Request Handle
.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_ablkcipher_reqsize
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: ablkcipher_request_set_tfm
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: ablkcipher_request_alloc
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: ablkcipher_request_free
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: ablkcipher_request_set_callback
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: ablkcipher_request_set_crypt
+ :functions: crypto_ablkcipher_reqsize ablkcipher_request_set_tfm ablkcipher_request_alloc ablkcipher_request_free ablkcipher_request_set_callback ablkcipher_request_set_crypt
Synchronous Block Cipher API - Deprecated
-----------------------------------------
@@ -161,40 +59,4 @@ Synchronous Block Cipher API - Deprecated
:doc: Synchronous Block Cipher API
.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_alloc_blkcipher
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_free_blkcipher
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_has_blkcipher
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_blkcipher_name
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_blkcipher_ivsize
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_blkcipher_blocksize
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_blkcipher_setkey
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_blkcipher_encrypt
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_blkcipher_encrypt_iv
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_blkcipher_decrypt
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_blkcipher_decrypt_iv
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_blkcipher_set_iv
-
-.. kernel-doc:: include/linux/crypto.h
- :functions: crypto_blkcipher_get_iv
+ :functions: crypto_alloc_blkcipher rypto_free_blkcipher crypto_has_blkcipher crypto_blkcipher_name crypto_blkcipher_ivsize crypto_blkcipher_blocksize crypto_blkcipher_setkey crypto_blkcipher_encrypt crypto_blkcipher_encrypt_iv crypto_blkcipher_decrypt crypto_blkcipher_decrypt_iv crypto_blkcipher_set_iv crypto_blkcipher_get_iv