]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
gzip: Correct function comment for gunzip()
authorSimon Glass <sjg@chromium.org>
Fri, 20 Sep 2024 07:24:27 +0000 (09:24 +0200)
committerTom Rini <trini@konsulko.com>
Thu, 3 Oct 2024 17:52:16 +0000 (11:52 -0600)
This doesn't describe the length parameter correctly. Fix it and
zunzip() too.

Signed-off-by: Simon Glass <sjg@chromium.org>
include/gzip.h

index 5e0d0ec07fbccb7a14862efea44495e57619a7d0..304002ffc42b6ae48d31b4d046045429c6bc2bc8 100644 (file)
@@ -28,7 +28,8 @@ int gzip_parse_header(const unsigned char *src, unsigned long len);
  * @dst: Destination for uncompressed data
  * @dstlen: Size of destination buffer
  * @src: Source data to decompress
- * @lenp: Returns length of uncompressed data
+ * @lenp: On entry, length of data at @src. On exit, number of bytes used from
+ * @src
  * Return: 0 if OK, -1 on error
  */
 int gunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp);
@@ -39,7 +40,8 @@ int gunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp);
  * @dst: Destination for uncompressed data
  * @dstlen: Size of destination buffer
  * @src: Source data to decompress
- * @lenp: On entry, length data at @src. On exit, number of bytes used from @src
+ * @lenp: On entry, length of data at @src. On exit, number of bytes used from
+ * @src
  * @stoponerr: 0 to continue when a decode error is found, 1 to stop
  * @offset: start offset within the src buffer
  * Return: 0 if OK, -1 on error