Skip to content

Commit 3fa71d0

Browse files
smuellerDDJonathan Corbet
smuellerDD
authored and
Jonathan Corbet
committed
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>
1 parent 3f692d5 commit 3fa71d0

File tree

6 files changed

+23
-401
lines changed

6 files changed

+23
-401
lines changed

‎Documentation/crypto/api-aead.rst

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -5,40 +5,13 @@ Authenticated Encryption With Associated Data (AEAD) Algorithm Definitions
55
:doc: Authenticated Encryption With Associated Data (AEAD) Cipher API
66

77
.. kernel-doc:: include/crypto/aead.h
8-
:functions: aead_request
9-
10-
.. kernel-doc:: include/crypto/aead.h
11-
:functions: aead_alg
8+
:functions: aead_request aead_alg
129

1310
Authenticated Encryption With Associated Data (AEAD) Cipher API
1411
---------------------------------------------------------------
1512

1613
.. kernel-doc:: include/crypto/aead.h
17-
:functions: crypto_alloc_aead
18-
19-
.. kernel-doc:: include/crypto/aead.h
20-
:functions: crypto_free_aead
21-
22-
.. kernel-doc:: include/crypto/aead.h
23-
:functions: crypto_aead_ivsize
24-
25-
.. kernel-doc:: include/crypto/aead.h
26-
:functions: crypto_aead_authsize
27-
28-
.. kernel-doc:: include/crypto/aead.h
29-
:functions: crypto_aead_blocksize
30-
31-
.. kernel-doc:: include/crypto/aead.h
32-
:functions: crypto_aead_setkey
33-
34-
.. kernel-doc:: include/crypto/aead.h
35-
:functions: crypto_aead_setauthsize
36-
37-
.. kernel-doc:: include/crypto/aead.h
38-
:functions: crypto_aead_encrypt
39-
40-
.. kernel-doc:: include/crypto/aead.h
41-
:functions: crypto_aead_decrypt
14+
:functions: crypto_alloc_aead crypto_free_aead crypto_aead_ivsize crypto_aead_authsize crypto_aead_blocksize crypto_aead_setkey crypto_aead_setauthsize crypto_aead_encrypt crypto_aead_decrypt
4215

4316
Asynchronous AEAD Request Handle
4417
--------------------------------
@@ -47,22 +20,4 @@ Asynchronous AEAD Request Handle
4720
:doc: Asynchronous AEAD Request Handle
4821

4922
.. kernel-doc:: include/crypto/aead.h
50-
:functions: crypto_aead_reqsize
51-
52-
.. kernel-doc:: include/crypto/aead.h
53-
:functions: aead_request_set_tfm
54-
55-
.. kernel-doc:: include/crypto/aead.h
56-
:functions: aead_request_alloc
57-
58-
.. kernel-doc:: include/crypto/aead.h
59-
:functions: aead_request_free
60-
61-
.. kernel-doc:: include/crypto/aead.h
62-
:functions: aead_request_set_callback
63-
64-
.. kernel-doc:: include/crypto/aead.h
65-
:functions: aead_request_set_crypt
66-
67-
.. kernel-doc:: include/crypto/aead.h
68-
:functions: aead_request_set_ad
23+
:functions: crypto_aead_reqsize aead_request_set_tfm aead_request_alloc aead_request_free aead_request_set_callback aead_request_set_crypt aead_request_set_ad

‎Documentation/crypto/api-akcipher.rst

Lines changed: 3 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@ Asymmetric Cipher Algorithm Definitions
22
---------------------------------------
33

44
.. kernel-doc:: include/crypto/akcipher.h
5-
:functions: akcipher_alg
6-
7-
.. kernel-doc:: include/crypto/akcipher.h
8-
:functions: akcipher_request
5+
:functions: akcipher_alg akcipher_request
96

107
Asymmetric Cipher API
118
---------------------
@@ -14,43 +11,10 @@ Asymmetric Cipher API
1411
:doc: Generic Public Key API
1512

1613
.. kernel-doc:: include/crypto/akcipher.h
17-
:functions: crypto_alloc_akcipher
18-
19-
.. kernel-doc:: include/crypto/akcipher.h
20-
:functions: crypto_free_akcipher
21-
22-
.. kernel-doc:: include/crypto/akcipher.h
23-
:functions: crypto_akcipher_set_pub_key
24-
25-
.. kernel-doc:: include/crypto/akcipher.h
26-
:functions: crypto_akcipher_set_priv_key
27-
28-
.. kernel-doc:: include/crypto/akcipher.h
29-
:functions: crypto_akcipher_maxsize
30-
31-
.. kernel-doc:: include/crypto/akcipher.h
32-
:functions: crypto_akcipher_encrypt
33-
34-
.. kernel-doc:: include/crypto/akcipher.h
35-
:functions: crypto_akcipher_decrypt
36-
37-
.. kernel-doc:: include/crypto/akcipher.h
38-
:functions: crypto_akcipher_sign
39-
40-
.. kernel-doc:: include/crypto/akcipher.h
41-
:functions: crypto_akcipher_verify
14+
:functions: crypto_alloc_akcipher crypto_free_akcipher crypto_akcipher_set_pub_key crypto_akcipher_set_priv_key crypto_akcipher_maxsize crypto_akcipher_encrypt crypto_akcipher_decrypt crypto_akcipher_sign crypto_akcipher_verify
4215

4316
Asymmetric Cipher Request Handle
4417
--------------------------------
4518

4619
.. kernel-doc:: include/crypto/akcipher.h
47-
:functions: akcipher_request_alloc
48-
49-
.. kernel-doc:: include/crypto/akcipher.h
50-
:functions: akcipher_request_free
51-
52-
.. kernel-doc:: include/crypto/akcipher.h
53-
:functions: akcipher_request_set_callback
54-
55-
.. kernel-doc:: include/crypto/akcipher.h
56-
:functions: akcipher_request_set_crypt
20+
:functions: akcipher_request_alloc akcipher_request_free akcipher_request_set_callback akcipher_request_set_crypt

‎Documentation/crypto/api-digest.rst

Lines changed: 4 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,7 @@ Message Digest Algorithm Definitions
55
:doc: Message Digest Algorithm Definitions
66

77
.. kernel-doc:: include/crypto/hash.h
8-
:functions: hash_alg_common
9-
10-
.. kernel-doc:: include/crypto/hash.h
11-
:functions: ahash_alg
12-
13-
.. kernel-doc:: include/crypto/hash.h
14-
:functions: shash_alg
8+
:functions: hash_alg_common ahash_alg shash_alg
159

1610
Asynchronous Message Digest API
1711
-------------------------------
@@ -20,40 +14,7 @@ Asynchronous Message Digest API
2014
:doc: Asynchronous Message Digest API
2115

2216
.. kernel-doc:: include/crypto/hash.h
23-
:functions: crypto_alloc_ahash
24-
25-
.. kernel-doc:: include/crypto/hash.h
26-
:functions: crypto_free_ahash
27-
28-
.. kernel-doc:: include/crypto/hash.h
29-
:functions: crypto_ahash_init
30-
31-
.. kernel-doc:: include/crypto/hash.h
32-
:functions: crypto_ahash_digestsize
33-
34-
.. kernel-doc:: include/crypto/hash.h
35-
:functions: crypto_ahash_reqtfm
36-
37-
.. kernel-doc:: include/crypto/hash.h
38-
:functions: crypto_ahash_reqsize
39-
40-
.. kernel-doc:: include/crypto/hash.h
41-
:functions: crypto_ahash_setkey
42-
43-
.. kernel-doc:: include/crypto/hash.h
44-
:functions: crypto_ahash_finup
45-
46-
.. kernel-doc:: include/crypto/hash.h
47-
:functions: crypto_ahash_final
48-
49-
.. kernel-doc:: include/crypto/hash.h
50-
:functions: crypto_ahash_digest
51-
52-
.. kernel-doc:: include/crypto/hash.h
53-
:functions: crypto_ahash_export
54-
55-
.. kernel-doc:: include/crypto/hash.h
56-
:functions: crypto_ahash_import
17+
:functions: crypto_alloc_ahash crypto_free_ahash crypto_ahash_init crypto_ahash_digestsize crypto_ahash_reqtfm crypto_ahash_reqsize crypto_ahash_setkey crypto_ahash_finup crypto_ahash_final crypto_ahash_digest crypto_ahash_export crypto_ahash_import
5718

5819
Asynchronous Hash Request Handle
5920
--------------------------------
@@ -62,19 +23,7 @@ Asynchronous Hash Request Handle
6223
:doc: Asynchronous Hash Request Handle
6324

6425
.. kernel-doc:: include/crypto/hash.h
65-
:functions: ahash_request_set_tfm
66-
67-
.. kernel-doc:: include/crypto/hash.h
68-
:functions: ahash_request_alloc
69-
70-
.. kernel-doc:: include/crypto/hash.h
71-
:functions: ahash_request_free
72-
73-
.. kernel-doc:: include/crypto/hash.h
74-
:functions: ahash_request_set_callback
75-
76-
.. kernel-doc:: include/crypto/hash.h
77-
:functions: ahash_request_set_crypt
26+
:functions: ahash_request_set_tfm ahash_request_alloc ahash_request_free ahash_request_set_callback ahash_request_set_crypt
7827

7928
Synchronous Message Digest API
8029
------------------------------
@@ -83,40 +32,4 @@ Synchronous Message Digest API
8332
:doc: Synchronous Message Digest API
8433

8534
.. kernel-doc:: include/crypto/hash.h
86-
:functions: crypto_alloc_shash
87-
88-
.. kernel-doc:: include/crypto/hash.h
89-
:functions: crypto_free_shash
90-
91-
.. kernel-doc:: include/crypto/hash.h
92-
:functions: crypto_shash_blocksize
93-
94-
.. kernel-doc:: include/crypto/hash.h
95-
:functions: crypto_shash_digestsize
96-
97-
.. kernel-doc:: include/crypto/hash.h
98-
:functions: crypto_shash_descsize
99-
100-
.. kernel-doc:: include/crypto/hash.h
101-
:functions: crypto_shash_setkey
102-
103-
.. kernel-doc:: include/crypto/hash.h
104-
:functions: crypto_shash_digest
105-
106-
.. kernel-doc:: include/crypto/hash.h
107-
:functions: crypto_shash_export
108-
109-
.. kernel-doc:: include/crypto/hash.h
110-
:functions: crypto_shash_import
111-
112-
.. kernel-doc:: include/crypto/hash.h
113-
:functions: crypto_shash_init
114-
115-
.. kernel-doc:: include/crypto/hash.h
116-
:functions: crypto_shash_update
117-
118-
.. kernel-doc:: include/crypto/hash.h
119-
:functions: crypto_shash_final
120-
121-
.. kernel-doc:: include/crypto/hash.h
122-
:functions: crypto_shash_finup
35+
:functions: crypto_alloc_shash crypto_free_shash crypto_shash_blocksize crypto_shash_digestsize crypto_shash_descsize crypto_shash_setkey crypto_shash_digest crypto_shash_export crypto_shash_import crypto_shash_init crypto_shash_update crypto_shash_final crypto_shash_finup

‎Documentation/crypto/api-kpp.rst

Lines changed: 5 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,7 @@ Key-agreement Protocol Primitives (KPP) Cipher Algorithm Definitions
22
--------------------------------------------------------------------
33

44
.. kernel-doc:: include/crypto/kpp.h
5-
:functions: kpp_request
6-
7-
.. kernel-doc:: include/crypto/kpp.h
8-
:functions: crypto_kpp
9-
10-
.. kernel-doc:: include/crypto/kpp.h
11-
:functions: kpp_alg
12-
13-
.. kernel-doc:: include/crypto/kpp.h
14-
:functions: kpp_secret
5+
:functions: kpp_request crypto_kpp kpp_alg kpp_secret
156

167
Key-agreement Protocol Primitives (KPP) Cipher API
178
--------------------------------------------------
@@ -20,40 +11,13 @@ Key-agreement Protocol Primitives (KPP) Cipher API
2011
:doc: Generic Key-agreement Protocol Primitives API
2112

2213
.. kernel-doc:: include/crypto/kpp.h
23-
:functions: crypto_alloc_kpp
24-
25-
.. kernel-doc:: include/crypto/kpp.h
26-
:functions: crypto_free_kpp
27-
28-
.. kernel-doc:: include/crypto/kpp.h
29-
:functions: crypto_kpp_set_secret
30-
31-
.. kernel-doc:: include/crypto/kpp.h
32-
:functions: crypto_kpp_generate_public_key
33-
34-
.. kernel-doc:: include/crypto/kpp.h
35-
:functions: crypto_kpp_compute_shared_secret
36-
37-
.. kernel-doc:: include/crypto/kpp.h
38-
:functions: crypto_kpp_maxsize
14+
:functions: crypto_alloc_kpp crypto_free_kpp crypto_kpp_set_secret crypto_kpp_generate_public_key crypto_kpp_compute_shared_secret crypto_kpp_maxsize
3915

4016
Key-agreement Protocol Primitives (KPP) Cipher Request Handle
4117
-------------------------------------------------------------
4218

4319
.. kernel-doc:: include/crypto/kpp.h
44-
:functions: kpp_request_alloc
45-
46-
.. kernel-doc:: include/crypto/kpp.h
47-
:functions: kpp_request_free
48-
49-
.. kernel-doc:: include/crypto/kpp.h
50-
:functions: kpp_request_set_callback
51-
52-
.. kernel-doc:: include/crypto/kpp.h
53-
:functions: kpp_request_set_input
54-
55-
.. kernel-doc:: include/crypto/kpp.h
56-
:functions: kpp_request_set_output
20+
:functions: kpp_request_alloc kpp_request_free kpp_request_set_callback kpp_request_set_input kpp_request_set_output
5721

5822
ECDH Helper Functions
5923
---------------------
@@ -62,16 +26,7 @@ ECDH Helper Functions
6226
:doc: ECDH Helper Functions
6327

6428
.. kernel-doc:: include/crypto/ecdh.h
65-
:functions: ecdh
66-
67-
.. kernel-doc:: include/crypto/ecdh.h
68-
:functions: crypto_ecdh_key_len
69-
70-
.. kernel-doc:: include/crypto/ecdh.h
71-
:functions: crypto_ecdh_encode_key
72-
73-
.. kernel-doc:: include/crypto/ecdh.h
74-
:functions: crypto_ecdh_decode_key
29+
:functions: ecdh crypto_ecdh_key_len crypto_ecdh_encode_key crypto_ecdh_decode_key
7530

7631
DH Helper Functions
7732
-------------------
@@ -80,13 +35,4 @@ DH Helper Functions
8035
:doc: DH Helper Functions
8136

8237
.. kernel-doc:: include/crypto/dh.h
83-
:functions: dh
84-
85-
.. kernel-doc:: include/crypto/dh.h
86-
:functions: crypto_dh_key_len
87-
88-
.. kernel-doc:: include/crypto/dh.h
89-
:functions: crypto_dh_encode_key
90-
91-
.. kernel-doc:: include/crypto/dh.h
92-
:functions: crypto_dh_decode_key
38+
:functions: dh crypto_dh_key_len crypto_dh_encode_key crypto_dh_decode_key

‎Documentation/crypto/api-rng.rst

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,4 @@ Crypto API Random Number API
1111
:doc: Random number generator API
1212

1313
.. kernel-doc:: include/crypto/rng.h
14-
:functions: crypto_alloc_rng
15-
16-
.. kernel-doc:: include/crypto/rng.h
17-
:functions: crypto_rng_alg
18-
19-
.. kernel-doc:: include/crypto/rng.h
20-
:functions: crypto_free_rng
21-
22-
.. kernel-doc:: include/crypto/rng.h
23-
:functions: crypto_rng_generate
24-
25-
.. kernel-doc:: include/crypto/rng.h
26-
:functions: crypto_rng_get_bytes
27-
28-
.. kernel-doc:: include/crypto/rng.h
29-
:functions: crypto_rng_reset
30-
31-
.. kernel-doc:: include/crypto/rng.h
32-
:functions: crypto_rng_seedsize
14+
:functions: crypto_alloc_rng crypto_rng_alg crypto_free_rng crypto_rng_generate crypto_rng_get_bytes crypto_rng_reset crypto_rng_seedsize

0 commit comments

Comments
 (0)