Return-Path: Delivered-To: apmail-apache-cvs-archive@apache.org Received: (qmail 56824 invoked by uid 500); 22 Jul 2000 23:08:37 -0000 Mailing-List: contact apache-cvs-help@apache.org; run by ezmlm Precedence: bulk X-No-Archive: yes Reply-To: new-httpd@apache.org list-help: list-unsubscribe: list-post: Delivered-To: mailing list apache-cvs@apache.org Received: (qmail 56813 invoked by uid 500); 22 Jul 2000 23:08:36 -0000 Delivered-To: apmail-apache-2.0-cvs@apache.org Date: 22 Jul 2000 23:08:36 -0000 Message-ID: <20000722230836.56809.qmail@locus.apache.org> From: rbb@locus.apache.org To: apache-2.0-cvs@apache.org Subject: cvs commit: apache-2.0/src/lib/apr/include apr_errno.h rbb 00/07/22 16:08:36 Modified: src/lib/apr/include apr_errno.h Log: Commit the apr_errno.h changes to use ScanDoc. Revision Changes Path 1.37 +61 -56 apache-2.0/src/lib/apr/include/apr_errno.h Index: apr_errno.h =================================================================== RCS file: /home/cvs/apache-2.0/src/lib/apr/include/apr_errno.h,v retrieving revision 1.36 retrieving revision 1.37 diff -u -r1.36 -r1.37 --- apr_errno.h 2000/07/10 23:00:32 1.36 +++ apr_errno.h 2000/07/22 23:08:36 1.37 @@ -52,59 +52,6 @@ * . */ -/* - -=head1 APR ERROR CODES - - APR_ENOSTAT APR was unable to perform a stat on the file - APR_ENOPOOL APR was not provided a pool with which to allocate memory - APR_EBADDATE APR was given an invalid date - APR_EINVALSOCK APR was given an invalid socket - APR_ENOFILE APR was not given a file structure - APR_ENOPROC APR was not given a process structure - APR_ENOTIME APR was not given a time structure - APR_ENODIR APR was not given a directory structure - APR_ENOLOCK APR was not given a lock structure - APR_ENOPOLL APR was not given a poll structure - APR_ENOSOCKET APR was not given a socket - APR_ENOTHREAD APR was nto given a thread structure - APR_ENOTHDKEY APR was not given a thread key structure - APR_ENOSHMAVAIL There is no more shared memory available - APR_EDSOOPEN APR was unable to open the dso object. For more - information consult ap_dso_error. - -=head1 APR STATUS CODES - - APR_INCHILD Program is currently executing in the child - APR_INPARENT Program is currently executing in the parent - APR_DETACH The thread is detached - APR_NOTDETACH The thread is not detached - APR_CHILD_DONE The child has finished executing - APR_CHILD_NOTDONE The child has not finished executing - APR_TIMEUP The operation did not finish before the timeout - APR_INCOMPLETE The character conversion stopped because of an - incomplete character or shift sequence at the end of - the input buffer. - APR_BADCH Getopt found an option not in the option string - APR_BADARG Getopt found an option that is missing an argument and - and argument was specified in the option string - APR_EOF APR has encountered the end of the file - APR_NOTFOUND APR was unable to find the socket in the poll structure - APR_ANONYMOUS APR is using anonymous shared memory - APR_FILEBASED APR is using a file name as the key to the shared memory - APR_KEYBASED APR is using a shared key as the key to the shared - memory - APR_EINIT Ininitalizer value. If no option has been found, but - the status variable requires a value, this should be - used - APR_ENOTIMPL The APR function has not been implemented on this - platform, either because nobody has gotten to it yet, - or the function is impossible on this platform. - APR_EMISMATCH Two passwords do not match. - -=cut - */ - #ifndef APR_ERRNO_H #define APR_ERRNO_H @@ -115,15 +62,23 @@ extern "C" { #endif /* __cplusplus */ +/** + * @package Error Codes + */ + typedef int ap_status_t; -/* see lib/apr/APRDesign for why this inane function needs to be used - * everywhere. +/** + * Convert an APR error to a canonical error + * @param err The APR error value + * @return The canonical error value + * @tip see apr/APRDesgin for an explanation of why this is necessary. */ int ap_canonical_error(ap_status_t err); -/* APR_OS_START_ERROR is where the APR specific error values should start. +/* + * APR_OS_START_ERROR is where the APR specific error values should start. * APR_OS_START_STATUS is where the APR specific status codes should start. * APR_OS_START_USEERR are reserved for applications that use APR that * layer their own error codes along with APR's. @@ -139,6 +94,56 @@ #define APR_OS2_STATUS(e) (e == 0 ? APR_SUCCESS : e + APR_OS_START_SYSERR) #define APR_SUCCESS 0 + +/** + * 
  + * APR ERROR VALUES
  + * APR_ENOSTAT      APR was unable to perform a stat on the file 
  + * APR_ENOPOOL      APR was not provided a pool with which to allocate memory
  + * APR_EBADDATE     APR was given an invalid date 
  + * APR_EINVALSOCK   APR was given an invalid socket
  + * APR_ENOFILE      APR was not given a file structure
  + * APR_ENOPROC      APR was not given a process structure
  + * APR_ENOTIME      APR was not given a time structure
  + * APR_ENODIR       APR was not given a directory structure
  + * APR_ENOLOCK      APR was not given a lock structure
  + * APR_ENOPOLL      APR was not given a poll structure
  + * APR_ENOSOCKET    APR was not given a socket
  + * APR_ENOTHREAD    APR was nto given a thread structure
  + * APR_ENOTHDKEY    APR was not given a thread key structure
  + * APR_ENOSHMAVAIL  There is no more shared memory available
  + * APR_EDSOOPEN     APR was unable to open the dso object.  For more 
  + *                  information call ap_dso_error().
  + *
+ * + * 
  + * APR STATUS VALUES
  + * APR_INCHILD        Program is currently executing in the child
  + * APR_INPARENT       Program is currently executing in the parent
  + * APR_DETACH         The thread is detached
  + * APR_NOTDETACH      The thread is not detached
  + * APR_CHILD_DONE     The child has finished executing
  + * APR_CHILD_NOTDONE  The child has not finished executing
  + * APR_TIMEUP         The operation did not finish before the timeout
  + * APR_INCOMPLETE     The character conversion stopped because of an 
  + *                    incomplete character or shift sequence at the end 
  + *                    of the input buffer.
  + * APR_BADCH          Getopt found an option not in the option string
  + * APR_BADARG         Getopt found an option that is missing an argument 
  + *                    and and argument was specified in the option string
  + * APR_EOF            APR has encountered the end of the file
  + * APR_NOTFOUND       APR was unable to find the socket in the poll structure
  + * APR_ANONYMOUS      APR is using anonymous shared memory
  + * APR_FILEBASED      APR is using a file name as the key to the shared memory
  + * APR_KEYBASED       APR is using a shared key as the key to the shared memory
  + * APR_EINIT          Ininitalizer value.  If no option has been found, but 
  + *                    the status variable requires a value, this should be used
  + * APR_ENOTIMPL       The APR function has not been implemented on this 
  + *                    platform, either because nobody has gotten to it yet, 
  + *                    or the function is impossible on this platform.
  + * APR_EMISMATCH      Two passwords do not match.
  + *
+ */ /* APR ERROR VALUES */ #define APR_ENOSTAT (APR_OS_START_ERROR + 1)