linux-kernel - Re: [PATCH] crypto: Add explicit title heading to API docs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <72f5bbdf-2054-42a9-a9bd-aec3ebefc71e@infradead.org>
Date: Sat, 20 Sep 2025 12:01:46 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Bagas Sanjaya <bagasdotme@...il.com>,
 Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
 Linux Documentation <linux-doc@...r.kernel.org>,
 Linux Crypto <linux-crypto@...r.kernel.org>
Cc: Herbert Xu <herbert@...dor.apana.org.au>,
 "David S. Miller" <davem@...emloft.net>, Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH] crypto: Add explicit title heading to API docs



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@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.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