-
Notifications
You must be signed in to change notification settings - Fork 844
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.
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
Move snapsync-bft-enabled to stable options #7930
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Bhanu Pulluri <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
needs a changelog entry - this will be a breaking change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you'll also want to remove
hidden = true,
so the option shows in the help
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO better to avoid the breaking change and make this an alias and call out the deprecation of the X version, e.g. see
besu/besu/src/main/java/org/hyperledger/besu/cli/options/storage/DiffBasedSubStorageOptions.java
Lines 58 to 69 in 27592b5
// TODO --Xbonsai-limit-trie-logs-enabled and --Xbonsai-trie-log-pruning-enabled are deprecated, | |
// remove in a future release | |
@SuppressWarnings("ExperimentalCliOptionMustBeCorrectlyDisplayed") | |
@Option( | |
names = { | |
LIMIT_TRIE_LOGS_ENABLED, | |
"--Xbonsai-limit-trie-logs-enabled", // deprecated | |
"--Xbonsai-trie-log-pruning-enabled" // deprecated | |
}, | |
fallbackValue = "true", | |
description = "Limit the number of trie logs that are retained. (default: ${DEFAULT-VALUE})") | |
private Boolean limitTrieLogsEnabled = DEFAULT_LIMIT_TRIE_LOGS_ENABLED; |
Then can add entry to changelog under "Upcoming Breaking Changes"
Thanks for the suggestions. So currently I will
|
Yes I think I we should remove the option, not promote it to non-experimental. So I can see the case for making this PR a changelog entry to mark it deprecated, followed by a PR after the next release or two have gone out, which basically reverses the PR I originally added the new flag under. |
PR description
Fixed Issue(s)
#7924