Skip to content

Improve the crypto library documentation

Eric Biggers linux-crypto linux-doc lkml 2 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest2 patches 2 repliesIn review
  2. v12 patches 3 repliesSuperseded

Changes in v2 from the cover letter

- Use simple string replacement instead of regex in kdoc_parser.py
- Minor editorial revisions

Patches in v2 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/2docs: kdoc: Expand 'at_least' when creating parameter listtools/lib/python/kdoc/kdoc_parser.py+5 -01 reply
2/2lib/crypto: docs: Add rst documentation to Documentation/crypto/Documentation/crypto/index.rst Documentation/crypto/libcrypto-blockcipher.rst Documentation/crypto/libcrypto-hash.rst +4 more+290 -11 reply

Reviews trailers per patch

All 2 patches have a Reviewed-by or Acked-by.

PatchJonathan CorbetArd BiesheuvelRandy Dunlap
1/2A-b R-b A-b T-b
2/2R-b T-b R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 3 reviewers.

Read the v2 thread

Cover letter [PATCH v2 0/2] Improve the crypto library documentation

While the crypto library already has a lot of kernel-doc, it's not being included in the HTML or PDF documentation (except for the SHA-3 kernenl-doc which is already included). Update Documentation/crypto/ to include it, and also add a high-level overview of the library.

I'd like to take this series via the libcrypto tree for 7.1.

Changed in v2:
- Use simple string replacement instead of regex in kdoc_parser.py
- Minor editorial revisions

Eric Biggers (2):
docs: kdoc: Expand 'at_least' when creating parameter list lib/crypto: docs: Add rst documentation to Documentation/crypto/

 Documentation/crypto/index.rst                |   2 +-
 .../crypto/libcrypto-blockcipher.rst          |  19 ++
 Documentation/crypto/libcrypto-hash.rst       |  86 +++++++++
 Documentation/crypto/libcrypto-signature.rst  |  11 ++
 Documentation/crypto/libcrypto-utils.rst      |   6 +
 Documentation/crypto/libcrypto.rst            | 165 ++++++++++++++++++
 Documentation/crypto/sha3.rst                 |   2 +
 tools/lib/python/kdoc/kdoc_parser.py          |   5 +
 8 files changed, 295 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/crypto/libcrypto-blockcipher.rst
 create mode 100644 Documentation/crypto/libcrypto-hash.rst
 create mode 100644 Documentation/crypto/libcrypto-signature.rst
 create mode 100644 Documentation/crypto/libcrypto-utils.rst
 create mode 100644 Documentation/crypto/libcrypto.rst

base-commit: 8541d8f725c673db3bd741947f27974358b2e163

Signature · 1 line
2.53.0