| Message ID | 89d99476b2b57bcd3e306996ec4a60db1706253f.1728378559.git.lukas@wunner.de (mailing list archive) |
|---|---|
| State | Accepted |
| Delegated to: | Herbert Xu |
| Headers | show |
| Series | [cryptodev-2.6] crypto: doc - Fix akcipher title reference | expand |
On Tue, Oct 08, 2024 at 11:12:01AM +0200, Lukas Wunner wrote: > Stephen reports a documentation build warning for "make htmldocs" > introduced by recent commit 6b34562f0cfe ("crypto: akcipher - Drop > sign/verify operations"). > > The commit renamed a paragraph title in a header file, but neglected to > amend the title reference in the API documentation. Fix it. > > Fixes: 6b34562f0cfe ("crypto: akcipher - Drop sign/verify operations") > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Closes: https://lore.kernel.org/all/20241008172926.0b995ea7@canb.auug.org.au/ > Signed-off-by: Lukas Wunner <lukas@wunner.de> > --- > Documentation/crypto/api-akcipher.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) Patch applied. Thanks.
diff --git a/Documentation/crypto/api-akcipher.rst b/Documentation/crypto/api-akcipher.rst index 6f47cc70eca0..ca1ecdd4a7d3 100644 --- a/Documentation/crypto/api-akcipher.rst +++ b/Documentation/crypto/api-akcipher.rst @@ -8,7 +8,7 @@ Asymmetric Cipher API --------------------- .. kernel-doc:: include/crypto/akcipher.h - :doc: Generic Public Key API + :doc: Generic Public Key Cipher 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
Stephen reports a documentation build warning for "make htmldocs" introduced by recent commit 6b34562f0cfe ("crypto: akcipher - Drop sign/verify operations"). The commit renamed a paragraph title in a header file, but neglected to amend the title reference in the API documentation. Fix it. Fixes: 6b34562f0cfe ("crypto: akcipher - Drop sign/verify operations") Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Closes: https://lore.kernel.org/all/20241008172926.0b995ea7@canb.auug.org.au/ Signed-off-by: Lukas Wunner <lukas@wunner.de> --- Documentation/crypto/api-akcipher.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)