mdbx-doc: устранение отложенных недоработок в документации.

This commit is contained in:
Леонид Юрьев (Leonid Yuriev) 2024-04-03 19:05:34 +03:00
parent d603de4a87
commit 1727b697a0
2 changed files with 8 additions and 4 deletions

View File

@ -354,7 +354,7 @@ static MDBX_CXX20_CONSTEXPR void *memcpy(void *dest, const void *src,
static MDBX_CXX20_CONSTEXPR int memcmp(const void *a, const void *b,
size_t bytes) noexcept;
/// \brief Legacy default allocator
/// \brief Legacy allocator
/// but it is recommended to use \ref polymorphic_allocator.
using legacy_allocator = ::std::string::allocator_type;
@ -3681,6 +3681,8 @@ public:
struct LIBMDBX_API_TYPE operate_options {
/// \copydoc MDBX_NOTLS
bool orphan_read_transactions{false};
/// \brief Разрешает вложенные транзакции ценой отключения
/// \ref MDBX_WRITEMAP и увеличением накладных расходов.
bool nested_write_transactions{false};
/// \copydoc MDBX_EXCLUSIVE
bool exclusive{false};

View File

@ -147,7 +147,7 @@
#error MDBX_DPL_PREALLOC_FOR_RADIXSORT must be defined as 0 or 1
#endif /* MDBX_DPL_PREALLOC_FOR_RADIXSORT */
/** Controls dirty pages tracking, spilling and persisting in MDBX_WRITEMAP
/** Controls dirty pages tracking, spilling and persisting in `MDBX_WRITEMAP`
* mode. 0/OFF = Don't track dirty pages at all, don't spill ones, and use
* msync() to persist data. This is by-default on Linux and other systems where
* kernel provides properly LRU tracking and effective flushing on-demand. 1/ON
@ -164,14 +164,16 @@
#error MDBX_AVOID_MSYNC must be defined as 0 or 1
#endif /* MDBX_AVOID_MSYNC */
/** FIXME */
/** Управляет механизмом поддержки разреженных наборов DBI-хендлов для снижения
* накладных расходов при запуске и обработке транзакций. */
#ifndef MDBX_ENABLE_DBI_SPARSE
#define MDBX_ENABLE_DBI_SPARSE 1
#elif !(MDBX_ENABLE_DBI_SPARSE == 0 || MDBX_ENABLE_DBI_SPARSE == 1)
#error MDBX_ENABLE_DBI_SPARSE must be defined as 0 or 1
#endif /* MDBX_ENABLE_DBI_SPARSE */
/** FIXME */
/** Управляет механизмом отложенного освобождения и поддержки пути быстрого
* открытия DBI-хендлов без захвата блокировок. */
#ifndef MDBX_ENABLE_DBI_LOCKFREE
#define MDBX_ENABLE_DBI_LOCKFREE 1
#elif !(MDBX_ENABLE_DBI_LOCKFREE == 0 || MDBX_ENABLE_DBI_LOCKFREE == 1)