doc: BaseIndex sync behavior with empty datadir

Make a note about a potentially confusing behavior with `BaseIndex::m_synced`;
if the user starts bitcoind with an empty datadir and an index enabled,
BaseIndex will consider itself synced (as a degenerate case). This affects
how indices are built during IBD (relying solely on BlockConnected signals vs.
using ThreadSync()).

1 files changed, 4 insertions, 0 deletions

diff --git a/src/index/base.cpp b/src/index/base.cpp
index 323547900d..d19f1b231e 100644
--- a/src/index/base.cpp
+++ b/src/index/base.cpp
@@ -69,6 +69,10 @@ bool BaseIndex::Init()
     } else {
         SetBestBlockIndex(m_chainstate->FindForkInGlobalIndex(locator));
     }
+
+    // Note: this will latch to true immediately if the user starts up with an empty
+    // datadir and an index enabled. If this is the case, indexation will happen solely
+    // via `BlockConnected` signals until, possibly, the next restart.
     m_synced = m_best_block_index.load() == active_chain.Tip();
     if (!m_synced) {
         bool prune_violation = false;