| Message ID | 5908263.2TLWr89bHl@positron.chronox.de (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Herbert Xu |
| Headers | show |
On Sun, 16 Oct 2016, Stephan Mueller <smueller@chronox.de> wrote: > Keep the cipher API and the request API function documentation in > separate sections. > > Signed-off-by: Stephan Mueller <smueller@chronox.de> > --- > Documentation/crypto/api-akcipher.rst | 25 +++++++++++++------------ > 1 file changed, 13 insertions(+), 12 deletions(-) > > diff --git a/Documentation/crypto/api-akcipher.rst b/Documentation/crypto/api-akcipher.rst > index 305e616..0d5899f 100644 > --- a/Documentation/crypto/api-akcipher.rst > +++ b/Documentation/crypto/api-akcipher.rst > @@ -25,32 +25,32 @@ Asymmetric Cipher API > .. kernel-doc:: include/crypto/akcipher.h > :functions: crypto_akcipher_set_priv_key > > -Asymmetric Cipher Request Handle > --------------------------------- > - > .. kernel-doc:: include/crypto/akcipher.h > - :functions: akcipher_request_alloc > + :functions: crypto_akcipher_maxsize > > .. kernel-doc:: include/crypto/akcipher.h > - :functions: akcipher_request_free > + :functions: crypto_akcipher_encrypt > > .. kernel-doc:: include/crypto/akcipher.h > - :functions: akcipher_request_set_callback > + :functions: crypto_akcipher_decrypt > > .. kernel-doc:: include/crypto/akcipher.h > - :functions: akcipher_request_set_crypt > + :functions: crypto_akcipher_sign > > .. kernel-doc:: include/crypto/akcipher.h > - :functions: crypto_akcipher_maxsize > + :functions: crypto_akcipher_verify 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 directive. IMO this can be fixed in a follow-up patch. Same for other patches in this series. BR, Jani. > + > +Asymmetric Cipher Request Handle > +-------------------------------- > > .. kernel-doc:: include/crypto/akcipher.h > - :functions: crypto_akcipher_encrypt > + :functions: akcipher_request_alloc > > .. kernel-doc:: include/crypto/akcipher.h > - :functions: crypto_akcipher_decrypt > + :functions: akcipher_request_free > > .. kernel-doc:: include/crypto/akcipher.h > - :functions: crypto_akcipher_sign > + :functions: akcipher_request_set_callback > > .. kernel-doc:: include/crypto/akcipher.h > - :functions: crypto_akcipher_verify > + :functions: akcipher_request_set_crypt
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 > directive. > > IMO this can be fixed in a follow-up patch. Same for other patches in > this series. Thank you very much for the hint. I followed the path what the DocBook to Sphinx converter generated. I will change it in my patchset, but may I suggest that the converter tool (tmplcvt) should be fixed, too? Ciao Stephan -- To unsubscribe from this list: send the line "unsubscribe linux-crypto" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
On Mon, 17 Oct 2016, Stephan Mueller <smueller@chronox.de> wrote: > 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 >> directive. >> >> IMO this can be fixed in a follow-up patch. Same for other patches in >> this series. > > Thank you very much for the hint. I followed the path what the DocBook > to Sphinx converter generated. I will change it in my patchset, but > may I suggest that the converter tool (tmplcvt) should be fixed, too? I don't think it's worth the trouble. Now it's a straightforward docproc directive to Sphinx kernel-doc directive extension conversion, with one-to-one mapping. It would be quite a bit more complicated to gather all of the consecutive directives together, in a rather quickly hacked up tool which we'll throw away once all DocBooks have been converted over. And as I said, I think you can fix this up afterwards too. It's not broken, it's just a bit slower. BR, Jani.
diff --git a/Documentation/crypto/api-akcipher.rst b/Documentation/crypto/api-akcipher.rst index 305e616..0d5899f 100644 --- a/Documentation/crypto/api-akcipher.rst +++ b/Documentation/crypto/api-akcipher.rst @@ -25,32 +25,32 @@ Asymmetric Cipher API .. kernel-doc:: include/crypto/akcipher.h :functions: crypto_akcipher_set_priv_key -Asymmetric Cipher Request Handle --------------------------------- - .. kernel-doc:: include/crypto/akcipher.h - :functions: akcipher_request_alloc + :functions: crypto_akcipher_maxsize .. kernel-doc:: include/crypto/akcipher.h - :functions: akcipher_request_free + :functions: crypto_akcipher_encrypt .. kernel-doc:: include/crypto/akcipher.h - :functions: akcipher_request_set_callback + :functions: crypto_akcipher_decrypt .. kernel-doc:: include/crypto/akcipher.h - :functions: akcipher_request_set_crypt + :functions: crypto_akcipher_sign .. kernel-doc:: include/crypto/akcipher.h - :functions: crypto_akcipher_maxsize + :functions: crypto_akcipher_verify + +Asymmetric Cipher Request Handle +-------------------------------- .. kernel-doc:: include/crypto/akcipher.h - :functions: crypto_akcipher_encrypt + :functions: akcipher_request_alloc .. kernel-doc:: include/crypto/akcipher.h - :functions: crypto_akcipher_decrypt + :functions: akcipher_request_free .. kernel-doc:: include/crypto/akcipher.h - :functions: crypto_akcipher_sign + :functions: akcipher_request_set_callback .. kernel-doc:: include/crypto/akcipher.h - :functions: crypto_akcipher_verify + :functions: akcipher_request_set_crypt
Keep the cipher API and the request API function documentation in separate sections. Signed-off-by: Stephan Mueller <smueller@chronox.de> --- Documentation/crypto/api-akcipher.rst | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-)