PR #12713 changed the interpretation for negation of non-boolean options (e.g. -noconnect) to no longer set the option to 0, but to remove it from the options.
I think this is better because it gets rid of the special meaning of '0'.
However it needs to be documented. I attempt to do so in this PR. Addresses #14064.
There might be options I missed, please help check:
-connect-proxy-onion-debug-debuglogfileNeeds a manpage update.
Wait, I think I’m misunderstanding this, -connect does still check for “0” explicitly:
0 if (connect.size() != 1 || connect[0] != "0") {
1 connOptions.m_specified_outgoing = connect;
2 }
Is this only for backwards compatibility?
I checked that at least both -noconnect and -connect=0 still work.
Whereas -debuglogfile uses IsArgNegated:
0g_logger->m_print_to_file = !gArgs.IsArgNegated("-debuglogfile");
Tested: -nodebuglogfile works, but -debuglogfile=0 doesn’t. This is the only argument that uses IsArgNegated.
(all in all, this change is still correct, I think)
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.
For all options that are not a file, the existing way of -opt=0 should not be deprecated. You don’t deprecate these here, just mention the other alternative for consistency with -nodebuglogfile, so I guess it it fine.
utACK 9e7ddf97d581b5d7e04193567c60cb4e0cc19401
Note the related commit d5690f1
AHHHHHH okay, really, I don’t know anymore I thought I had puzzled together a consistent picture of what was the idea here but it seems to be moving in all directions at once but yes I forgot about #10085
-noconnect works fine and I use it a lot for internal tests. It’s a little bit more consistent to not mention it explicitly in the help I guess but please don’t say that things don’t work if they do!
I’m even confused at my own behavior there
Edit: as for bitcoin.conf, FWIW it looks like the only way to specify “no debug log” in bitcoin.conf is by adding nodebuglogfile=1, simply nodebuglogfile doesn’t work and is ignored – would be better to throw an error that suggests the syntax to be used, it’s kindof hard to guess (done in #14105)
-nodebuglogfile=0, it would log to file 1.
PR #12713 changed the interpretation for negation of non-boolean options
(e.g. -noconnect) to no longer set the option to 0, but to remove it
from the options.
I think this is better because it gets rid of the special meaning of
'0'.
However it needs to be documented. I attempt to do so in this PR.
Addreses #14064.
So I found a funny result of -nodebuglogfile=0, it would log to file 1.
That’s pretty cute, though I don’t think we want to document that.
Rebased.
399@@ -400,7 +400,7 @@ void SetupServerArgs()
400 gArgs.AddArg("-banscore=<n>", strprintf("Threshold for disconnecting misbehaving peers (default: %u)", DEFAULT_BANSCORE_THRESHOLD), false, OptionsCategory::CONNECTION);
401 gArgs.AddArg("-bantime=<n>", strprintf("Number of seconds to keep misbehaving peers from reconnecting (default: %u)", DEFAULT_MISBEHAVING_BANTIME), false, OptionsCategory::CONNECTION);
402 gArgs.AddArg("-bind=<addr>", "Bind to given address and always listen on it. Use [host]:port notation for IPv6", false, OptionsCategory::CONNECTION);
403- gArgs.AddArg("-connect=<ip>", "Connect only to the specified node; -connect=0 disables automatic connections (the rules for this peer are the same as for -addnode). This option can be specified multiple times to connect to multiple nodes.", false, OptionsCategory::CONNECTION);
404+ gArgs.AddArg("-connect=<ip>", "Connect only to the specified node; -noconnect disables automatic connections (the rules for this peer are the same as for -addnode). This option can be specified multiple times to connect to multiple nodes.", false, OptionsCategory::CONNECTION);
-noconnect or -connect=0 to document that for this option both variants are supposed to work?
connect=0 but still I think it’s good to be consistent in encouraging use of -noX for non-boolean options, not X=0.
413@@ -414,12 +414,12 @@ void SetupServerArgs()
414 gArgs.AddArg("-maxsendbuffer=<n>", strprintf("Maximum per-connection send buffer, <n>*1000 bytes (default: %u)", DEFAULT_MAXSENDBUFFER), false, OptionsCategory::CONNECTION);
415 gArgs.AddArg("-maxtimeadjustment", strprintf("Maximum allowed median peer time offset adjustment. Local perspective of time may be influenced by peers forward or backward by this amount. (default: %u seconds)", DEFAULT_MAX_TIME_ADJUSTMENT), false, OptionsCategory::CONNECTION);
416 gArgs.AddArg("-maxuploadtarget=<n>", strprintf("Tries to keep outbound traffic under the given target (in MiB per 24h), 0 = no limit (default: %d)", DEFAULT_MAX_UPLOAD_TARGET), false, OptionsCategory::CONNECTION);
417- gArgs.AddArg("-onion=<ip:port>", "Use separate SOCKS5 proxy to reach peers via Tor hidden services (default: -proxy)", false, OptionsCategory::CONNECTION);
418+ gArgs.AddArg("-onion=<ip:port>", "Use separate SOCKS5 proxy to reach peers via Tor hidden services, set -noonion to disable (default: -proxy)", false, OptionsCategory::CONNECTION);
419 gArgs.AddArg("-onlynet=<net>", "Make outgoing connections only through network <net> (ipv4, ipv6 or onion). Incoming connections are not affected by this option. This option can be specified multiple times to allow multiple networks.", false, OptionsCategory::CONNECTION);
420 gArgs.AddArg("-peerbloomfilters", strprintf("Support filtering of blocks and transaction with bloom filters (default: %u)", DEFAULT_PEERBLOOMFILTERS), false, OptionsCategory::CONNECTION);
421 gArgs.AddArg("-permitbaremultisig", strprintf("Relay non-P2SH multisig (default: %u)", DEFAULT_PERMIT_BAREMULTISIG), false, OptionsCategory::CONNECTION);
422 gArgs.AddArg("-port=<port>", strprintf("Listen for connections on <port> (default: %u, testnet: %u, regtest: %u)", defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort(), regtestChainParams->GetDefaultPort()), false, OptionsCategory::CONNECTION);
423- gArgs.AddArg("-proxy=<ip:port>", "Connect through SOCKS5 proxy", false, OptionsCategory::CONNECTION);
424+ gArgs.AddArg("-proxy=<ip:port>", "Connect through SOCKS5 proxy, set -noproxy to disable (default: disabled)", false, OptionsCategory::CONNECTION);
466@@ -467,7 +467,7 @@ void SetupServerArgs()
467 gArgs.AddArg("-limitdescendantsize=<n>", strprintf("Do not accept transactions if any ancestor would have more than <n> kilobytes of in-mempool descendants (default: %u).", DEFAULT_DESCENDANT_SIZE_LIMIT), true, OptionsCategory::DEBUG_TEST);
468 gArgs.AddArg("-vbparams=deployment:start:end", "Use given start/end times for specified version bits deployment (regtest-only)", true, OptionsCategory::DEBUG_TEST);
469 gArgs.AddArg("-addrmantest", "Allows to test address relay on localhost", true, OptionsCategory::DEBUG_TEST);
470- gArgs.AddArg("-debug=<category>", strprintf("Output debugging information (default: %u, supplying <category> is optional)", 0) + ". " +
471+ gArgs.AddArg("-debug=<category>", "Output debugging information (default: -nodebug, supplying <category> is optional). "
-nodebug or -debug=0 to document that for this option both variants are supposed to work?
