diff options
| author | William A. Rowe Jr <wrowe@apache.org> | 2007-11-06 03:13:42 +0000 |
|---|---|---|
| committer | William A. Rowe Jr <wrowe@apache.org> | 2007-11-06 03:13:42 +0000 |
| commit | 84d03e308ac337a3ad67e8cbaa7ae66a9fc1045b (patch) | |
| tree | be0e87d767834df17d1dc2631bb3c2c2587ac08d /include/apr_shm.h | |
| parent | 0e46904e81fcdc5d46cea50c7ea42e5e64a5a30f (diff) | |
| download | apr-84d03e308ac337a3ad67e8cbaa7ae66a9fc1045b.tar.gz | |
Axe another poor illustration, apr_shm_destroy preceeds apr_shm_remove
for portability. (As the comment hints, a non-portable alternative
does exist).
And be consistent in the use of @remark's --- although I suspect
that we need to review @remarks and transition many to @warning.
git-svn-id: https://svn.apache.org/repos/asf/apr/apr/trunk@592235 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'include/apr_shm.h')
| -rw-r--r-- | include/apr_shm.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/include/apr_shm.h b/include/apr_shm.h index 4875ee1ff..651d9dbbf 100644 --- a/include/apr_shm.h +++ b/include/apr_shm.h @@ -71,13 +71,14 @@ APR_DECLARE(apr_status_t) apr_shm_create(apr_shm_t **m, apr_pool_t *pool); /** - * Remove shared memory segment associated with a filename. + * Remove file associated with a shared memory segment. * @param filename The filename associated with shared-memory segment which * needs to be removed * @param pool The pool used for file operations * @remark This function is only supported on platforms which support * name-based shared memory segments, and will return APR_ENOTIMPL on - * platforms without such support. + * platforms without such support. Removing the file while the shm + * is in use (prior to apr_shm_destroy) is non-portable. */ APR_DECLARE(apr_status_t) apr_shm_remove(const char *filename, apr_pool_t *pool); |