aboutsummaryrefslogtreecommitdiffstats
path: root/src/archive_api.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/archive_api.h')
-rw-r--r--src/archive_api.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/archive_api.h b/src/archive_api.h
index dbd050bfa..2efcc1e6a 100644
--- a/src/archive_api.h
+++ b/src/archive_api.h
@@ -73,6 +73,9 @@ struct archive_plugin {
/**
* Opens an input_stream of a file within the archive.
*
+ * If this function succeeds, then the #input_stream "owns"
+ * the archive file and will automatically close it.
+ *
* @param path the path within the archive
*/
bool (*open_stream)(struct archive_file *, struct input_stream *is,