From: Stephan Mueller <smueller@chronox.de>
To: herbert@gondor.apana.org.au
Cc: linux-crypto@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH v2 0/8] Conversion crypto API documentation to Sphinx
Date: Fri, 21 Oct 2016 04:53:45 +0200 [thread overview]
Message-ID: <2053893.WjF01BJSDF@positron.chronox.de> (raw)
Hi,
the attached patch set converts the existing crypto API documentation
from DocBook to Sphinx.
The first two patch sets perform the conversion without changes to the
content of the documentation. Starting with patch 3, fixes and
enhancements are applied.
A full review of the new kernel crypto API documentation is found
at [1].
[1] http://www.chronox.de/crypto-API/index.html
Changes v2:
* Mark bullet list for AEAD memory structure appropriately header file
* Mark inline function appropriately
* add patch to optimize compilation of documentation
Stephan Mueller (8):
crypto: doc - convert crypto API documentation to Sphinx
crypto: doc - remove crypto API DocBook
crypto: doc - fix source comments for Sphinx
crypto: doc - fix separation of cipher / req API
crypto: doc - add KPP documentation
crypto: doc - remove crypto_alloc_ablkcipher
crypto: doc - clarify AEAD memory structure
crypto: doc - optimize compilation
Documentation/DocBook/Makefile | 2 +-
Documentation/DocBook/crypto-API.tmpl | 2092 ---------------------------------
Documentation/crypto/api-aead.rst | 23 +
Documentation/crypto/api-akcipher.rst | 20 +
Documentation/crypto/api-digest.rst | 35 +
Documentation/crypto/api-kpp.rst | 38 +
Documentation/crypto/api-rng.rst | 14 +
Documentation/crypto/api-samples.rst | 224 ++++
Documentation/crypto/api-skcipher.rst | 62 +
Documentation/crypto/api.rst | 25 +
Documentation/crypto/architecture.rst | 441 +++++++
Documentation/crypto/devel-algos.rst | 247 ++++
Documentation/crypto/index.rst | 24 +
Documentation/crypto/intro.rst | 74 ++
Documentation/crypto/userspace-if.rst | 387 ++++++
Documentation/index.rst | 1 +
crypto/algif_aead.c | 14 +-
include/crypto/aead.h | 50 +-
include/crypto/dh.h | 58 +
include/crypto/ecdh.h | 58 +
include/crypto/hash.h | 2 +-
include/crypto/kpp.h | 15 +-
include/crypto/skcipher.h | 4 +-
include/linux/crypto.h | 4 +-
24 files changed, 1770 insertions(+), 2144 deletions(-)
delete mode 100644 Documentation/DocBook/crypto-API.tmpl
create mode 100644 Documentation/crypto/api-aead.rst
create mode 100644 Documentation/crypto/api-akcipher.rst
create mode 100644 Documentation/crypto/api-digest.rst
create mode 100644 Documentation/crypto/api-kpp.rst
create mode 100644 Documentation/crypto/api-rng.rst
create mode 100644 Documentation/crypto/api-samples.rst
create mode 100644 Documentation/crypto/api-skcipher.rst
create mode 100644 Documentation/crypto/api.rst
create mode 100644 Documentation/crypto/architecture.rst
create mode 100644 Documentation/crypto/devel-algos.rst
create mode 100644 Documentation/crypto/index.rst
create mode 100644 Documentation/crypto/intro.rst
create mode 100644 Documentation/crypto/userspace-if.rst
--
2.7.4
next reply other threads:[~2016-10-21 2:53 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-21 2:53 Stephan Mueller [this message]
2016-10-21 2:54 ` [PATCH v2 1/8] crypto: doc - convert crypto API documentation to Sphinx Stephan Mueller
2016-10-21 2:57 ` [PATCH v2 2/8] crypto: doc - remove crypto API DocBook Stephan Mueller
2016-10-21 2:57 ` [PATCH v2 3/8] crypto: doc - fix source comments for Sphinx Stephan Mueller
2016-10-21 2:57 ` [PATCH v2 4/8] crypto: doc - fix separation of cipher / req API Stephan Mueller
2016-10-21 2:58 ` [PATCH v2 5/8] crypto: doc - add KPP documentation Stephan Mueller
2016-10-21 2:58 ` [PATCH v2 6/8] crypto: doc - remove crypto_alloc_ablkcipher Stephan Mueller
2016-10-21 2:59 ` [PATCH v2 7/8] crypto: doc - clarify AEAD memory structure Stephan Mueller
2016-10-21 3:00 ` [PATCH v2 8/8] crypto: doc - optimize compilation Stephan Mueller
2016-10-23 16:32 ` [PATCH v2 0/8] Conversion crypto API documentation to Sphinx Jonathan Corbet
2016-10-23 16:46 ` Stephan Mueller
2016-10-25 2:35 ` Herbert Xu
2016-12-13 21:25 ` Stephan Müller
2016-12-13 21:50 ` Jonathan Corbet
2016-12-13 22:06 ` Stephan Müller
2016-12-13 23:40 ` Jonathan Corbet
2016-12-14 7:01 ` Stephan Müller
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=2053893.WjF01BJSDF@positron.chronox.de \
--to=smueller@chronox.de \
--cc=herbert@gondor.apana.org.au \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
/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).