Skip to content

Commit 8008d6b

Browse files
author
Eric Biggers
committed
lib/crypto: docs: Fix some sentence fragments
Currently, the section about the library API for each algorithm begins with a noun phrase that was intended to serve as an elaboration on the title. It's better to use complete sentences. Suggested-by: Thomas Huth <thuth@redhat.com> Reviewed-by: Thomas Huth <thuth@redhat.com> Link: https://patch.msgid.link/20260709022651.44216-1-ebiggers@kernel.org Signed-off-by: Eric Biggers <ebiggers@kernel.org>
1 parent 1002500 commit 8008d6b

3 files changed

Lines changed: 24 additions & 22 deletions

File tree

‎Documentation/crypto/libcrypto-blockcipher.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Block ciphers
66
AES
77
---
88

9-
Support for the AES block cipher.
9+
This API provides support for the AES block cipher.
1010

1111
.. kernel-doc:: include/crypto/aes.h
1212

1313
DES
1414
---
1515

16-
Support for the DES block cipher. This algorithm is obsolete and is supported
17-
only for backwards compatibility.
16+
This API provides support for the DES block cipher. This algorithm is obsolete
17+
and is supported only for backwards compatibility.
1818

1919
.. kernel-doc:: include/crypto/des.h

‎Documentation/crypto/libcrypto-hash.rst‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,81 +6,83 @@ Hash functions, MACs, and XOFs
66
AES-CMAC and AES-XCBC-MAC
77
-------------------------
88

9-
Support for the AES-CMAC and AES-XCBC-MAC message authentication codes.
9+
This API provides support for the AES-CMAC and AES-XCBC-MAC message
10+
authentication codes.
1011

1112
.. kernel-doc:: include/crypto/aes-cbc-macs.h
1213

1314
BLAKE2b
1415
-------
1516

16-
Support for the BLAKE2b cryptographic hash function.
17+
This API provides support for the BLAKE2b cryptographic hash function.
1718

1819
.. kernel-doc:: include/crypto/blake2b.h
1920

2021
BLAKE2s
2122
-------
2223

23-
Support for the BLAKE2s cryptographic hash function.
24+
This API provides support for the BLAKE2s cryptographic hash function.
2425

2526
.. kernel-doc:: include/crypto/blake2s.h
2627

2728
GHASH and POLYVAL
2829
-----------------
2930

30-
Support for the GHASH and POLYVAL universal hash functions. These algorithms
31-
are used only as internal components of other algorithms.
31+
This API provides support for the GHASH and POLYVAL universal hash functions.
32+
These algorithms are used only as internal components of other algorithms.
3233

3334
.. kernel-doc:: include/crypto/gf128hash.h
3435

3536
MD5
3637
---
3738

38-
Support for the MD5 cryptographic hash function and HMAC-MD5. This algorithm is
39-
obsolete and is supported only for backwards compatibility.
39+
This API provides support for the MD5 cryptographic hash function and HMAC-MD5.
40+
This algorithm is obsolete and is supported only for backwards compatibility.
4041

4142
.. kernel-doc:: include/crypto/md5.h
4243

4344
NH
4445
--
4546

46-
Support for the NH universal hash function. This algorithm is used only as an
47-
internal component of other algorithms.
47+
This API provides support for the NH universal hash function. This algorithm is
48+
used only as an internal component of other algorithms.
4849

4950
.. kernel-doc:: include/crypto/nh.h
5051

5152
Poly1305
5253
--------
5354

54-
Support for the Poly1305 universal hash function. This algorithm is used only
55-
as an internal component of other algorithms.
55+
This API provides support for the Poly1305 universal hash function. This
56+
algorithm is used only as an internal component of other algorithms.
5657

5758
.. kernel-doc:: include/crypto/poly1305.h
5859

5960
SHA-1
6061
-----
6162

62-
Support for the SHA-1 cryptographic hash function and HMAC-SHA1. This algorithm
63-
is obsolete and is supported only for backwards compatibility.
63+
This API provides support for the SHA-1 cryptographic hash function and
64+
HMAC-SHA1. This algorithm is obsolete and is supported only for backwards
65+
compatibility.
6466

6567
.. kernel-doc:: include/crypto/sha1.h
6668

6769
SHA-2
6870
-----
6971

70-
Support for the SHA-2 family of cryptographic hash functions, including SHA-224,
71-
SHA-256, SHA-384, and SHA-512. This also includes their corresponding HMACs:
72-
HMAC-SHA224, HMAC-SHA256, HMAC-SHA384, and HMAC-SHA512.
72+
This API provides support for the SHA-2 family of cryptographic hash functions,
73+
including SHA-224, SHA-256, SHA-384, and SHA-512. This also includes their
74+
corresponding HMACs: HMAC-SHA224, HMAC-SHA256, HMAC-SHA384, and HMAC-SHA512.
7375

7476
.. kernel-doc:: include/crypto/sha2.h
7577

7678
SHA-3
7779
-----
7880

79-
The SHA-3 functions are documented in :ref:`sha3`.
81+
The SHA-3 API is documented in :ref:`sha3`.
8082

8183
SM3
8284
---
8385

84-
Support for the SM3 cryptographic hash function.
86+
This API provides support for the SM3 cryptographic hash function.
8587

8688
.. kernel-doc:: include/crypto/sm3.h

‎Documentation/crypto/libcrypto-signature.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ Digital signature algorithms
66
ML-DSA
77
------
88

9-
Support for the ML-DSA digital signature algorithm.
9+
This API provides support for the ML-DSA digital signature algorithm.
1010

1111
.. kernel-doc:: include/crypto/mldsa.h

0 commit comments

Comments
 (0)