| Message ID | 20150823135101.270c6630@xps.lwn.net (mailing list archive) |
|---|---|
| State | Changes Requested |
| Delegated to: | Herbert Xu |
| Headers | show |
Am Sonntag, 23. August 2015, 13:51:01 schrieb Jonathan Corbet: Hi Jonathan, >Fix up a missing field description and a misdirected doc inclusion to make >a couple of warnings go away. > >Signed-off-by: Jonathan Corbet <corbet@lwn.net> >--- > Documentation/DocBook/crypto-API.tmpl | 2 +- > include/crypto/aead.h | 1 + > 2 files changed, 2 insertions(+), 1 deletion(-) > >diff --git a/Documentation/DocBook/crypto-API.tmpl >b/Documentation/DocBook/crypto-API.tmpl index 0992531ffefb..980bcc994913 >100644 >--- a/Documentation/DocBook/crypto-API.tmpl >+++ b/Documentation/DocBook/crypto-API.tmpl >@@ -1687,7 +1687,7 @@ read(opfd, out, outlen); > !Pinclude/linux/crypto.h Block Cipher Algorithm Definitions > !Finclude/linux/crypto.h crypto_alg > !Finclude/linux/crypto.h ablkcipher_alg >-!Finclude/linux/crypto.h aead_alg >+!Finclude/crypto/aead.h aead_alg This one is already in the cryptodev-2.6 kernel. From now on, I will always CC the linux-doc mailing list on patches pertaining the crypto documentation so that you can see the patches too. > !Finclude/linux/crypto.h blkcipher_alg > !Finclude/linux/crypto.h cipher_alg > !Finclude/crypto/rng.h rng_alg >diff --git a/include/crypto/aead.h b/include/crypto/aead.h >index 7169ad04acc0..88c6cdf3a886 100644 >--- a/include/crypto/aead.h >+++ b/include/crypto/aead.h >@@ -120,6 +120,7 @@ struct aead_givcrypt_request { > * @exit: Deinitialize the cryptographic transformation object. This is a > * counterpart to @init, used to remove various changes set in > * @init. >+ * @base: Common crypto API algorithm data structure I am wondering: does this really fix the issue? I tried it and it failed (i.e. still produced errors by the parser) due to the exotic definition in of this variable in the C code. > * > * All fields except @ivsize is mandatory and must be filled. > */ 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, 24 Aug 2015 06:51:35 +0200 Stephan Mueller <smueller@chronox.de> wrote: > This one is already in the cryptodev-2.6 kernel. > > From now on, I will always CC the linux-doc mailing list on patches pertaining > the crypto documentation so that you can see the patches too. Ah, OK, I should have peeked at linux-next first. > >+ * @base: Common crypto API algorithm data structure > > I am wondering: does this really fix the issue? I tried it and it failed (i.e. > still produced errors by the parser) due to the exotic definition in of this > variable in the C code. It fixes part of the issue. The other required a change to kernel-doc, which I've posted separately to linux-doc and plan to put in for 4.3. Thanks, jon -- 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
Am Montag, 24. August 2015, 02:03:42 schrieb Jonathan Corbet: Hi Jonathan, > >> >+ * @base: Common crypto API algorithm data structure >> >> I am wondering: does this really fix the issue? I tried it and it failed >> (i.e. still produced errors by the parser) due to the exotic definition in >> of this variable in the C code. > >It fixes part of the issue. The other required a change to kernel-doc, >which I've posted separately to linux-doc and plan to put in for 4.3. Thank you. Does that change also fixes the bug report for include/crypto/hash.h? Warning(include/crypto/hash.h:188): No description found for parameter 'hash_alg_common))))' For the updated documentation: Acked-by: Stephan Mueller <smueller@chronox.de> 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
diff --git a/Documentation/DocBook/crypto-API.tmpl b/Documentation/DocBook/crypto-API.tmpl index 0992531ffefb..980bcc994913 100644 --- a/Documentation/DocBook/crypto-API.tmpl +++ b/Documentation/DocBook/crypto-API.tmpl @@ -1687,7 +1687,7 @@ read(opfd, out, outlen); !Pinclude/linux/crypto.h Block Cipher Algorithm Definitions !Finclude/linux/crypto.h crypto_alg !Finclude/linux/crypto.h ablkcipher_alg -!Finclude/linux/crypto.h aead_alg +!Finclude/crypto/aead.h aead_alg !Finclude/linux/crypto.h blkcipher_alg !Finclude/linux/crypto.h cipher_alg !Finclude/crypto/rng.h rng_alg diff --git a/include/crypto/aead.h b/include/crypto/aead.h index 7169ad04acc0..88c6cdf3a886 100644 --- a/include/crypto/aead.h +++ b/include/crypto/aead.h @@ -120,6 +120,7 @@ struct aead_givcrypt_request { * @exit: Deinitialize the cryptographic transformation object. This is a * counterpart to @init, used to remove various changes set in * @init. + * @base: Common crypto API algorithm data structure * * All fields except @ivsize is mandatory and must be filled. */
Fix up a missing field description and a misdirected doc inclusion to make a couple of warnings go away. Signed-off-by: Jonathan Corbet <corbet@lwn.net> --- Documentation/DocBook/crypto-API.tmpl | 2 +- include/crypto/aead.h | 1 + 2 files changed, 2 insertions(+), 1 deletion(-)