docs: Document [peers_in_max] and [peers_out_max] in the example config - #7956
Open
pete-csyn wants to merge 1 commit into
Open
docs: Document [peers_in_max] and [peers_out_max] in the example config#7956pete-csyn wants to merge 1 commit into
pete-csyn wants to merge 1 commit into
Conversation
These two settings were added in XRPLF#3616 and have never appeared in the example config, so the only way to learn they exist -- or what they accept -- is to read Config.cpp. The undocumented behaviour most likely to cost an operator time is that they must be configured as a pair. Setting only one throws at startup ("Both sections [peers_in_max] and [peers_out_max] must be configured"), which is a natural thing to trip over when trying to bound inbound connections alone. The valid ranges differ between the two, and both are silently ignored when [peers_max] is present. Documents the pair, the ranges, the both-or-neither requirement, and the [peers_max] precedence, following the existing style of the surrounding stanzas. Comment only -- no behaviour change.
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.
High Level Overview of Change
Documents
[peers_in_max]and[peers_out_max]incfg/xrpld-example.cfg. Commentonly — no behaviour change.
Context of Change
Both settings were added in #3616, which didn't touch a config file, so they have
never appeared in the example config. Today the only way to learn they exist — or
what they accept — is to read
Config.cpp.The behaviour most likely to cost someone time is that they must be set as a
pair. Configuring only one throws at startup:
which is easy to hit when trying to bound inbound connections alone. The valid
ranges also differ between the two (
peers_in_max0–1000,peers_out_max10–1000),and both are ignored when
[peers_max]is present.This documents the pair, the ranges, the both-or-neither requirement, and the
precedence, following the style of the surrounding stanzas. Verified against
src/xrpld/core/detail/Config.cppondevelop.API Impact
libxrplchange (any change that may affectlibxrplor dependents oflibxrpl)None — this changes only comments in the example config.