Commit 0aaf2146 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-4.10-2' of git://git.lwn.net/linux 

Pull more documentation updates from Jonathan Corbet:
 "This converts the crypto DocBook to Sphinx"

* tag 'docs-4.10-2' of git://git.lwn.net/linux:
  crypto: doc - optimize compilation
  crypto: doc - clarify AEAD memory structure
  crypto: doc - remove crypto_alloc_ablkcipher
  crypto: doc - add KPP documentation
  crypto: doc - fix separation of cipher / req API
  crypto: doc - fix source comments for Sphinx
  crypto: doc - remove crypto API DocBook
  crypto: doc - convert crypto API documentation to Sphinx
parents 59331c21 3fa71d0f

Documentation/DocBook/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ DOCBOOKS := z8530book.xml \ 
	    gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \

	    genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \

	    80211.xml sh.xml regulator.xml w1.xml \

	    writing_musb_glue_layer.xml crypto-API.xml iio.xml

	    writing_musb_glue_layer.xml iio.xml



ifeq ($(DOCBOOKS),)

Documentation/DocBook/crypto-API.tmpl

deleted100644 → 0
+0 −2092

File deleted.

Preview size limit exceeded, changes collapsed.

Documentation/crypto/api-aead.rst

0 → 100644
+23 −0
Original line number Diff line number Diff line 
Authenticated Encryption With Associated Data (AEAD) Algorithm Definitions

--------------------------------------------------------------------------



.. kernel-doc:: include/crypto/aead.h

   :doc: Authenticated Encryption With Associated Data (AEAD) Cipher API



.. kernel-doc:: include/crypto/aead.h

   :functions: aead_request aead_alg



Authenticated Encryption With Associated Data (AEAD) Cipher API

---------------------------------------------------------------



.. kernel-doc:: include/crypto/aead.h

   :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



Asynchronous AEAD Request Handle

--------------------------------



.. kernel-doc:: include/crypto/aead.h

   :doc: Asynchronous AEAD Request Handle



.. kernel-doc:: include/crypto/aead.h

   :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

0 → 100644
+20 −0
Original line number Diff line number Diff line 
Asymmetric Cipher Algorithm Definitions

---------------------------------------



.. kernel-doc:: include/crypto/akcipher.h

   :functions: akcipher_alg 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 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



Asymmetric Cipher Request Handle

--------------------------------



.. kernel-doc:: include/crypto/akcipher.h

   :functions: akcipher_request_alloc akcipher_request_free akcipher_request_set_callback akcipher_request_set_crypt

Documentation/crypto/api-digest.rst

0 → 100644
+35 −0
Original line number Diff line number Diff line 
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 ahash_alg 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 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



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 ahash_request_alloc ahash_request_free ahash_request_set_callback 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 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