* [PATCH] crypto: Add explicit title heading to API docs
@ 2025-09-20 0:16 Bagas Sanjaya
2025-09-20 19:01 ` Randy Dunlap
2025-09-28 3:59 ` Herbert Xu
0 siblings, 2 replies; 3+ messages in thread
From: Bagas Sanjaya @ 2025-09-20 0:16 UTC (permalink / raw)
To: Linux Kernel Mailing List, Linux Documentation, Linux Crypto
Cc: Herbert Xu, David S. Miller, Jonathan Corbet, Bagas Sanjaya
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>
---
Documentation/crypto/api-aead.rst | 3 +++
Documentation/crypto/api-akcipher.rst | 3 +++
Documentation/crypto/api-digest.rst | 3 +++
Documentation/crypto/api-kpp.rst | 3 +++
Documentation/crypto/api-rng.rst | 3 +++
Documentation/crypto/api-sig.rst | 3 +++
Documentation/crypto/api-skcipher.rst | 3 +++
7 files changed, 21 insertions(+)
diff --git a/Documentation/crypto/api-aead.rst b/Documentation/crypto/api-aead.rst
index d15256f1ae3696..78d073319f96a3 100644
--- a/Documentation/crypto/api-aead.rst
+++ b/Documentation/crypto/api-aead.rst
@@ -1,3 +1,6 @@
+Authenticated Encryption With Associated Data (AEAD)
+====================================================
+
Authenticated Encryption With Associated Data (AEAD) Algorithm Definitions
--------------------------------------------------------------------------
diff --git a/Documentation/crypto/api-akcipher.rst b/Documentation/crypto/api-akcipher.rst
index ca1ecdd4a7d378..a31f5aef76678f 100644
--- a/Documentation/crypto/api-akcipher.rst
+++ b/Documentation/crypto/api-akcipher.rst
@@ -1,3 +1,6 @@
+Asymmetric Cipher
+=================
+
Asymmetric Cipher Algorithm Definitions
---------------------------------------
diff --git a/Documentation/crypto/api-digest.rst b/Documentation/crypto/api-digest.rst
index 7a1e670d6ce1a4..02a2bcc26a6470 100644
--- a/Documentation/crypto/api-digest.rst
+++ b/Documentation/crypto/api-digest.rst
@@ -1,3 +1,6 @@
+Message Digest
+==============
+
Message Digest Algorithm Definitions
------------------------------------
diff --git a/Documentation/crypto/api-kpp.rst b/Documentation/crypto/api-kpp.rst
index 7d86ab906bdf79..5794e2d10c9562 100644
--- a/Documentation/crypto/api-kpp.rst
+++ b/Documentation/crypto/api-kpp.rst
@@ -1,3 +1,6 @@
+Key-agreement Protocol Primitives (KPP)
+=======================================
+
Key-agreement Protocol Primitives (KPP) Cipher Algorithm Definitions
--------------------------------------------------------------------
diff --git a/Documentation/crypto/api-rng.rst b/Documentation/crypto/api-rng.rst
index 10ba7436cee48e..23a94c0b272eef 100644
--- a/Documentation/crypto/api-rng.rst
+++ b/Documentation/crypto/api-rng.rst
@@ -1,3 +1,6 @@
+Random Number Generator (RNG)
+=============================
+
Random Number Algorithm Definitions
-----------------------------------
diff --git a/Documentation/crypto/api-sig.rst b/Documentation/crypto/api-sig.rst
index aaec18e26d545f..4d8aba8aee8e04 100644
--- a/Documentation/crypto/api-sig.rst
+++ b/Documentation/crypto/api-sig.rst
@@ -1,3 +1,6 @@
+Asymmetric Signature
+====================
+
Asymmetric Signature Algorithm Definitions
------------------------------------------
diff --git a/Documentation/crypto/api-skcipher.rst b/Documentation/crypto/api-skcipher.rst
index 04d6cc5357c810..4b7c8160790a3c 100644
--- a/Documentation/crypto/api-skcipher.rst
+++ b/Documentation/crypto/api-skcipher.rst
@@ -1,3 +1,6 @@
+Symmetric Key Cipher
+====================
+
Block Cipher Algorithm Definitions
----------------------------------
base-commit: 381e8ee368234a51b3a4f231f6f24ff0b09d9f9e
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] crypto: Add explicit title heading to API docs
2025-09-20 0:16 [PATCH] crypto: Add explicit title heading to API docs Bagas Sanjaya
@ 2025-09-20 19:01 ` Randy Dunlap
2025-09-28 3:59 ` Herbert Xu
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2025-09-20 19:01 UTC (permalink / raw)
To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation,
Linux Crypto
Cc: Herbert Xu, David S. Miller, Jonathan Corbet
On 9/19/25 5:16 PM, Bagas Sanjaya wrote:
> 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.
Yes, much neater. Thanks.
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> Documentation/crypto/api-aead.rst | 3 +++
> Documentation/crypto/api-akcipher.rst | 3 +++
> Documentation/crypto/api-digest.rst | 3 +++
> Documentation/crypto/api-kpp.rst | 3 +++
> Documentation/crypto/api-rng.rst | 3 +++
> Documentation/crypto/api-sig.rst | 3 +++
> Documentation/crypto/api-skcipher.rst | 3 +++
> 7 files changed, 21 insertions(+)
>
> diff --git a/Documentation/crypto/api-aead.rst b/Documentation/crypto/api-aead.rst
> index d15256f1ae3696..78d073319f96a3 100644
> --- a/Documentation/crypto/api-aead.rst
> +++ b/Documentation/crypto/api-aead.rst
> @@ -1,3 +1,6 @@
> +Authenticated Encryption With Associated Data (AEAD)
> +====================================================
> +
> Authenticated Encryption With Associated Data (AEAD) Algorithm Definitions
> --------------------------------------------------------------------------
>
> diff --git a/Documentation/crypto/api-akcipher.rst b/Documentation/crypto/api-akcipher.rst
> index ca1ecdd4a7d378..a31f5aef76678f 100644
> --- a/Documentation/crypto/api-akcipher.rst
> +++ b/Documentation/crypto/api-akcipher.rst
> @@ -1,3 +1,6 @@
> +Asymmetric Cipher
> +=================
> +
> Asymmetric Cipher Algorithm Definitions
> ---------------------------------------
>
> diff --git a/Documentation/crypto/api-digest.rst b/Documentation/crypto/api-digest.rst
> index 7a1e670d6ce1a4..02a2bcc26a6470 100644
> --- a/Documentation/crypto/api-digest.rst
> +++ b/Documentation/crypto/api-digest.rst
> @@ -1,3 +1,6 @@
> +Message Digest
> +==============
> +
> Message Digest Algorithm Definitions
> ------------------------------------
>
> diff --git a/Documentation/crypto/api-kpp.rst b/Documentation/crypto/api-kpp.rst
> index 7d86ab906bdf79..5794e2d10c9562 100644
> --- a/Documentation/crypto/api-kpp.rst
> +++ b/Documentation/crypto/api-kpp.rst
> @@ -1,3 +1,6 @@
> +Key-agreement Protocol Primitives (KPP)
> +=======================================
> +
> Key-agreement Protocol Primitives (KPP) Cipher Algorithm Definitions
> --------------------------------------------------------------------
>
> diff --git a/Documentation/crypto/api-rng.rst b/Documentation/crypto/api-rng.rst
> index 10ba7436cee48e..23a94c0b272eef 100644
> --- a/Documentation/crypto/api-rng.rst
> +++ b/Documentation/crypto/api-rng.rst
> @@ -1,3 +1,6 @@
> +Random Number Generator (RNG)
> +=============================
> +
> Random Number Algorithm Definitions
> -----------------------------------
>
> diff --git a/Documentation/crypto/api-sig.rst b/Documentation/crypto/api-sig.rst
> index aaec18e26d545f..4d8aba8aee8e04 100644
> --- a/Documentation/crypto/api-sig.rst
> +++ b/Documentation/crypto/api-sig.rst
> @@ -1,3 +1,6 @@
> +Asymmetric Signature
> +====================
> +
> Asymmetric Signature Algorithm Definitions
> ------------------------------------------
>
> diff --git a/Documentation/crypto/api-skcipher.rst b/Documentation/crypto/api-skcipher.rst
> index 04d6cc5357c810..4b7c8160790a3c 100644
> --- a/Documentation/crypto/api-skcipher.rst
> +++ b/Documentation/crypto/api-skcipher.rst
> @@ -1,3 +1,6 @@
> +Symmetric Key Cipher
> +====================
> +
> Block Cipher Algorithm Definitions
> ----------------------------------
>
>
> base-commit: 381e8ee368234a51b3a4f231f6f24ff0b09d9f9e
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] crypto: Add explicit title heading to API docs
2025-09-20 0:16 [PATCH] crypto: Add explicit title heading to API docs Bagas Sanjaya
2025-09-20 19:01 ` Randy Dunlap
@ 2025-09-28 3:59 ` Herbert Xu
1 sibling, 0 replies; 3+ messages in thread
From: Herbert Xu @ 2025-09-28 3:59 UTC (permalink / raw)
To: Bagas Sanjaya
Cc: Linux Kernel Mailing List, Linux Documentation, Linux Crypto,
David S. Miller, Jonathan Corbet
On Sat, Sep 20, 2025 at 07:16:51AM +0700, Bagas Sanjaya wrote:
> 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>
> ---
> Documentation/crypto/api-aead.rst | 3 +++
> Documentation/crypto/api-akcipher.rst | 3 +++
> Documentation/crypto/api-digest.rst | 3 +++
> Documentation/crypto/api-kpp.rst | 3 +++
> Documentation/crypto/api-rng.rst | 3 +++
> Documentation/crypto/api-sig.rst | 3 +++
> Documentation/crypto/api-skcipher.rst | 3 +++
> 7 files changed, 21 insertions(+)
Patch applied. Thanks.
--
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2025-09-28 3:59 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-09-20 0:16 [PATCH] crypto: Add explicit title heading to API docs Bagas Sanjaya
2025-09-20 19:01 ` Randy Dunlap
2025-09-28 3:59 ` Herbert Xu
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).