Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documented pathfinding configuration defaults: #4409

Merged
merged 3 commits into from
Feb 8, 2023
Merged

Update documented pathfinding configuration defaults: #4409

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
12e47e5
Update documented pathfinding configuration defaults:
ximinez Feb 3, 2023
fafb3e9
Merge remote-tracking branch 'upstream/develop' into default-pf-cfg
ximinez Feb 6, 2023
ae95e38
Merge remote-tracking branch 'upstream/develop' into default-pf-cfg
ximinez Feb 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions cfg/rippled-example.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -758,7 +758,9 @@
# When searching for paths, the default search aggressiveness. This can take
# exponentially more resources as the size is increased.
#
# The default is: 7
# The recommended value to support advanced pathfinding is: 7
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why though?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not aware of anything special about 7 other than the fact that it worked well for many years, and is a balance between being unable to find an acceptable path vs. resource consumption. @ximinez @JoelKatz any thoughts to share here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep. That's pretty much it. I kind of intentionally left it vague because anybody who doesn't specifically want pathfinding will be just fine with the defaults, and anyone who does probably just wants a reasonable recommendation. If they are more advanced than that, then any "tl;dr" summary in the config file is going to be insufficient - those users should dig into the code or other documentation.

#
# The default is: 2
#
# [path_search_fast]
# [path_search_max]
Expand All @@ -767,12 +769,19 @@
# If you do not need pathfinding, you can set path_search_max to zero to
# disable it and avoid some expensive bookkeeping.
#
# The default for 'path_search_fast' is 2. The default for 'path_search_max' is 10.
# To support advanced pathfinding the recommended value for
# 'path_search_fast' is 2, and for 'path_search_max' is 10.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why?

#
# The default for 'path_search_fast' is 2. The default for 'path_search_max' is 3.
#
# [path_search_old]
#
# For clients that use the legacy path finding interfaces, the search
# aggressiveness to use. The default is 7.
# aggressiveness to use.
#
# The recommended value to support advanced pathfinding is: 7.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why?

#
# The default is: 2
#
#
#
Expand Down