Re: [PATCH v2 0/8] Conversion crypto API documentation to Sphinx

Am Sonntag, 23. Oktober 2016, 10:32:38 CEST schrieb Jonathan Corbet: Hi Jonathan, > On Fri, 21 Oct 2016 04:53:45 +0200 > > Stephan Mueller <smuel...@chronox.de> wrote: > > the attached patch set converts the existing crypto API documentation > > from DocBook to Sphinx

[PATCH v2 5/8] crypto: doc - add KPP documentation

Add the KPP API documentation to the kernel crypto API Sphinx documentation. This addition includes the documentation of the ECDH and DH helpers which are needed to create the approrpiate input data for the crypto_kpp_set_secret function. Signed-off-by: Stephan Mueller <smuel...@chronox

[PATCH v2 1/8] crypto: doc - convert crypto API documentation to Sphinx

With the conversion of the kernel crypto API DocBook to Sphinx, the monolithic document is broken up into individual documents. The documentation is unchanged with the exception of a slight reordering to keep the individual document parts self-contained. Signed-off-by: Stephan Mueller <sm

[PATCH v2 0/8] Conversion crypto API documentation to Sphinx

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

[PATCH v2 8/8] crypto: doc - optimize compilation

The :functions: definition allows the specification of multiple function references which prevents parsing the header file multiple times. Reported-by: Jani Nikula <jani.nik...@linux.intel.com> Signed-off-by: Stephan Mueller <smuel...@chronox.de> --- Documentation/crypto/api-aead.r

[PATCH v2 2/8] crypto: doc - remove crypto API DocBook

With the conversion of the documentation to Sphinx, the old DocBook is now stale. Signed-off-by: Stephan Mueller <smuel...@chronox.de> --- Documentation/DocBook/Makefile|2 +- Documentation/DocBook/crypto-API.tmpl | 2092 - 2 files chan

[PATCH v2 3/8] crypto: doc - fix source comments for Sphinx

Update comments to avoid any complaints from Sphinx during compilation. Signed-off-by: Stephan Mueller <smuel...@chronox.de> --- include/crypto/aead.h | 14 +++--- include/crypto/hash.h | 2 +- include/crypto/skcipher.h | 4 ++-- include/linux/crypto.h| 4 ++-- 4

[PATCH v2 6/8] crypto: doc - remove crypto_alloc_ablkcipher

Remove the documentation reference to crypto_alloc_ablkcipher as the API function call was removed. Signed-off-by: Stephan Mueller <smuel...@chronox.de> --- Documentation/crypto/api-skcipher.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/Documentation/crypto/api-skcipher.

[PATCH v2 7/8] crypto: doc - clarify AEAD memory structure

The previous description have been misleading and partially incorrect. Reported-by: Harsh Jain <harshjain.p...@gmail.com> Signed-off-by: Stephan Mueller <smuel...@chronox.de> --- crypto/algif_aead.c | 14 ++ include/crypto/aead.h | 36 -

Re: [PATCH 4/7] crypto: doc - fix separation of cipher / req API

Am Montag, 17. Oktober 2016, 14:04:14 CEST schrieb Jani Nikula: Hi Jani, > The directive parameter is plural functions for a reason - you can > specify multiple functions in the same directive. Splitting this to > multiple directives causes the header file to be parsed again for each >

Re: [PATCH 7/7] crypto: doc - clarify AEAD memory structure

Am Sonntag, 16. Oktober 2016, 15:11:38 CEST schrieb Markus Heiser: Hi Markus, > These are only my 2cent in hope that helps ... there is no rule > to use any special markup ... use markup as you prefer ;-) Thanks for the pointers. I will release a new patch set following your suggestions after

Re: [PATCH 3/7] crypto: doc - fix source comments for Sphinx

Am Sonntag, 16. Oktober 2016, 14:56:49 CEST schrieb Markus Heiser: Hi Markus, ... > compared to DocBook, with sphinx you can use (have to use) the reST markup > in source code comments. > > Here, the code example is just a (indented) float text and this is > why you have to quote the asterisk

[PATCH 2/7] crypto: doc - remove crypto API DocBook

With the conversion of the documentation to Sphinx, the old DocBook is now stale. Signed-off-by: Stephan Mueller <smuel...@chronox.de> --- Documentation/DocBook/Makefile|2 +- Documentation/DocBook/crypto-API.tmpl | 2092 - 2 files changed, 1 ins

[PATCH 7/7] crypto: doc - clarify AEAD memory structure

The previous description have been misleading and partially incorrect. Reported-by: Harsh Jain <harshjain.p...@gmail.com> Signed-off-by: Stephan Mueller <smuel...@chronox.de> --- crypto/algif_aead.c | 14 ++ include/crypto/aead.h | 35 +++-

[PATCH 3/7] crypto: doc - fix source comments for Sphinx

Update comments to avoid any complaints from Sphinx during compilation. Signed-off-by: Stephan Mueller <smuel...@chronox.de> --- include/crypto/aead.h | 14 +++--- include/crypto/hash.h | 2 +- include/crypto/skcipher.h | 4 ++-- include/linux/crypto.h| 4 ++-- 4

[PATCH 5/7] crypto: doc - add KPP documentation

Add the KPP API documentation to the kernel crypto API Sphinx documentation. This addition includes the documentation of the ECDH and DH helpers which are needed to create the approrpiate input data for the crypto_kpp_set_secret function. Signed-off-by: Stephan Mueller <smuel...@chronox

[PATCH 4/7] crypto: doc - fix separation of cipher / req API

Keep the cipher API and the request API function documentation in separate sections. Signed-off-by: Stephan Mueller <smuel...@chronox.de> --- Documentation/crypto/api-akcipher.rst | 25 + 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/Documentation/

Re: SPHINX: no structured comments

Am Samstag, 15. Oktober 2016, 18:12:36 CEST schrieb Markus Heiser: Hi Markus, > I suppose you have a typo in one of your kernel-doc > directives. E.g.:: > > .. kernel-doc:: include/linux/crypto.h > > :functions: fooTypo > > will produce those error messages: > > $ ./scripts/kernel-doc

SPHINX: no structured comments

Hi, I am converting the kernel crypto API DocBook into Sphinx. The conversion is complete, but I am having difficulties finding the cause for the following notification obtained during the Sphinx compilation: ./include/linux/crypto.h:1: warning: no structured comments found I am unsure what

Re: [PATCH] crypto: Add a flag allowing the self-tests to be disabled at runtime.

Am Freitag, 29. April 2016, 11:07:43 schrieb Richard W.M. Jones: Hi Richard, > Running self-tests for a short-lived KVM VM takes 28ms on my laptop. > This commit adds a flag 'cryptomgr.notests' which allows them to be > disabled. > > Signed-off-by: Richard W.M. Jones > --- >

[PATCH 1/4] Documentation: crypto - add akcipher API

Reference the new akcipher API calls in the kernel crypto API DocBook. Also, fix the comments in the akcipher.h file: double dashes do not look good in the DocBook; fix a typo. Signed-off-by: Stephan Mueller <smuel...@chronox.de> --- Documentation/DocBook/crypto-API.tmp