Re: [PATCH 0/2] Improve the crypto library documentation

[Jonathan Corbet <corbet@lwn.net>]

Eric Biggers <ebiggers@kernel.org> writes:

> While the crypto library already has a lot of kerneldoc, it's not being
> included in the HTML or PDF documentation.  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.
>
> 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            | 167 ++++++++++++++++++
>  Documentation/crypto/sha3.rst                 |   2 +
>  tools/lib/python/kdoc/kdoc_parser.py          |   5 +
>  8 files changed, 297 insertions(+), 1 deletion(-)

I think this is great - sorry about the snide comment on LWN, but this
will make this documentation much more accessible.

Thanks,

jon