ISAR/libmdbx
3
0
Fork 0
mirror of https://github.com/isar/libmdbx.git synced 2024-10-29 23:19:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

mdbx: fix description of mdbx_env_set_geometry().

Browse Source 
Oops, I just noticed that there are a strange typos in the description.
It looks like a search&replace or cut&paste mistake.

Related to https://github.com/LWJGL/lwjgl3/issues/724.
This commit is contained in:
Леонид Юрьев (Leonid Yuriev) 2022-02-02 14:04:56 +03:00
parent b6a0d11b99
commit e740df6e50
1 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
mdbx.h
View File

@ -2690,17 +2690,18 @@ LIBMDBX_API int mdbx_env_get_fd(const MDBX_env *env, mdbx_filehandle_t *fd);
* it is reasonable to know some details in order to make optimal decisions
* when choosing parameters.
*
* Both \ref mdbx_env_info_ex() and legacy \ref mdbx_env_info() are inapplicable
* to read-only opened environment.
* Both \ref mdbx_env_set_geometry() and legacy \ref mdbx_env_set_mapsize() are
* inapplicable to read-only opened environment.
*
* Both \ref mdbx_env_info_ex() and legacy \ref mdbx_env_info() could be called
* either before or after \ref mdbx_env_open(), either within the write
* transaction running by current thread or not:
* Both \ref mdbx_env_set_geometry() and legacy \ref mdbx_env_set_mapsize()
* could be called either before or after \ref mdbx_env_open(), either within
* the write transaction running by current thread or not:
*
* - In case \ref mdbx_env_info_ex() or legacy \ref mdbx_env_info() was called
* BEFORE \ref mdbx_env_open(), i.e. for closed environment, then the
* specified parameters will be used for new database creation, or will be
* applied during opening if database exists and no other process using it.
* - In case \ref mdbx_env_set_geometry() or legacy \ref mdbx_env_set_mapsize()
* was called BEFORE \ref mdbx_env_open(), i.e. for closed environment, then
* the specified parameters will be used for new database creation,
* or will be applied during opening if database exists and no other process
* using it.
*
* If the database is already exist, opened with \ref MDBX_EXCLUSIVE or not
* used by any other process, and parameters specified by
@ -2713,20 +2714,20 @@ LIBMDBX_API int mdbx_env_get_fd(const MDBX_env *env, mdbx_filehandle_t *fd);
* silently discarded (open the database with \ref MDBX_EXCLUSIVE flag
* to avoid this).
*
* - In case \ref mdbx_env_info_ex() or legacy \ref mdbx_env_info() was called
* after \ref mdbx_env_open() WITHIN the write transaction running by current
* thread, then specified parameters will be applied as a part of write
* transaction, i.e. will not be visible to any others processes until the
* current write transaction has been committed by the current process.
* - In case \ref mdbx_env_set_geometry() or legacy \ref mdbx_env_set_mapsize()
* was called after \ref mdbx_env_open() WITHIN the write transaction running
* by current thread, then specified parameters will be applied as a part of
* write transaction, i.e. will not be visible to any others processes until
* the current write transaction has been committed by the current process.
* However, if transaction will be aborted, then the database file will be
* reverted to the previous size not immediately, but when a next transaction
* will be committed or when the database will be opened next time.
*
* - In case \ref mdbx_env_info_ex() or legacy \ref mdbx_env_info() was called
* after \ref mdbx_env_open() but OUTSIDE a write transaction, then MDBX will
* execute internal pseudo-transaction to apply new parameters (but only if
* anything has been changed), and changes be visible to any others processes
* immediately after succesful completion of function.
* - In case \ref mdbx_env_set_geometry() or legacy \ref mdbx_env_set_mapsize()
* was called after \ref mdbx_env_open() but OUTSIDE a write transaction,
* then MDBX will execute internal pseudo-transaction to apply new parameters
* (but only if anything has been changed), and changes be visible to any
* others processes immediately after succesful completion of function.
*
* Essentially a concept of "automatic size management" is simple and useful:
* - There are the lower and upper bound of the database file size;