lib/crypto: docs: Improve introduction sentence
Subsystems (3)
Eric Biggers
maintainerPATCH 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
@@ -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
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.Signed-off-by Eric Biggers <[email protected]>--- Documentation/crypto/libcrypto.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)Documentation/crypto/libcrypto.rst +0
-0
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.
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.Signed-off-by Eric Biggers <[email protected]>--- 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