From 12d2879a9fa3561391702e7641345788202694f1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=9B=D0=B5=D0=BE=D0=BD=D0=B8=D0=B4=20=D0=AE=D1=80=D1=8C?=
 =?UTF-8?q?=D0=B5=D0=B2=20=28Leonid=20Yuriev=29?= <leo@yuriev.ru>
Date: Sat, 9 Jul 2022 19:40:09 +0300
Subject: [PATCH] mdbx: extend descriptions for `MDBX_VALIDATION` and update
 TODO for done item.

---
 TODO.md | 6 +++++-
 mdbx.h  | 6 +++++-
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/TODO.md b/TODO.md
index 79c4e54d..db853653 100644
--- a/TODO.md
+++ b/TODO.md
@@ -12,7 +12,6 @@ For the same reason ~~Github~~ is blacklisted forever.
 So currently most of the links are broken due to noted malicious ~~Github~~ sabotage.
 
  - [Engage an "overlapped I/O" on Windows](https://web.archive.org/web/20220414235959/https://github.com/erthink/libmdbx/issues/224).
- - [Simple careful mode for working with corrupted DB](https://web.archive.org/web/20220414235959/https://github.com/erthink/libmdbx/issues/223).
  - [Move most of `mdbx_chk` functional to the library API](https://web.archive.org/web/20220414235959/https://github.com/erthink/libmdbx/issues/204).
  - [Replace SRW-lock on Windows to allow shrink DB with `MDBX_NOTLS` option](https://web.archive.org/web/20220414235959/https://github.com/erthink/libmdbx/issues/210).
  - [More flexible support of asynchronous runtime/framework(s)](https://web.archive.org/web/20220414235959/https://github.com/erthink/libmdbx/issues/200).
@@ -23,3 +22,8 @@ So currently most of the links are broken due to noted malicious ~~Github~~ sabo
  - [Support MessagePack for Keys & Values](https://web.archive.org/web/20220414235959/https://github.com/erthink/libmdbx/issues/115).
  - [Engage new terminology](https://web.archive.org/web/20220414235959/https://github.com/erthink/libmdbx/issues/137).
  - Packages for [Astra Linux](https://astralinux.ru/), [ALT Linux](https://www.altlinux.org/), [ROSA Linux](https://www.rosalinux.ru/), etc.
+
+Done
+----
+
+ - [Simple careful mode for working with corrupted DB](https://web.archive.org/web/20220414235959/https://github.com/erthink/libmdbx/issues/223).
diff --git a/mdbx.h b/mdbx.h
index edc9fa02..3d13751b 100644
--- a/mdbx.h
+++ b/mdbx.h
@@ -1023,7 +1023,11 @@ LIBMDBX_API void mdbx_assert_fail(const MDBX_env *env, const char *msg,
 enum MDBX_env_flags_t {
   MDBX_ENV_DEFAULTS = 0,
 
-  /** Extra validation of DB structure and pages content. */
+  /** Extra validation of DB structure and pages content.
+   *
+   * The `MDBX_VALIDATION` enabled the simple safe/careful mode for working
+   * with damaged or untrusted DB. However, a notable performance
+   * degradation should be expected. */
   MDBX_VALIDATION = UINT32_C(0x00002000),
 
   /** No environment directory.