Restore basic documentation for archive_read_finish

and archive_write_finish so that developers who need
to support libarchive 2.x won't be too confused
by the name change.

SVN-Revision: 2966

diff --git a/libarchive/archive_read.3 b/libarchive/archive_read.3
index 3293c21a53857275f8fe4fa29742c36960bcd26b..56eaeb9e65eeeca68ec359fec4b43e3436c21881 100644 (file)
--- a/libarchive/archive_read.3
+++ b/libarchive/archive_read.3
@@ -69,6 +69,7 @@
 .Nm archive_read_extract2 ,
 .Nm archive_read_extract_set_progress_callback ,
 .Nm archive_read_close ,
+.Nm archive_read_finish ,
 .Nm archive_read_free
 .Nd functions for reading streaming archives
 .Sh SYNOPSIS
@@ -196,6 +197,8 @@
 .Ft int
 .Fn archive_read_close "struct archive *"
 .Ft int
+.Fn archive_read_finish "struct archive *"
+.Ft int
 .Fn archive_read_free "struct archive *"
 .Sh DESCRIPTION
 These functions provide a complete API for reading streaming archives.
@@ -457,6 +460,9 @@ object and the archive_entry object so that various statistics
 can be retrieved for the progress display.
 .It Fn archive_read_close
 Complete the archive and invoke the close callback.
+.It Fn archive_read_finish
+This is a deprecated synonym for
+.Fn archive_read_free .
 .It Fn archive_read_free
 Invokes
 .Fn archive_read_close

diff --git a/libarchive/archive_read_disk.3 b/libarchive/archive_read_disk.3
index 7ea2a0a7783dd5e2019cf70b8c3060e7f74ea2c0..2c9c4e53d69b615cee3ab53646c66ced5a7e31a9 100644 (file)
--- a/libarchive/archive_read_disk.3
+++ b/libarchive/archive_read_disk.3
@@ -39,6 +39,7 @@
 .Nm archive_read_disk_set_gname_lookup ,
 .Nm archive_read_disk_set_standard_lookup ,
 .Nm archive_read_close ,
+.Nm archive_read_finish ,
 .Nm archive_read_free
 .Nd functions for reading objects from disk
 .Sh SYNOPSIS
@@ -81,6 +82,8 @@
 .Ft int
 .Fn archive_read_close "struct archive *"
 .Ft int
+.Fn archive_read_finish "struct archive *"
+.Ft int
 .Fn archive_read_free "struct archive *"
 .Sh DESCRIPTION
 These functions provide an API for reading information about
@@ -177,10 +180,15 @@ This affects the file ownership fields and ACL values in the
 .Tn struct archive_entry
 object.
 .It Fn archive_read_close
-This currently does nothing.
-.It Fn archive_write_free
+Does nothing for
+.Tn archive_read_disk
+handles.
+.It Fn archive_read_finish
+This is a deprecated synonym for
+.Fn archive_read_free .
+.It Fn archive_read_free
 Invokes
-.Fn archive_write_close
+.Fn archive_read_close
 if it was not invoked manually, then releases all resources.
 .El
 More information about the

diff --git a/libarchive/archive_write.3 b/libarchive/archive_write.3
index 4e0141b16cc87f3974fbad0b3396289affc1b785..245ddb92f17a6cab08ccac1cc3f49c5c436190ef 100644 (file)
--- a/libarchive/archive_write.3
+++ b/libarchive/archive_write.3
@@ -52,6 +52,7 @@
 .Nm archive_write_data ,
 .Nm archive_write_finish_entry ,
 .Nm archive_write_close ,
+.Nm archive_write_finish ,
 .Nm archive_write_free
 .Nd functions for creating archives
 .Sh SYNOPSIS
@@ -116,6 +117,8 @@
 .Ft int
 .Fn archive_write_close "struct archive *"
 .Ft int
+.Fn archive_write_finish "struct archive *"
+.Ft int
 .Fn archive_write_free "struct archive *"
 .Sh DESCRIPTION
 These functions provide a complete API for creating streaming
@@ -292,6 +295,9 @@ and
 as needed.
 .It Fn archive_write_close
 Complete the archive and invoke the close callback.
+.It Fn archive_write_finish
+This is a deprecated synonym for
+.Fn archive_write_free .
 .It Fn archive_write_free
 Invokes
 .Fn archive_write_close
@@ -510,6 +516,7 @@ may include
 .Fn archive_write_header ,
 .Fn archive_write_data ,
 .Fn archive_write_close ,
+.Fn archive_write_finish ,
 or
 .Fn archive_write_free .
 The client callback can call

diff --git a/libarchive/archive_write_disk.3 b/libarchive/archive_write_disk.3
index 971a3d3b8d2a2f69fce2db431703c4a98f58126f..e9f8131947ba567758b74c80ea42d6e2a1187d00 100644 (file)
--- a/libarchive/archive_write_disk.3
+++ b/libarchive/archive_write_disk.3
@@ -38,6 +38,7 @@
 .Nm archive_write_data ,
 .Nm archive_write_finish_entry ,
 .Nm archive_write_close ,
+.Nm archive_write_finish
 .Nm archive_write_free
 .Nd functions for creating objects on disk
 .Sh SYNOPSIS
@@ -73,6 +74,8 @@
 .Ft int
 .Fn archive_write_close "struct archive *"
 .Ft int
+.Fn archive_write_finish "struct archive *"
+.Ft int
 .Fn archive_write_free "struct archive *"
 .Sh DESCRIPTION
 These functions provide a complete API for creating objects on
@@ -242,6 +245,9 @@ The
 .Nm
 library maintains a list of all such deferred attributes and
 sets them when this function is invoked.
+.It Fn archive_write_finish
+This is a deprecated synonym for
+.Fn archive_write_free .
 .It Fn archive_write_free
 Invokes
 .Fn archive_write_close

diff --git a/libarchive/libarchive.3 b/libarchive/libarchive.3
index c292d386ff825c9204007b8d59d41327a7d4af20..c797d3c28a3051b9b598f9e319e12871c0b48779 100644 (file)
--- a/libarchive/libarchive.3
+++ b/libarchive/libarchive.3
@@ -195,8 +195,13 @@ Once you have finished reading data from the archive, you
 should call
 .Fn archive_read_close
 to close the archive, then call
-.Fn archive_read_free
+.Fn archive_read_finish
 to release all resources, including all memory allocated by the library.
+(Note:
+.Fn archive_read_finish
+is deprecated in Libarchive 3.0; please use
+.Fn archive_read_free
+instead.)
 .Pp
 The
 .Xr archive_read 3
@@ -233,8 +238,13 @@ You can then use
 to write the actual data.
 .Pp
 After all entries have been written, use the
-.Fn archive_write_free
+.Fn archive_write_finish
 function to release all resources.
+(Note:
+.Fn archive_write_finish
+is deprecated in Libarchive 3.0; please use
+.Fn archive_write_free
+instead.)
 .Pp
 The
 .Xr archive_write 3