summaryrefslogtreecommitdiffstats
path: root/src/ustar.h
diff options
context:
space:
mode:
authorPatrick McDermott <patrick.mcdermott@libiquity.com>2023-04-18 14:09:59 (EDT)
committer Patrick McDermott <patrick.mcdermott@libiquity.com>2023-04-18 14:09:59 (EDT)
commitd84ebdc7f8916ca4641631a26eca668fb1a2d8e9 (patch)
tree21abfc987424787bd20178d4ceadba4d88c781d1 /src/ustar.h
parentffb1b7f786b541234e7fcd6969e74f8cafd75344 (diff)
ustar: Document arguments that may be NULL
Diffstat (limited to 'src/ustar.h')
-rw-r--r--src/ustar.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/ustar.h b/src/ustar.h
index eeca53a..47f3efa 100644
--- a/src/ustar.h
+++ b/src/ustar.h
@@ -85,8 +85,9 @@ opkg_opk_ustar_seek(struct opkg_opk_ustar *ustar, int num_keys, ...);
* Reads up to a record (512 octets) of member file data at a time.
* Parameters:
* - ustar: Archive structure.
- * - buffer: Address in which to store address of data buffer. Do not free.
- * - size: Address in which to store size of read data.
+ * - buffer: Address in which to store address of data buffer. May be NULL. Do
+ * not free.
+ * - size: Address in which to store size of read data. May be NULL.
* Returns:
* - OPKG_OPK_OK if data was read.
* - OPKG_OPK_END if no more data exists.