Skip to contentSkip to conversation

lib/crypto: docs: Improve introduction sentence

PATCH Applied Eric Biggers 2 participants 3 messages Jul 9 – Jul 13

Subsystems (3)
lore
Share & tools
lore

Eric Biggers

author maintainer
#0 lore raw

PATCH 1/1 lib/crypto: docs: Improve introduction sentence

Make it clear that lib/crypto/ is a kernel-internal library. It's easy for people to come across this page, especially the HTML version online, without that context.

---
 Documentation/crypto/libcrypto.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/crypto/libcrypto.rst +3 -2
index a1557d45b0e5..0733e603d229 100644
@@ -4,8 +4,9 @@
 Crypto library
 ==============
 
-``lib/crypto/`` provides faster and easier access to cryptographic algorithms
-than the traditional crypto API.
+The Linux kernel's crypto library (``lib/crypto/``) provides kernel-internal
+users of cryptographic algorithms with faster and easier access to those
+algorithms than the traditional kernel crypto API.
 
 Each cryptographic algorithm is supported via a set of dedicated functions.
 "Crypto agility", where needed, is left to calling code.

base-commit: 8cdeaa50eae8dad34885515f62559ee83e7e8dda

Signature · 1 line
2.55.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 14 lines · Eric Biggers

Make it clear that lib/crypto/ is a kernel-internal library. It's easy for people to come across this page, especially the HTML version online, without that context.

---
  Documentation/crypto/libcrypto.rst | 5 +++--
  1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/crypto/libcrypto.rst +0 -0
index a1557d45b0e5..0733e603d229 100644

Documentation/crypto/libcrypto.rst line 9

Quoted 8 lines
Documentation/crypto/libcrypto.rst +3 -2
@@ -4,8 +4,9 @@
  Crypto library
  ==============
 
-``lib/crypto/`` provides faster and easier access to cryptographic algorithms
-than the traditional crypto API.
+The Linux kernel's crypto library (``lib/crypto/``) provides kernel-internal
+users of cryptographic algorithms with faster and easier access to those
+algorithms than the traditional kernel crypto API.
author maintainer Applied
#2 lore raw
In reply to Eric Biggers
Quoted 8 lines · Eric Biggers

Make it clear that lib/crypto/ is a kernel-internal library. It's easy for people to come across this page, especially the HTML version online, without that context.

---
 Documentation/crypto/libcrypto.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Applied to https://git.kernel.org/pub/scm/linux/kernel/git/ebiggers/linux.git/log/?h=libcrypto-fixes

- Eric