diff options
| author | Sander Striker <striker@apache.org> | 2008-07-11 17:51:16 +0000 |
|---|---|---|
| committer | Sander Striker <striker@apache.org> | 2008-07-11 17:51:16 +0000 |
| commit | 74a942269cf07107ee27382dbf2658463ea518be (patch) | |
| tree | 6de045c7118bfd62e7c0c7f2c825fd1d619f82f9 /include/apr_pools.h | |
| parent | 92e8dd2bc59e763ef6956c49d6f4406c5b1f9de8 (diff) | |
| download | apr-74a942269cf07107ee27382dbf2658463ea518be.tar.gz | |
Pools: Documentation update. #define tweaks.
* include/apr_pools.h
(apr_pool_create_unmanaged_ex): Update docstring. Reflow, removing
speling error. Word warning stronger.
(apr_pool_create_core_ex, apr_pool_create_core): Update #defines to
use apr_pool_create_unmanaged instead of the core counterparts.
git-svn-id: https://svn.apache.org/repos/asf/apr/apr/trunk@676037 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'include/apr_pools.h')
| -rw-r--r-- | include/apr_pools.h | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/include/apr_pools.h b/include/apr_pools.h index d28f6f9af..5f0b36732 100644 --- a/include/apr_pools.h +++ b/include/apr_pools.h @@ -200,12 +200,13 @@ APR_DECLARE(apr_status_t) apr_pool_create_core_ex(apr_pool_t **newpool, * Create a new unmanaged pool. * @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 the + * @param allocator The allocator to use with the new pool. If NULL a * new allocator will be crated with newpool as owner. - * @remark Unmanaged pool is special pool that does not have parent pool - * and is NOT destroyed upon apr_terminate call. - * It must be explicitly destroyed by calling apr_pool_destroy, - * otherwise the memory will leek. + * @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. */ APR_DECLARE(apr_status_t) apr_pool_create_unmanaged_ex(apr_pool_t **newpool, apr_abortfunc_t abort_fn, @@ -270,7 +271,7 @@ APR_DECLARE(apr_status_t) apr_pool_create_unmanaged_ex_debug(apr_pool_t **newpoo #if APR_POOL_DEBUG #define apr_pool_create_core_ex(newpool, abort_fn, allocator) \ - apr_pool_create_core_ex_debug(newpool, abort_fn, allocator, \ + apr_pool_create_unmanaged_ex_debug(newpool, abort_fn, allocator, \ APR_POOL__FILE_LINE__) #define apr_pool_create_unmanaged_ex(newpool, abort_fn, allocator) \ @@ -311,14 +312,14 @@ APR_DECLARE(apr_status_t) apr_pool_create_unmanaged(apr_pool_t **newpool); #else #if APR_POOL_DEBUG #define apr_pool_create_core(newpool) \ - apr_pool_create_core_ex_debug(newpool, NULL, NULL, \ + apr_pool_create_unmanaged_ex_debug(newpool, NULL, NULL, \ APR_POOL__FILE_LINE__) #define apr_pool_create_unmanaged(newpool) \ apr_pool_create_unmanaged_ex_debug(newpool, NULL, NULL, \ APR_POOL__FILE_LINE__) #else #define apr_pool_create_core(newpool) \ - apr_pool_create_core_ex(newpool, NULL, NULL) + apr_pool_create_unmanaged_ex(newpool, NULL, NULL) #define apr_pool_create_unmanaged(newpool) \ apr_pool_create_unmanaged_ex(newpool, NULL, NULL) #endif |