summaryrefslogtreecommitdiff
path: root/Documentation/crypto/api-kpp.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-kpp.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-kpp.rst')
-rw-r--r--Documentation/crypto/api-kpp.rst64
1 files changed, 5 insertions, 59 deletions
diff --git a/Documentation/crypto/api-kpp.rst b/Documentation/crypto/api-kpp.rst
index d87be9224f49..7d86ab906bdf 100644
--- a/Documentation/crypto/api-kpp.rst
+++ b/Documentation/crypto/api-kpp.rst
@@ -2,16 +2,7 @@ Key-agreement Protocol Primitives (KPP) Cipher Algorithm Definitions
--------------------------------------------------------------------
.. kernel-doc:: include/crypto/kpp.h
- :functions: kpp_request
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: crypto_kpp
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: kpp_alg
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: kpp_secret
+ :functions: kpp_request crypto_kpp kpp_alg kpp_secret
Key-agreement Protocol Primitives (KPP) Cipher API
--------------------------------------------------
@@ -20,40 +11,13 @@ Key-agreement Protocol Primitives (KPP) Cipher API
:doc: Generic Key-agreement Protocol Primitives API
.. kernel-doc:: include/crypto/kpp.h
- :functions: crypto_alloc_kpp
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: crypto_free_kpp
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: crypto_kpp_set_secret
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: crypto_kpp_generate_public_key
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: crypto_kpp_compute_shared_secret
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: crypto_kpp_maxsize
+ :functions: crypto_alloc_kpp crypto_free_kpp crypto_kpp_set_secret crypto_kpp_generate_public_key crypto_kpp_compute_shared_secret crypto_kpp_maxsize
Key-agreement Protocol Primitives (KPP) Cipher Request Handle
-------------------------------------------------------------
.. kernel-doc:: include/crypto/kpp.h
- :functions: kpp_request_alloc
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: kpp_request_free
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: kpp_request_set_callback
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: kpp_request_set_input
-
-.. kernel-doc:: include/crypto/kpp.h
- :functions: kpp_request_set_output
+ :functions: kpp_request_alloc kpp_request_free kpp_request_set_callback kpp_request_set_input kpp_request_set_output
ECDH Helper Functions
---------------------
@@ -62,16 +26,7 @@ ECDH Helper Functions
:doc: ECDH Helper Functions
.. kernel-doc:: include/crypto/ecdh.h
- :functions: ecdh
-
-.. kernel-doc:: include/crypto/ecdh.h
- :functions: crypto_ecdh_key_len
-
-.. kernel-doc:: include/crypto/ecdh.h
- :functions: crypto_ecdh_encode_key
-
-.. kernel-doc:: include/crypto/ecdh.h
- :functions: crypto_ecdh_decode_key
+ :functions: ecdh crypto_ecdh_key_len crypto_ecdh_encode_key crypto_ecdh_decode_key
DH Helper Functions
-------------------
@@ -80,13 +35,4 @@ DH Helper Functions
:doc: DH Helper Functions
.. kernel-doc:: include/crypto/dh.h
- :functions: dh
-
-.. kernel-doc:: include/crypto/dh.h
- :functions: crypto_dh_key_len
-
-.. kernel-doc:: include/crypto/dh.h
- :functions: crypto_dh_encode_key
-
-.. kernel-doc:: include/crypto/dh.h
- :functions: crypto_dh_decode_key
+ :functions: dh crypto_dh_key_len crypto_dh_encode_key crypto_dh_decode_key