Mailing-List: contact commits-help@apr.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@apr.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1528850 - in /apr/apr/branches/1.5.x: ./
 include/apr_allocator.h include/apr_errno.h include/apr_file_info.h
 include/apr_inherit.h include/apr_mmap.h include/apr_pools.h
 include/apr_thread_proc.h include/apr_user.h
Date: Thu, 03 Oct 2013 13:29:04 -0000
To: commits@apr.apache.org
From: rjung@apache.org
Message-Id: <20131003132904.85ED023888E2@eris.apache.org>

Author: rjung
Date: Thu Oct  3 13:29:03 2013
New Revision: 1528850

URL: http://svn.apache.org/r1528850
Log:
Fix doc errors in APR header files.

PR: 55133
Submitted by: Mike Rumph <mike.rumph oracle.com>

Backport of r1496407 from trunk.

Modified:
    apr/apr/branches/1.5.x/   (props changed)
    apr/apr/branches/1.5.x/include/apr_allocator.h
    apr/apr/branches/1.5.x/include/apr_errno.h
    apr/apr/branches/1.5.x/include/apr_file_info.h
    apr/apr/branches/1.5.x/include/apr_inherit.h
    apr/apr/branches/1.5.x/include/apr_mmap.h
    apr/apr/branches/1.5.x/include/apr_pools.h
    apr/apr/branches/1.5.x/include/apr_thread_proc.h
    apr/apr/branches/1.5.x/include/apr_user.h

Propchange: apr/apr/branches/1.5.x/
------------------------------------------------------------------------------
  Merged /apr/apr/trunk:r1496407

Modified: apr/apr/branches/1.5.x/include/apr_allocator.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.5.x/include/apr_allocator.h?rev=1528850&r1=1528849&r2=1528850&view=diff
==============================================================================
--- apr/apr/branches/1.5.x/include/apr_allocator.h (original)
+++ apr/apr/branches/1.5.x/include/apr_allocator.h Thu Oct  3 13:29:03 2013
@@ -131,7 +131,7 @@ APR_DECLARE(apr_pool_t *) apr_allocator_
 /**
  * Set the current threshold at which the allocator should start
  * giving blocks back to the system.
- * @param allocator The allocator the set the threshold on
+ * @param allocator The allocator to set the threshold on
  * @param size The threshold.  0 == unlimited.
  */
 APR_DECLARE(void) apr_allocator_max_free_set(apr_allocator_t *allocator,

Modified: apr/apr/branches/1.5.x/include/apr_errno.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.5.x/include/apr_errno.h?rev=1528850&r1=1528849&r2=1528850&view=diff
==============================================================================
--- apr/apr/branches/1.5.x/include/apr_errno.h (original)
+++ apr/apr/branches/1.5.x/include/apr_errno.h Thu Oct  3 13:29:03 2013
@@ -45,7 +45,7 @@ typedef int apr_status_t;
 
 /**
  * Return a human readable string describing the specified error.
- * @param statcode The error code the get a string for.
+ * @param statcode The error code to get a string for.
  * @param buf A buffer to hold the error string.
  * @param bufsize Size of the buffer to hold the string.
  */
@@ -126,7 +126,7 @@ APR_DECLARE(char *) apr_strerror(apr_sta
  * use within apr-util. This space is reserved above that used by APR
  * internally.
  * @note This number MUST be smaller than APR_OS_ERRSPACE_SIZE by a
- *       large enough amount that APR has sufficient room for it's
+ *       large enough amount that APR has sufficient room for its
  *       codes.
  */
 #define APR_UTIL_ERRSPACE_SIZE 20000
@@ -135,7 +135,7 @@ APR_DECLARE(char *) apr_strerror(apr_sta
  */
 #define APR_OS_START_STATUS    (APR_OS_START_ERROR + APR_OS_ERRSPACE_SIZE)
 /**
- * APR_UTIL_START_STATUS is where APR-Util starts defining it's
+ * APR_UTIL_START_STATUS is where APR-Util starts defining its
  * status codes.
  */
 #define APR_UTIL_START_STATUS   (APR_OS_START_STATUS + \

Modified: apr/apr/branches/1.5.x/include/apr_file_info.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.5.x/include/apr_file_info.h?rev=1528850&r1=1528849&r2=1528850&view=diff
==============================================================================
--- apr/apr/branches/1.5.x/include/apr_file_info.h (original)
+++ apr/apr/branches/1.5.x/include/apr_file_info.h Thu Oct  3 13:29:03 2013
@@ -316,7 +316,7 @@ APR_DECLARE(apr_status_t) apr_dir_rewind
  * @param filepath the pathname to parse for its root component
  * @param flags the desired rules to apply, from
  * <PRE>
- *      APR_FILEPATH_NATIVE    Use native path seperators (e.g. '\' on Win32)
+ *      APR_FILEPATH_NATIVE    Use native path separators (e.g. '\' on Win32)
  *      APR_FILEPATH_TRUENAME  Tests that the root exists, and makes it proper
  * </PRE>
  * @param p the pool to allocate the new path string from
@@ -328,7 +328,7 @@ APR_DECLARE(apr_status_t) apr_dir_rewind
  * test for the validity of that root (e.g., that a drive d:/ or network 
  * share //machine/foovol/). 
  * The function returns APR_ERELATIVE if filepath isn't rooted (an
- * error), APR_EINCOMPLETE if the root path is ambigious (but potentially
+ * error), APR_EINCOMPLETE if the root path is ambiguous (but potentially
  * legitimate, e.g. "/" on Windows is incomplete because it doesn't specify
  * the drive letter), or APR_EBADPATH if the root is simply invalid.
  * APR_SUCCESS is returned if filepath is an absolute path.
@@ -362,7 +362,7 @@ APR_DECLARE(apr_status_t) apr_filepath_m
  * @param pathelts the returned components of the search path
  * @param liststr the search path (e.g., <tt>getenv("PATH")</tt>)
  * @param p the pool to allocate the array and path components from
- * @remark empty path componenta do not become part of @a pathelts.
+ * @remark empty path components do not become part of @a pathelts.
  * @remark the path separator in @a liststr is system specific;
  * e.g., ':' on Unix, ';' on Windows, etc.
  */

Modified: apr/apr/branches/1.5.x/include/apr_inherit.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.5.x/include/apr_inherit.h?rev=1528850&r1=1528849&r2=1528850&view=diff
==============================================================================
--- apr/apr/branches/1.5.x/include/apr_inherit.h (original)
+++ apr/apr/branches/1.5.x/include/apr_inherit.h Thu Oct  3 13:29:03 2013
@@ -28,7 +28,7 @@
  * Prototype for type-specific declarations of apr_foo_inherit_set 
  * functions.  
  * @remark Doxygen unwraps this macro (via doxygen.conf) to provide 
- * actual help for each specific occurance of apr_foo_inherit_set.
+ * actual help for each specific occurrence of apr_foo_inherit_set.
  * @remark the linkage is specified for APR. It would be possible to expand
  *       the macros to support other linkages.
  */
@@ -40,7 +40,7 @@
  * Prototype for type-specific declarations of apr_foo_inherit_unset 
  * functions.  
  * @remark Doxygen unwraps this macro (via doxygen.conf) to provide 
- * actual help for each specific occurance of apr_foo_inherit_unset.
+ * actual help for each specific occurrence of apr_foo_inherit_unset.
  * @remark the linkage is specified for APR. It would be possible to expand
  *       the macros to support other linkages.
  */

Modified: apr/apr/branches/1.5.x/include/apr_mmap.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.5.x/include/apr_mmap.h?rev=1528850&r1=1528849&r2=1528850&view=diff
==============================================================================
--- apr/apr/branches/1.5.x/include/apr_mmap.h (original)
+++ apr/apr/branches/1.5.x/include/apr_mmap.h Thu Oct  3 13:29:03 2013
@@ -120,7 +120,7 @@ struct apr_mmap_t {
 /** 
  * Create a new mmap'ed file out of an existing APR file.
  * @param newmmap The newly created mmap'ed file.
- * @param file The file turn into an mmap.
+ * @param file The file to turn into an mmap.
  * @param offset The offset into the file to start the data pointer at.
  * @param size The size of the file
  * @param flag bit-wise or of:

Modified: apr/apr/branches/1.5.x/include/apr_pools.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.5.x/include/apr_pools.h?rev=1528850&r1=1528849&r2=1528850&view=diff
==============================================================================
--- apr/apr/branches/1.5.x/include/apr_pools.h (original)
+++ apr/apr/branches/1.5.x/include/apr_pools.h Thu Oct  3 13:29:03 2013
@@ -71,10 +71,10 @@ typedef struct apr_pool_t apr_pool_t;
  * <pre>
  *    APR_POOL_DECLARE_ACCESSOR(file);
  * becomes:
- *    APR_DECLARE(apr_pool_t *) apr_file_pool_get(apr_file_t *ob);
+ *    APR_DECLARE(apr_pool_t *) apr_file_pool_get(const apr_file_t *thefile);
  * </pre>
  * @remark Doxygen unwraps this macro (via doxygen.conf) to provide 
- * actual help for each specific occurance of apr_foo_pool_get.
+ * actual help for each specific occurrence of apr_foo_pool_get.
  * @remark the linkage is specified for APR. It would be possible to expand
  *       the macros to support other linkages.
  */
@@ -118,15 +118,15 @@ typedef struct apr_pool_t apr_pool_t;
  *
  * |   |   |   |   | x |   |   |   |  Pool owner checking.  On each use of a
  *                                    pool, check if the current thread is the
- *                                    pools owner.  If not, abort().  In
+ *                                    pool's owner.  If not, abort().  In
  *                                    combination with the verbose flag above,
  *                                    it will output OWNER in such an event
  *                                    prior to aborting.  Use the debug
  *                                    function apr_pool_owner_set() to switch
- *                                    a pools ownership.
+ *                                    a pool's ownership.
  *
  * When no debug level was specified, assume general debug mode.
- * If level 0 was specified, debugging is switched off
+ * If level 0 was specified, debugging is switched off.
  * </pre>
  */
 #if defined(APR_POOL_DEBUG)
@@ -212,12 +212,16 @@ APR_DECLARE(apr_status_t) apr_pool_creat
  * @param newpool The pool we have just created.
  * @param abort_fn A function to use if the pool cannot allocate more memory.
  * @param allocator The allocator to use with the new pool.  If NULL a
- *        new allocator will be crated with newpool as owner.
+ *        new allocator will be created with the new pool as owner.
  * @remark An unmanaged pool is a special pool without a parent; it will
  *         NOT be destroyed upon apr_terminate.  It must be explicitly
  *         destroyed by calling apr_pool_destroy, to prevent memory leaks.
  *         Use of this function is discouraged, think twice about whether
  *         you really really need it.
+ * @warning Any child cleanups registered against the new pool, or
+ *         against sub-pools thereof, will not be executed during an
+ *         invocation of apr_proc_create(), so resources created in an
+ *         "unmanaged" pool hierarchy will leak to child processes.
  */
 APR_DECLARE(apr_status_t) apr_pool_create_unmanaged_ex(apr_pool_t **newpool,
                                                    apr_abortfunc_t abort_fn,
@@ -233,7 +237,7 @@ APR_DECLARE(apr_status_t) apr_pool_creat
  * @param file_line Where the function is called from.
  *        This is usually APR_POOL__FILE_LINE__.
  * @remark Only available when APR_POOL_DEBUG is defined.
- *         Call this directly if you have you apr_pool_create_ex
+ *         Call this directly if you have your apr_pool_create_ex
  *         calls in a wrapper function and wish to override
  *         the file_line argument to reflect the caller of
  *         your wrapper function.  If you do not have
@@ -270,7 +274,7 @@ APR_DECLARE(apr_status_t) apr_pool_creat
  * @param file_line Where the function is called from.
  *        This is usually APR_POOL__FILE_LINE__.
  * @remark Only available when APR_POOL_DEBUG is defined.
- *         Call this directly if you have you apr_pool_create_unmanaged_ex
+ *         Call this directly if you have your apr_pool_create_unmanaged_ex
  *         calls in a wrapper function and wish to override
  *         the file_line argument to reflect the caller of
  *         your wrapper function.  If you do not have
@@ -321,7 +325,7 @@ APR_DECLARE(apr_status_t) apr_pool_creat
 #endif
 
 /**
- * Create a new pool.
+ * Create a new unmanaged pool.
  * @param newpool The pool we have just created.
  */
 #if defined(DOXYGEN)
@@ -366,7 +370,7 @@ APR_DECLARE(void) apr_pool_clear(apr_poo
  * @param file_line Where the function is called from.
  *        This is usually APR_POOL__FILE_LINE__.
  * @remark Only available when APR_POOL_DEBUG is defined.
- *         Call this directly if you have you apr_pool_clear
+ *         Call this directly if you have your apr_pool_clear
  *         calls in a wrapper function and wish to override
  *         the file_line argument to reflect the caller of
  *         your wrapper function.  If you do not have
@@ -396,7 +400,7 @@ APR_DECLARE(void) apr_pool_destroy(apr_p
  * @param file_line Where the function is called from.
  *        This is usually APR_POOL__FILE_LINE__.
  * @remark Only available when APR_POOL_DEBUG is defined.
- *         Call this directly if you have you apr_pool_destroy
+ *         Call this directly if you have your apr_pool_destroy
  *         calls in a wrapper function and wish to override
  *         the file_line argument to reflect the caller of
  *         your wrapper function.  If you do not have
@@ -614,7 +618,7 @@ APR_DECLARE(apr_status_t) apr_pool_userd
 
 /**
  * Register a function to be called when a pool is cleared or destroyed
- * @param p The pool register the cleanup with
+ * @param p The pool to register the cleanup with
  * @param data The data to pass to the cleanup function.
  * @param plain_cleanup The function to call when the pool is cleared
  *                      or destroyed
@@ -630,11 +634,11 @@ APR_DECLARE(void) apr_pool_cleanup_regis
 /**
  * Register a function to be called when a pool is cleared or destroyed.
  *
- * Unlike apr_pool_cleanup_register which register a cleanup
- * that is called AFTER all subpools are destroyed this function register
- * a function that will be called before any of the subpool is destoryed.
+ * Unlike apr_pool_cleanup_register which registers a cleanup
+ * that is called AFTER all subpools are destroyed, this function registers
+ * a function that will be called before any of the subpools are destroyed.
  *
- * @param p The pool register the cleanup with
+ * @param p The pool to register the cleanup with
  * @param data The data to pass to the cleanup function.
  * @param plain_cleanup The function to call when the pool is cleared
  *                      or destroyed

Modified: apr/apr/branches/1.5.x/include/apr_thread_proc.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.5.x/include/apr_thread_proc.h?rev=1528850&r1=1528849&r2=1528850&view=diff
==============================================================================
--- apr/apr/branches/1.5.x/include/apr_thread_proc.h (original)
+++ apr/apr/branches/1.5.x/include/apr_thread_proc.h Thu Oct  3 13:29:03 2013
@@ -114,7 +114,7 @@ typedef enum {
 #define APR_OC_REASON_DEATH         0     /**< child has died, caller must call
                                            * unregister still */
 #define APR_OC_REASON_UNWRITABLE    1     /**< write_fd is unwritable */
-#define APR_OC_REASON_RESTART       2     /**< a restart is occuring, perform
+#define APR_OC_REASON_RESTART       2     /**< a restart is occurring, perform
                                            * any necessary cleanup (including
                                            * sending a special signal to child)
                                            */
@@ -123,7 +123,7 @@ typedef enum {
                                            * kill the child) */
 #define APR_OC_REASON_LOST          4     /**< somehow the child exited without
                                            * us knowing ... buggy os? */
-#define APR_OC_REASON_RUNNING       5     /**< a health check is occuring, 
+#define APR_OC_REASON_RUNNING       5     /**< a health check is occurring, 
                                            * for most maintainence functions
                                            * this is a no-op.
                                            */

Modified: apr/apr/branches/1.5.x/include/apr_user.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.5.x/include/apr_user.h?rev=1528850&r1=1528849&r2=1528850&view=diff
==============================================================================
--- apr/apr/branches/1.5.x/include/apr_user.h (original)
+++ apr/apr/branches/1.5.x/include/apr_user.h Thu Oct  3 13:29:03 2013
@@ -81,7 +81,7 @@ APR_DECLARE(apr_status_t) apr_uid_name_g
  * Get the userid (and groupid) for the specified username
  * @param userid   Returns the user id
  * @param groupid  Returns the user's group id
- * @param username The username to lookup
+ * @param username The username to look up
  * @param p The pool from which to allocate working space
  * @remark This function is available only if APR_HAS_USER is defined.
  */
@@ -103,7 +103,7 @@ APR_DECLARE(apr_status_t) apr_uid_homepa
  * Compare two user identifiers for equality.
  * @param left One uid to test
  * @param right Another uid to test
- * @return APR_SUCCESS if the apr_uid_t strutures identify the same user,
+ * @return APR_SUCCESS if the apr_uid_t structures identify the same user,
  * APR_EMISMATCH if not, APR_BADARG if an apr_uid_t is invalid.
  * @remark This function is available only if APR_HAS_USER is defined.
  */
@@ -137,7 +137,7 @@ APR_DECLARE(apr_status_t) apr_gid_get(ap
  * Compare two group identifiers for equality.
  * @param left One gid to test
  * @param right Another gid to test
- * @return APR_SUCCESS if the apr_gid_t strutures identify the same group,
+ * @return APR_SUCCESS if the apr_gid_t structures identify the same group,
  * APR_EMISMATCH if not, APR_BADARG if an apr_gid_t is invalid.
  * @remark This function is available only if APR_HAS_USER is defined.
  */