geth/dumpconfig: fix undocumented helptext #26658
Conversation
cmd/geth/config.go
Outdated
| Usage: "Show configuration values", | ||
| ArgsUsage: "", | ||
| Usage: "Export configuration values in a TOML format", | ||
| ArgsUsage: "[dumpfile]", |
There was a problem hiding this comment.
| ArgsUsage: "[dumpfile]", | |
| ArgsUsage: "<dumpfile (optional)>", |
There was a problem hiding this comment.
No need to use <angle brackets(optional)> here since square brackets indicate this arg is optional.
If we use angle brackets for optional args like this, why do we need square brackets?
There was a problem hiding this comment.
since square brackets indicate this arg is optional.
Oh, that is something I did not know. I don't think we've used that way of writing ArgsUsage in other places in go-etherum
There was a problem hiding this comment.
Realized that go-ethereum is using mixed convention...
IMHO, it doesn't seem like a big deal (not confusing), so I will fix my PR if you still prefer angle brackets here.
go-ethereum/cmd/geth/chaincmd.go
Line 109 in 241cf62
go-ethereum/cmd/p2psim/main.go
Line 189 in 241cf62
go-ethereum/cmd/geth/misccmd.go
Line 85 in 241cf62
Line 87 in 241cf62
There was a problem hiding this comment.
I think a lot of users, like me, are not aware of the difference between [foo] and <foo>, so for clarity's sake let's spell it out: <dumpfile (optonal)>
There was a problem hiding this comment.
Could you review #26729 for this?
Github closed this PR automatically when I sync go-ethereum to the HEAD...
This patch documentizes the 'saving into a file' option.
As suggested in #16383, piping dumpconfig's stdout is imcompatible in the Windows powershell due to the UTF16LE encoding.
To fix this, #18327 (428eabe) added an option to save dumpconfig in a file.
However, users never notify this feature (saving into a file) without searching the relevant github issue or seeing source code.
Thus, this patch fixes the aforementioned inconvenience by improving the description of the dumpconfig's help text.
fixes: 428eabe
Signed-off-by: Sungwoo Kim git@sung-woo.kim