Skip to content

Commit 298ced6

Browse files
bagasmeherbertx
authored andcommitted
crypto: doc - Add explicit title heading to API docs
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>
1 parent 612b1df commit 298ced6

7 files changed

Lines changed: 21 additions & 0 deletions

File tree

Documentation/crypto/api-aead.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Authenticated Encryption With Associated Data (AEAD)
2+
====================================================
3+
14
Authenticated Encryption With Associated Data (AEAD) Algorithm Definitions
25
--------------------------------------------------------------------------
36

Documentation/crypto/api-akcipher.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Asymmetric Cipher
2+
=================
3+
14
Asymmetric Cipher Algorithm Definitions
25
---------------------------------------
36

Documentation/crypto/api-digest.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Message Digest
2+
==============
3+
14
Message Digest Algorithm Definitions
25
------------------------------------
36

Documentation/crypto/api-kpp.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Key-agreement Protocol Primitives (KPP)
2+
=======================================
3+
14
Key-agreement Protocol Primitives (KPP) Cipher Algorithm Definitions
25
--------------------------------------------------------------------
36

Documentation/crypto/api-rng.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Random Number Generator (RNG)
2+
=============================
3+
14
Random Number Algorithm Definitions
25
-----------------------------------
36

Documentation/crypto/api-sig.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Asymmetric Signature
2+
====================
3+
14
Asymmetric Signature Algorithm Definitions
25
------------------------------------------
36

Documentation/crypto/api-skcipher.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Symmetric Key Cipher
2+
====================
3+
14
Block Cipher Algorithm Definitions
25
----------------------------------
36

0 commit comments

Comments
 (0)