release-20.2: cli: fix default value in help text of max-disk-temp-storage flag #55055
Conversation
This file contains 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
Previously, in the output of `cockroach start --help`, the
`--max-disk-temp-storage` flag section reported that the default value
for the flag was "0 B".
```
$ cockroach start --help
...
--max-disk-temp-storage bytes
...
(default 0 B)
```
This is inaccurate, as the actual default value is dependent on whether
the store is a disk store or an in-memory store.
To fix this, this patch changes the BytesValue.String() method when the
underlying value is nil. Previously, it would return "0 B", which caused
our flags library to think the value was a non-zero value. By changing
the method to return "<nil>", our flags library recognizes the value as
a zero value, and does not print an incorrect default value for the flag
in our help text.
Release note (cli change): The --help text for --max-disk-temp-storage
now properly reports the default value.
|
This change is |
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.
Backport 1/1 commits from #54853.
/cc @cockroachdb/release
Previously, in the output of
cockroach start --help, the--max-disk-temp-storageflag section reported that the default valuefor the flag was "0 B".
This is inaccurate, as the actual default value is dependent on whether
the store is a disk store or an in-memory store.
To fix this, this patch changes the BytesValue.String() method when the
underlying value is nil. Previously, it would return "0 B", which caused
our flags library to think the value was a non-zero value. By changing
the method to return
"<nil>", our flags library recognizes the value asa zero value, and does not print an incorrect default value for the flag
in our help text.
Release note (cli change): The --help text for --max-disk-temp-storage
now properly reports the default value.