- remove what appears to be a copy/paste error from docs in

  network_io
- add details about ranges of status numbers used by apr



git-svn-id: http://svn.apache.org/repos/asf/apr/apr/trunk@416407 13f79535-47bb-0310-9956-ffa450edef68

2 files changed, 46 insertions, 2 deletions

diff --git a/include/apr_errno.h b/include/apr_errno.h
index 9f4e569e9..12587b160 100644
--- a/include/apr_errno.h
+++ b/include/apr_errno.h
@@ -131,6 +131,18 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf,
  *     error immediately following this one is set ten times farther
  *     away than usual, so that users of apr have a lot of room in
  *     which to declare custom error codes.
+ *
+ * In general applications should try and create unique error codes. To try
+ * and assist in finding suitable ranges of numbers to use, the following
+ * ranges are known to be used by the listed applications. If your 
+ * application defines error codes please advise the range of numbers it
+ * uses to dev@apr.apache.org for inclusion in this list.
+ *
+ * Ranges shown are in relation to APR_OS_START_USERERR
+ *
+ * Subversion - Defined ranges, of less than 100, at intervals of 5000
+ *              starting at an offset of 5000, e.g.
+ *               +5000 to 5100,  +10000 to 10100
  */
 #define APR_OS_START_USERERR    (APR_OS_START_STATUS + APR_OS_ERRSPACE_SIZE)
 /**
@@ -155,6 +167,39 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf,
  */
 #define APR_OS_START_SYSERR    (APR_OS_START_EAIERR + APR_OS_ERRSPACE_SIZE)
 
+/**
+ * @defgroup APR_ERROR_map APR Error Space
+ * <PRE>
+ * The following attempts to show the relation of the various constants
+ * used for mapping APR Status codes.
+ *
+ *       0          
+ *
+ *  20,000     APR_OS_START_ERROR
+ *
+ *         + APR_OS_ERRSPACE_SIZE (50,000)
+ *
+ *  70,000      APR_OS_START_STATUS
+ *
+ *         + APR_OS_ERRSPACE_SIZE (50,000)
+ *
+ * 120,000      APR_OS_START_USERERR
+ *
+ *         + 10 x APR_OS_ERRSPACE_SIZE (50,000 * 10)
+ *
+ * 620,000      APR_OS_START_CANONERR
+ *
+ *         + APR_OS_ERRSPACE_SIZE (50,000)
+ *
+ * 670,000      APR_OS_START_EAIERR
+ *
+ *         + APR_OS_ERRSPACE_SIZE (50,000)
+ *
+ * 720,000      APR_OS_START_SYSERR
+ *
+ * </PRE>
+ */
+
 /** no error. */
 #define APR_SUCCESS 0
 
@@ -575,7 +620,7 @@ APR_DECLARE(char *) apr_strerror(apr_status_t statcode, char *buf,
 #define APR_EACCES         (APR_OS_START_CANONERR + 1)
 #endif
 
-/** @see APR_STATUS_IS_EXIST */
+/** @see APR_STATUS_IS_EEXIST */
 #ifdef EEXIST
 #define APR_EEXIST EEXIST
 #else
diff --git a/include/apr_network_io.h b/include/apr_network_io.h
index 383d963ff..7006abd16 100644
--- a/include/apr_network_io.h
+++ b/include/apr_network_io.h
@@ -671,7 +671,6 @@ APR_DECLARE(apr_status_t) apr_sockaddr_ip_get(char **addr,
 /**
  * Write the IP address (in numeric address string format) of the APR
  * socket address @a sockaddr into the buffer @a buf (of size @a buflen).
- * @param addr The IP address.
  * @param sockaddr The socket address to reference.
  */
 APR_DECLARE(apr_status_t) apr_sockaddr_ip_getbuf(char *buf, apr_size_t buflen,