diff options
| author | Stephan Mueller <smueller@chronox.de> | 2016-10-21 04:54:22 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-12-13 16:37:54 -0700 |
| commit | 3b72c814a8e8cd638e1ba0da4dfce501e9dff5af (patch) | |
| tree | a79b261dd9f10bd3525ed97d1bb54058fc6d9a1e /Documentation/crypto/api-akcipher.rst | |
| parent | 868c97a846a73e937d835b09b8c885a69df50ec8 (diff) | |
| download | lwn-3b72c814a8e8cd638e1ba0da4dfce501e9dff5af.tar.gz lwn-3b72c814a8e8cd638e1ba0da4dfce501e9dff5af.zip | |
crypto: doc - convert crypto API documentation to Sphinx
With the conversion of the kernel crypto API DocBook to Sphinx, the
monolithic document is broken up into individual documents. The
documentation is unchanged with the exception of a slight reordering to
keep the individual document parts self-contained.
Signed-off-by: Stephan Mueller <smueller@chronox.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/crypto/api-akcipher.rst')
| -rw-r--r-- | Documentation/crypto/api-akcipher.rst | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/Documentation/crypto/api-akcipher.rst b/Documentation/crypto/api-akcipher.rst new file mode 100644 index 000000000000..305e616991c3 --- /dev/null +++ b/Documentation/crypto/api-akcipher.rst @@ -0,0 +1,56 @@ +Asymmetric Cipher Algorithm Definitions +--------------------------------------- + +.. kernel-doc:: include/crypto/akcipher.h + :functions: akcipher_alg + +.. kernel-doc:: include/crypto/akcipher.h + :functions: akcipher_request + +Asymmetric Cipher API +--------------------- + +.. kernel-doc:: include/crypto/akcipher.h + :doc: Generic Public Key API + +.. kernel-doc:: include/crypto/akcipher.h + :functions: crypto_alloc_akcipher + +.. kernel-doc:: include/crypto/akcipher.h + :functions: crypto_free_akcipher + +.. kernel-doc:: include/crypto/akcipher.h + :functions: crypto_akcipher_set_pub_key + +.. kernel-doc:: include/crypto/akcipher.h + :functions: crypto_akcipher_set_priv_key + +Asymmetric Cipher Request Handle +-------------------------------- + +.. kernel-doc:: include/crypto/akcipher.h + :functions: akcipher_request_alloc + +.. kernel-doc:: include/crypto/akcipher.h + :functions: akcipher_request_free + +.. kernel-doc:: include/crypto/akcipher.h + :functions: akcipher_request_set_callback + +.. kernel-doc:: include/crypto/akcipher.h + :functions: akcipher_request_set_crypt + +.. kernel-doc:: include/crypto/akcipher.h + :functions: crypto_akcipher_maxsize + +.. kernel-doc:: include/crypto/akcipher.h + :functions: crypto_akcipher_encrypt + +.. kernel-doc:: include/crypto/akcipher.h + :functions: crypto_akcipher_decrypt + +.. kernel-doc:: include/crypto/akcipher.h + :functions: crypto_akcipher_sign + +.. kernel-doc:: include/crypto/akcipher.h + :functions: crypto_akcipher_verify |