]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
crypto: doc - Add explicit title heading to API docs
authorBagas Sanjaya <bagasdotme@gmail.com>
Sat, 20 Sep 2025 00:16:51 +0000 (07:16 +0700)
committerHerbert Xu <herbert@gondor.apana.org.au>
Sun, 28 Sep 2025 03:54:48 +0000 (11:54 +0800)
Documentation for crypto programming interfaces lack explicit title.
As such, all its sections become entries in the toctree index.

Add the title heading to tidy up toctree.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
Documentation/crypto/api-aead.rst
Documentation/crypto/api-akcipher.rst
Documentation/crypto/api-digest.rst
Documentation/crypto/api-kpp.rst
Documentation/crypto/api-rng.rst
Documentation/crypto/api-sig.rst
Documentation/crypto/api-skcipher.rst

index d15256f1ae36961a063ac99d51c60cfa60197c9c..78d073319f96a35e8d2b2e2b1d0b1b7b499a6573 100644 (file)
@@ -1,3 +1,6 @@
+Authenticated Encryption With Associated Data (AEAD)
+====================================================
+
 Authenticated Encryption With Associated Data (AEAD) Algorithm Definitions
 --------------------------------------------------------------------------
 
index ca1ecdd4a7d3780e00344be7438315324d1052e1..a31f5aef76678f1301f565190e55f1b302770d8d 100644 (file)
@@ -1,3 +1,6 @@
+Asymmetric Cipher
+=================
+
 Asymmetric Cipher Algorithm Definitions
 ---------------------------------------
 
index 7a1e670d6ce1a439577b2728273882f08dea618b..02a2bcc26a64705775f40e1c9a990b9de3a9ded4 100644 (file)
@@ -1,3 +1,6 @@
+Message Digest
+==============
+
 Message Digest Algorithm Definitions
 ------------------------------------
 
index 7d86ab906bdf793b5995ab14ab390163343425ef..5794e2d10c9562ad5bddfdd6de5c4f82539a2411 100644 (file)
@@ -1,3 +1,6 @@
+Key-agreement Protocol Primitives (KPP)
+=======================================
+
 Key-agreement Protocol Primitives (KPP) Cipher Algorithm Definitions
 --------------------------------------------------------------------
 
index 10ba7436cee48ee396e161c7ce6e97a5287c3601..23a94c0b272eef7226f354b0ffc6a3033f326f5a 100644 (file)
@@ -1,3 +1,6 @@
+Random Number Generator (RNG)
+=============================
+
 Random Number Algorithm Definitions
 -----------------------------------
 
index aaec18e26d545f69d18a0c5f132a4a8d1337cbf2..4d8aba8aee8e04ac7752255072ad6654a04993b1 100644 (file)
@@ -1,3 +1,6 @@
+Asymmetric Signature
+====================
+
 Asymmetric Signature Algorithm Definitions
 ------------------------------------------
 
index 04d6cc5357c810b7c11cb3353f06af020b7d4b42..4b7c8160790a3c90a9ccc5fb81b7bedd61441587 100644 (file)
@@ -1,3 +1,6 @@
+Symmetric Key Cipher
+====================
+
 Block Cipher Algorithm Definitions
 ----------------------------------