summaryrefslogtreecommitdiff
path: root/libarchive/archive_read.3
diff options
context:
space:
mode:
authorTim Kientzle <kientzle@gmail.com>2011-03-20 21:25:11 -0400
committerTim Kientzle <kientzle@gmail.com>2011-03-20 21:25:11 -0400
commit8a57f8012b09818495dfee75d402e89001839816 (patch)
tree9ce3a1661da957943b93b5ee188c5b2a040ab674 /libarchive/archive_read.3
parent4f2fd08025e5d2a57f32c757bc3688d3fe7ba874 (diff)
downloadlibarchive-8a57f8012b09818495dfee75d402e89001839816.tar.gz
Update the documentation for archive_read_data_skip to
indicate that it's called automatically. SVN-Revision: 3041
Diffstat (limited to 'libarchive/archive_read.3')
-rw-r--r--libarchive/archive_read.33
1 files changed, 3 insertions, 0 deletions
diff --git a/libarchive/archive_read.3 b/libarchive/archive_read.3
index cd72449c..b7b3f296 100644
--- a/libarchive/archive_read.3
+++ b/libarchive/archive_read.3
@@ -350,6 +350,9 @@ and internal buffer optimizations.
A convenience function that repeatedly calls
.Fn archive_read_data_block
to skip all of the data for this archive entry.
+Note that this function is invoked automatically by
+.Fn archive_read_next_header2
+if the previous entry was not completely consumed.
.\" #if ARCHIVE_API_VERSION < 3
.It Fn archive_read_data_into_buffer
This function is deprecated and will be removed.