From: Stephan Mueller <smueller@chronox.de>
To: Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>,
Marek Vasut <marex@denx.de>,
Jason Cooper <cryptography@lakedaemon.net>,
Grant Likely <grant.likely@secretlab.ca>,
Geert Uytterhoeven <geert@linux-m68k.org>,
Linux Kernel Developers List <linux-kernel@vger.kernel.org>,
linux-crypto@vger.kernel.org
Subject: [PATCH v2 00/11] crypto: Documentation of kernel crypto API
Date: Sun, 02 Nov 2014 21:34:22 +0100 [thread overview]
Message-ID: <6375771.bx7QqLJLuR@tachyon.chronox.de> (raw)
Hi,
The following patch set adds documentation files under Documentation/crypto/
covering the high-level description of the API. In addition, it contains
source code comments added to the header files of the kernel crypto API
documenting the API functions.
Changes v2:
* Split out the user space documentation into separate document including
the user space example code
* Change the license of the user space interface code to match the license
of the code that I used as a reference.
* Addition of a precise pointer to the user space interface code reference
code.
* Add a missing memset(0) to the user space example code.
* Move the API function call documentation into the header files in the hope
for a better maintainability.
* Merge the developer-related documentation from Marek Vasut
Stephan Mueller (11):
crypto: Documentation - crypto API high level spec
crypto: Documentation - userspace interface spec
crypto: Documentation - RNG API documentation
crypto: Documentation - AHASH API documentation
crypto: Documentation - SHASH API documentation
crypto: Documentation - documentation of crypto_alg
crypto: Documentation - ABLKCIPHER API documentation
crypto: Documentation - AEAD API documentation
crypto: Documentation - BLKCIPHER API documentation
crypto: Documentation - CIPHER API documentation
crypto: Documentation - HASH API documentation
Documentation/crypto/crypto-API-spec.txt | 721 ++++++++++++++
Documentation/crypto/crypto-API-userspace.txt | 662 +++++++++++++
include/crypto/hash.h | 421 +++++++++
include/crypto/rng.h | 113 +++
include/linux/crypto.h | 1239 ++++++++++++++++++++++++-
5 files changed, 3136 insertions(+), 20 deletions(-)
create mode 100644 Documentation/crypto/crypto-API-spec.txt
create mode 100644 Documentation/crypto/crypto-API-userspace.txt
--
2.1.0
next reply other threads:[~2014-11-02 20:34 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-11-02 20:34 Stephan Mueller [this message]
2014-11-02 20:35 ` [PATCH v2 01/11] crypto: Documentation - crypto API high level spec Stephan Mueller
2014-11-03 13:34 ` Jonathan Corbet
2014-11-03 14:18 ` Stephan Mueller
2014-11-03 14:43 ` Herbert Xu
2014-11-03 14:49 ` Herbert Xu
2014-11-03 15:53 ` Tom Lendacky
2014-11-03 16:44 ` Jonathan Corbet
2014-11-09 2:54 ` Jason Cooper
2014-11-05 22:21 ` Joy M. Latten
2014-11-06 2:15 ` Tadeusz Struk
2014-11-10 1:41 ` Stephan Mueller
2014-11-02 20:36 ` [PATCH v2 02/11] crypto: Documentation - userspace interface spec Stephan Mueller
2014-11-05 23:20 ` Joy M. Latten
2014-11-02 20:36 ` [PATCH v2 03/11] crypto: Documentation - RNG API documentation Stephan Mueller
2014-11-05 23:33 ` Joy M. Latten
2014-11-02 20:37 ` [PATCH v2 04/11] crypto: Documentation - AHASH " Stephan Mueller
2014-11-02 20:38 ` [PATCH v2 05/11] crypto: Documentation - SHASH " Stephan Mueller
2014-11-06 22:43 ` Joy M. Latten
2014-11-02 20:38 ` [PATCH v2 06/11] crypto: Documentation - documentation of crypto_alg Stephan Mueller
2014-11-02 20:39 ` [PATCH v2 07/11] crypto: Documentation - ABLKCIPHER API documentation Stephan Mueller
2014-11-02 20:40 ` [PATCH v2 08/11] crypto: Documentation - AEAD " Stephan Mueller
2014-11-02 20:40 ` [PATCH v2 09/11] crypto: Documentation - BLKCIPHER " Stephan Mueller
2014-11-02 20:41 ` [PATCH v2 10/11] crypto: Documentation - CIPHER " Stephan Mueller
2014-11-02 20:42 ` [PATCH v2 11/11] crypto: Documentation - HASH " Stephan Mueller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6375771.bx7QqLJLuR@tachyon.chronox.de \
--to=smueller@chronox.de \
--cc=cryptography@lakedaemon.net \
--cc=davem@davemloft.net \
--cc=geert@linux-m68k.org \
--cc=grant.likely@secretlab.ca \
--cc=herbert@gondor.apana.org.au \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=marex@denx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).