From: Tim Kientzle <kientzle@gmail.com>
Date: Wed, 24 Feb 2010 05:27:57 +0000 (-0500)
Subject: Clarify that archive_errno() cannot be reliably used to determine when
X-Git-Tag: v3.0.0a~1196
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=49cbc2f73bac153f85b62620eaeb6913d070ca3c;p=thirdparty%2Flibarchive.git

Clarify that archive_errno() cannot be reliably used to determine when
an error occurs.

SVN-Revision: 1969
---

diff --git a/libarchive/archive_util.3 b/libarchive/archive_util.3
index fb04c4fbd..f4cf2557e 100644
--- a/libarchive/archive_util.3
+++ b/libarchive/archive_util.3
@@ -100,6 +100,10 @@ Copies error information from one archive to another.
 Returns a numeric error code (see
 .Xr errno 2 )
 indicating the reason for the most recent error return.
+Note that this can not be reliably used to detect whether an
+error has occurred.
+It should be used only after another libarchive function
+has returned an error status.
 .It Fn archive_error_string
 Returns a textual error message suitable for display.
 The error message here is usually more specific than that