From: Joerg Sonnenberger <joerg.sonnenberger@gmail.com>
Date: Mon, 22 Feb 2010 01:14:20 +0000 (-0500)
Subject: Mention difference between _set and _copy.
X-Git-Tag: v3.0.0a~1213
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=3cf2e0c40c21182fb016c34bb4e283adc64ef1b8;p=thirdparty%2Flibarchive.git

Mention difference between _set and _copy.

SVN-Revision: 1950
---

diff --git a/libarchive/archive_entry_paths.3 b/libarchive/archive_entry_paths.3
index a2f8af270..50114caba 100644
--- a/libarchive/archive_entry_paths.3
+++ b/libarchive/archive_entry_paths.3
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd February 21, 2010
+.Dd February 22, 2010
 .Dt archive_entry_paths 3
 .Os
 .Sh NAME
@@ -142,6 +142,20 @@ For that reason, it is only available as multibyte string.
 The link path is a convience function for conditionally setting
 hardlink or symlink destination.
 It doesn't have a corresponding get accessor function.
+.Pp
+The
+.Fn archive_entry_set_XXX
+functions store a reference to the given string internally.
+They require the caller to keep the string valid until the string
+is cleared either by setting it to a different location, by calling
+the corresponding copy function or by calling
+.Xr archive_entry_clear 3
+or
+.Xr archive_entry_free 3 .
+The
+.Fn archive_entry_copy_XXX
+functions do not have this restriction as they keep an internal
+copy of the argument.
 .Sh SEE ALSO
 .Xr archive 3 ,
 .Xr archive_entry 3