summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2024-09-20 09:24:27 +0200
committerTom Rini <trini@konsulko.com>2024-10-03 11:52:16 -0600
commit13f5535bdb74e729bb1acfc081a8897240e944e1 (patch)
tree71c26d0a29659d43a15a1165fa10220ebd5e8902
parent71b1ae4db1bb272b495a4f715b34d443d7b84510 (diff)
gzip: Correct function comment for gunzip()
This doesn't describe the length parameter correctly. Fix it and zunzip() too. Signed-off-by: Simon Glass <sjg@chromium.org>
-rw-r--r--include/gzip.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/include/gzip.h b/include/gzip.h
index 5e0d0ec07fb..304002ffc42 100644
--- a/include/gzip.h
+++ b/include/gzip.h
@@ -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