]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
crypto: acomp - repair kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Wed, 25 Feb 2026 01:45:00 +0000 (17:45 -0800)
committerHerbert Xu <herbert@gondor.apana.org.au>
Sat, 7 Mar 2026 05:12:20 +0000 (14:12 +0900)
Correct kernel-doc:
- add the @extra function parameter
- add "_extra" to the mismatched function name
- spell the "cmpl" parameter correctly

to avoid these warnings:

Warning: include/crypto/acompress.h:251 function parameter 'extra' not
 described in 'acomp_request_alloc_extra'
Warning: include/crypto/acompress.h:251 expecting prototype for
 acomp_request_alloc(). Prototype was for acomp_request_alloc_extra()
 instead
Warning: include/crypto/acompress.h:327 function parameter 'cmpl' not
 described in 'acomp_request_set_callback'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
include/crypto/acompress.h

index 9eacb9fa375d75a8c1ef62c63d7ae9b40c76a033..5d5358dfab73458fc4bc345fe00650e938fe36c6 100644 (file)
@@ -240,9 +240,10 @@ static inline const char *crypto_acomp_driver_name(struct crypto_acomp *tfm)
 }
 
 /**
- * acomp_request_alloc() -- allocates asynchronous (de)compression request
+ * acomp_request_alloc_extra() -- allocates asynchronous (de)compression request
  *
  * @tfm:       ACOMPRESS tfm handle allocated with crypto_alloc_acomp()
+ * @extra:     amount of extra memory
  * @gfp:       gfp to pass to kzalloc (defaults to GFP_KERNEL)
  *
  * Return:     allocated handle in case of success or NULL in case of an error
@@ -318,7 +319,7 @@ static inline void acomp_request_free(struct acomp_req *req)
  *
  * @req:       request that the callback will be set for
  * @flgs:      specify for instance if the operation may backlog
- * @cmlp:      callback which will be called
+ * @cmpl:      callback which will be called
  * @data:      private data used by the caller
  */
 static inline void acomp_request_set_callback(struct acomp_req *req,