Consistent use of arity annotation in CLI options: RPC, P2P #9549
+33
−67
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.
PR description
Introduce consistency of PicoCLI annotations. Inspired by this PR attempting to make sense of booleans in the besu docs: hyperledger/besu-docs#1890
PicoCLI default arity info https://picocli.info/#_default_arity
for booleans, default arity is 0..1
for everything else, default arity is 1 - so you only need to specify arity if it is != 1
So this PR
removes arity = 1 from boolean options and ensures they have a semantically sensible fallback value--p2p-enabled truebut instead would require--p2p-enabled=trueso reverted those changes.Note this PR does not address all instances of this, but if there is agreement on this approach we can roll it out across all options classes.
Fixed Issue(s)
Thanks for sending a pull request! Have you done the following?
doc-change-requiredlabel to this PR if updates are required.Locally, you can run these tests to catch failures early:
./gradlew spotlessApply./gradlew build./gradlew acceptanceTest./gradlew integrationTest./gradlew ethereum:referenceTests:referenceTests