Author: danielsh
Date: Fri Apr 12 15:40:24 2013
New Revision: 1467314
URL: http://svn.apache.org/r1467314
Log:
* subversion/include/svn_error.h
(svn_error_symbolic_name): Clarify docstring.
Suggested by: julianf
Modified:
subversion/trunk/subversion/include/svn_error.h
Modified: subversion/trunk/subversion/include/svn_error.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_error.h?rev=1467314&r1=1467313&r2=1467314&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_error.h (original)
+++ subversion/trunk/subversion/include/svn_error.h Fri Apr 12 15:40:24 2013
@@ -68,7 +68,19 @@ svn_strerror(apr_status_t statcode,
/**
* Return the symbolic name of an error code. If the error code
- * is not a Subversion error code (from svn_error_codes.h), return @c NULL.
+ * is in svn_error_codes.h, return the name of the macro as a string.
+ * If the error number is not recognised, return @c NULL.
+ *
+ * An error number may not be recognised because it was defined in a future
+ * version of Subversion (e.g., a 1.9.x server may transmit a defined-in-1.9.0
+ * error number to a 1.8.x client).
+ *
+ * An error number may be recognised @em incorrectly if the @c apr_status_t
+ * value originates in another library (such as libserf) which also uses APR.
+ *
+ * Support for error codes returned by APR itself (i.e., not in the
+ * @c APR_OS_START_USERERR, as defined in apr_errno.h) may be implemented in
+ * the future.
*
* @note In rare cases, a single numeric code has more than one symbolic name.
* (For example, #SVN_ERR_WC_NOT_DIRECTORY and #SVN_ERR_WC_NOT_WORKING_COPY).
