util: Make -help more Unix and grep friendly#17841
util: Make -help more Unix and grep friendly#17841cvengler wants to merge 1 commit intobitcoin:masterfrom
Conversation
|
Why are your vscode settings part of this pull request? |
7a6888d to
8da847e
Compare
I accidentally added them. Removed it |
|
Concept -0.
I disagree that this PR makes the --help output more readable than master.
If you'd like more context when grepping, you can pass src/bitcoind -help | grep rpccookiefile
-rpccookiefile=<loc>src/bitcoind -help | grep -A2 rpccookiefile
-rpccookiefile=<loc>
Location of the auth cookie. Relative paths will be prefixed by a
net-specific datadir location. (default: data dir)You need to fix all the unit tests that are failing. You should always be running the unit tests, and fixing all issues before opening a PR ( This PR (8da847e): -upgradewallet Upgrade wallet to latest format on
startup
-wallet=<path> Specify wallet database path. Can be
specified multiple times to load
multiple wallets. Path is interpreted
relative to <walletdir> if it is not
absolute, and will be created if it
does not exist (as a directory
containing a wallet.dat file and log
files). For backwards compatibility
this will also accept names of
existing data files in <walletdir>.)
-walletbroadcast Make the wallet broadcast
transactions (default: 1) master (35fff5b): -upgradewallet
Upgrade wallet to latest format on startup
-wallet=<path>
Specify wallet database path. Can be specified multiple times to load
multiple wallets. Path is interpreted relative to <walletdir> if
it is not absolute, and will be created if it does not exist (as
a directory containing a wallet.dat file and log files). For
backwards compatibility this will also accept names of existing
data files in <walletdir>.)
-walletbroadcast
Make the wallet broadcast transactions (default: 1) |
|
This breaks gen-manpages.sh, no? |
|
And why keep windows different? If the motivation is to make it grep friendly then I agree with @fanquake. |
|
Meh. Also ~0 on this, "ugly" is a matter of taste and doesn't really have a place in these kind of arguments. I prefer the current syntax instead of columnar view. As for grep-ability yea this will get you the first line, which isn't super useful. What I generally do is |
|
-0.001 Not worth the change, additional code. |
|
-0.1, unneeded and non-issue, grepping with -A/B/C flags works well. |
|
Lost motivation on this PR as it isn’t a real issue currently. |
This does not affect the Windows platform
The current
--helpoverview is ugly and pretty uncommon for the GNU (and probably unix userland).The biggest difference is that at Bitcoin Cores approach, there is a new line after every command. This isn't really friendly when using grep to get more informations about a command. Honestly IMO the current help page looks from its format more like a man rather than a help page.
As an example:
Current:
This PR:
It also adds a limit of 41 characters per arg name. That's why I also changed the parameter description of
-whitelist