docs: Correct config documentation to match code - #8147
Open
xrpl365 wants to merge 1 commit into
Open
Conversation
The example config listed several defaults that no longer match the code, and the rdb README named a config section the code no longer reads. Update the docs to match.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Several documented defaults in
cfg/xrpld-example.cfgno longer match thevalues the code actually uses, and
src/xrpld/app/rdb/README.mddocuments aconfig section name (
[relational_db]) that the code no longer reads (it reads[sqdb]). This PR corrects the documentation to match the code. No behaviorchange: comments and docs only.
Changes
cfg/xrpld-example.cfg(comment-only):compress_level: documented default corrected from3to8.transaction_queue.minimum_txn_in_ledger:5to32.transaction_queue.target_txn_in_ledger:50to256.transaction_queue.minimum_escalation_multiplier:500to128000(the value is expressed in fee levels: base fee level
256times500).node_dbcache_size/cache_age: the documented fixed16384/5 minare stale; when unset, the effective values are derived from
[node_size].src/xrpld/app/rdb/README.md:[relational_db]to[sqdb].How to verify
Each corrected value can be checked against the source:
compress_leveldefaultsrc/libxrpl/server/Port.cpp:309(valueOr(Keys::kCompressLevel, 8))minimum_txn_in_ledgersrc/xrpld/app/misc/TxQ.h:111(minimumTxnInLedger = 32)target_txn_in_ledgersrc/xrpld/app/misc/TxQ.h:121(targetTxnInLedger = 256)minimum_escalation_multipliersrc/xrpld/app/misc/TxQ.h:106(minimumEscalationMultiplier = kBaseLevel * 500, kBaseLevel = 256)cache_size/cache_agesrc/xrpld/app/misc/SHAMapStoreImp.cpp:198-205(usesSizedItem::TreeCacheSize/TreeCacheAgewhen unset)[relational_db][sqdb]src/libxrpl/rdb/SociDB.cpp:55(config.section(Sections::kSqdb))Type of change
docs:documentation only, no functional change.