From d84ebdc7f8916ca4641631a26eca668fb1a2d8e9 Mon Sep 17 00:00:00 2001
From: Patrick McDermott <patrick.mcdermott@libiquity.com>
Date: Tue, 18 Apr 2023 14:09:59 -0400
Subject: ustar: Document arguments that may be NULL

---
(limited to 'src/ustar.h')

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.
--
cgit v0.9.1