ISAR/libmdbx
3
0
Fork 0
mirror of https://github.com/isar/libmdbx.git synced 2025-01-02 00:44:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

mdbx: minor refine description of mdbx_env_delete().

Browse Source 
Change-Id: I095c741fba08b08c6302116d9601438d813524a1
This commit is contained in:
Leonid Yuriev 2020-10-10 18:30:21 +03:00
parent 9afbde9b0a
commit 6e82dd5d0c
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
mdbx.h
View File

@ -1801,7 +1801,7 @@ LIBMDBX_API int mdbx_env_create(MDBX_env **penv);
LIBMDBX_API int mdbx_env_open(MDBX_env *env, const char *pathname, LIBMDBX_API int mdbx_env_open(MDBX_env *env, const char *pathname,
MDBX_env_flags_t flags, mdbx_mode_t mode); MDBX_env_flags_t flags, mdbx_mode_t mode);
/** \brief Deletion modes for \ref mdbx_env_delete() /** \brief Deletion modes for \ref mdbx_env_delete().
* \ingroup c_extra * \ingroup c_extra
* \see mdbx_env_delete() */ * \see mdbx_env_delete() */
enum MDBX_env_delete_mode_t { enum MDBX_env_delete_mode_t {
@ -1812,10 +1812,11 @@ enum MDBX_env_delete_mode_t {
* because the system does not support deleting files that are currently * because the system does not support deleting files that are currently
* memory mapped. */ * memory mapped. */
MDBX_ENV_JUST_DELETE = 0, MDBX_ENV_JUST_DELETE = 0,
/** Make sure that the environment is not being used by other processes, /** \brief Make sure that the environment is not being used by other
* or return an error otherwise. */ * processes, or return an error otherwise. */
MDBX_ENV_ENSURE_UNUSED = 1, MDBX_ENV_ENSURE_UNUSED = 1,
/** Wait until other processes closes the environment before deletion. */ /** \brief Wait until other processes closes the environment before deletion.
*/
MDBX_ENV_WAIT_FOR_UNUSED = 2, MDBX_ENV_WAIT_FOR_UNUSED = 2,
}; };
#ifndef __cplusplus #ifndef __cplusplus
@ -1823,7 +1824,7 @@ enum MDBX_env_delete_mode_t {
typedef enum MDBX_env_delete_mode_t MDBX_env_delete_mode_t; typedef enum MDBX_env_delete_mode_t MDBX_env_delete_mode_t;
#endif #endif
/** \brief Delete the environment files in a proper and multiprocess-safe way. /** \brief Delete the environment's files in a proper and multiprocess-safe way.
* \ingroup c_extra * \ingroup c_extra
* *
* \param [in] pathname The pathname for the database or the directory in which * \param [in] pathname The pathname for the database or the directory in which