|
|
Log in / Subscribe / Register

lib/crypto/

lib/crypto/

Posted Apr 16, 2026 16:13 UTC (Thu) by ebiggers (subscriber, #130760)
Parent article: The first half of the 7.1 merge window

> The ... meticulously undocumented libcrypto library

This characterization seems a bit unfair, considering that all the new functions have kerneldoc. Perhaps you were looking for a libcrypto.rst file? We'll add that at some point, but there's actually not much information that could go there. That's kind of the point. These are just library functions that implement each of the algorithms for internal use by the kernel, and using standard conventions (e.g. KUnit). So unlike the traditional crypto API where's a complex architecture that developers have to understand, with the library functions there's not a whole lot to add on top of the kerneldoc itself.

Or maybe this is as simple as the kerneldoc not having corresponding `.. kernel-doc::` directives in Documentation/ to make it appear in the HTML documentation, which made it get overlooked?


to post comments

lib/crypto/

Posted Apr 17, 2026 7:02 UTC (Fri) by ebiggers (subscriber, #130760) [Link]

lib/crypto/

Posted Apr 17, 2026 13:27 UTC (Fri) by koverstreet (✭ supporter ✭, #4296) [Link] (2 responses)

Of all the places in the kernel to complain about lack of documentation, lib/crypto does seem like an odd one :)

lib/crypto/

Posted Apr 17, 2026 14:41 UTC (Fri) by corbet (editor, #1) [Link] (1 responses)

Trust me, I complain about the lack of documentation in many places...

lib/crypto/

Posted Apr 17, 2026 22:05 UTC (Fri) by Slumberthud (subscriber, #45657) [Link]

Indeed you do, and I suspect it was you who coined the term "rigorously undocumented" :)


Copyright © 2026, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds