summaryrefslogtreecommitdiffstats
path: root/Documentation/crypto/api-digest.rst
diff options
context:
space:
mode:
authorStephan Mueller <smueller@chronox.de>2016-10-21 04:54:22 +0200
committerJonathan Corbet <corbet@lwn.net>2016-12-13 16:37:54 -0700
commit3b72c814a8e8cd638e1ba0da4dfce501e9dff5af (patch)
treea79b261dd9f10bd3525ed97d1bb54058fc6d9a1e /Documentation/crypto/api-digest.rst
parent868c97a846a73e937d835b09b8c885a69df50ec8 (diff)
downloadlinux-3b72c814a8e8cd638e1ba0da4dfce501e9dff5af.tar.gz
linux-3b72c814a8e8cd638e1ba0da4dfce501e9dff5af.tar.bz2
linux-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-digest.rst')
-rw-r--r--Documentation/crypto/api-digest.rst122
1 files changed, 122 insertions, 0 deletions
diff --git a/Documentation/crypto/api-digest.rst b/Documentation/crypto/api-digest.rst
new file mode 100644
index 000000000000..b5eaf0f6093e
--- /dev/null
+++ b/Documentation/crypto/api-digest.rst
@@ -0,0 +1,122 @@
+Message Digest Algorithm Definitions
+------------------------------------
+
+.. kernel-doc:: include/crypto/hash.h
+ :doc: Message Digest Algorithm Definitions
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: hash_alg_common
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: ahash_alg
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: shash_alg
+
+Asynchronous Message Digest API
+-------------------------------
+
+.. kernel-doc:: include/crypto/hash.h
+ :doc: Asynchronous Message Digest API
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_alloc_ahash
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_free_ahash
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_ahash_init
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_ahash_digestsize
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_ahash_reqtfm
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_ahash_reqsize
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_ahash_setkey
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_ahash_finup
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_ahash_final
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_ahash_digest
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_ahash_export
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_ahash_import
+
+Asynchronous Hash Request Handle
+--------------------------------
+
+.. kernel-doc:: include/crypto/hash.h
+ :doc: Asynchronous Hash Request Handle
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: ahash_request_set_tfm
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: ahash_request_alloc
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: ahash_request_free
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: ahash_request_set_callback
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: ahash_request_set_crypt
+
+Synchronous Message Digest API
+------------------------------
+
+.. kernel-doc:: include/crypto/hash.h
+ :doc: Synchronous Message Digest API
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_alloc_shash
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_free_shash
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_shash_blocksize
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_shash_digestsize
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_shash_descsize
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_shash_setkey
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_shash_digest
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_shash_export
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_shash_import
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_shash_init
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_shash_update
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_shash_final
+
+.. kernel-doc:: include/crypto/hash.h
+ :functions: crypto_shash_finup