[cryptodev:master 147/175] DocBook: include/crypto/skcipher.h:135: warning: No description found for parameter 'base'

[cryptodev:master 147/175] DocBook: include/crypto/skcipher.h:135: warning: No description found for parameter 'base'

[kbuild test robot]

[-- Attachment #1: Type: text/plain, Size: 2964 bytes --]

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/herbert/cryptodev-2.6.git master
head:   c6335cbb0486f09b4c2ae86e84bf87efd667afa6
commit: 4e6c3df4d729f85997cbf276bfa8ffd8579b8e77 [147/175] crypto: skcipher - Add low-level skcipher interface
reproduce: make htmldocs

All warnings (new ones prefixed by >>):

>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'
>> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'

vim +/base +135 include/crypto/skcipher.h

   119	 * All fields except @ivsize are mandatory and must be filled.
   120	 */
   121	struct skcipher_alg {
   122		int (*setkey)(struct crypto_skcipher *tfm, const u8 *key,
   123		              unsigned int keylen);
   124		int (*encrypt)(struct skcipher_request *req);
   125		int (*decrypt)(struct skcipher_request *req);
   126		int (*init)(struct crypto_skcipher *tfm);
   127		void (*exit)(struct crypto_skcipher *tfm);
   128	
   129		unsigned int min_keysize;
   130		unsigned int max_keysize;
   131		unsigned int ivsize;
   132		unsigned int chunksize;
   133	
   134		struct crypto_alg base;
 > 135	};
   136	
   137	#define SKCIPHER_REQUEST_ON_STACK(name, tfm) \
   138		char __##name##_desc[sizeof(struct skcipher_request) + \
   139			crypto_skcipher_reqsize(tfm)] CRYPTO_MINALIGN_ATTR; \
   140		struct skcipher_request *name = (void *)__##name##_desc
   141	
   142	static inline struct crypto_ablkcipher *skcipher_givcrypt_reqtfm(
   143		struct skcipher_givcrypt_request *req)

---
0-DAY kernel test infrastructure                Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all                   Intel Corporation

[-- Attachment #2: .config.gz --]
[-- Type: application/octet-stream, Size: 6366 bytes --]

Re: [cryptodev:master 147/175] DocBook: include/crypto/skcipher.h:135: warning: No description found for parameter 'base'

[Herbert Xu]

On Mon, Jul 18, 2016 at 08:25:17PM +0800, kbuild test robot wrote:
> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/herbert/cryptodev-2.6.git master
> head:   c6335cbb0486f09b4c2ae86e84bf87efd667afa6
> commit: 4e6c3df4d729f85997cbf276bfa8ffd8579b8e77 [147/175] crypto: skcipher - Add low-level skcipher interface
> reproduce: make htmldocs
> 
> All warnings (new ones prefixed by >>):
> 
> >> include/crypto/skcipher.h:135: warning: No description found for parameter 'base'

Thanks for the report.

---8<---
Subject: crypto: skcipher - Add comment for skcipher_alg->base

This patch adds a missing comment for the base parameter in struct
skcipher_alg.

Reported-by: kbuild test robot <fengguang.wu@intel.com>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

diff --git a/include/crypto/skcipher.h b/include/crypto/skcipher.h
index 59c8f6c..bb7db84 100644
--- a/include/crypto/skcipher.h
+++ b/include/crypto/skcipher.h
@@ -115,6 +115,7 @@ struct crypto_skcipher {
  *	    IV of exactly that size to perform the encrypt or decrypt operation.
  * @chunksize: Equal to the block size except for stream ciphers such as
  *	       CTR where it is set to the underlying block size.
+ * @base: Definition of a generic crypto algorithm.
  *
  * All fields except @ivsize are mandatory and must be filled.
  */
-- 
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt