doc: Updated -blocksonly documentation #17305

pull birtony wants to merge 1 commits into bitcoin:master from birtony:issue#17294 changing 2 files +3 −1

birtony commented at 7:17 PM on October 29, 2019: none

Updated documentation for blocksonly according to #17294.
fanquake added the label Docs on Oct 29, 2019

in src/init.cpp:369 in b83ff53023 outdated

 365 | @@ -366,7 +366,7 @@ void SetupServerArgs()
 366 |      gArgs.AddArg("-blocknotify=<cmd>", "Execute command when the best block changes (%s in cmd is replaced by block hash)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
 367 |  #endif
 368 |      gArgs.AddArg("-blockreconstructionextratxn=<n>", strprintf("Extra transactions to keep in memory for compact block reconstructions (default: %u)", DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
 369 | -    gArgs.AddArg("-blocksonly", strprintf("Whether to reject transactions from network peers. Transactions from the wallet, RPC and relay whitelisted inbound peers are not affected. (default: %u)", DEFAULT_BLOCKSONLY), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
 370 | +    gArgs.AddArg("-blocksonly", strprintf("Whether to reject transactions from network peers. Transactions from the wallet, RPC and relay whitelisted inbound peers are affected. (default: %u)", DEFAULT_BLOCKSONLY), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);

MarcoFalke commented at 7:22 PM on October 29, 2019:

This is not true. It depends on the parameter interaction. I'd rather describe that here.

Also you'd need to update doc/low_bandwith.md or whatever it is called

birtony commented at 7:26 PM on October 29, 2019:

Hey @MarcoFalke, I am sorry for my mistake, and thanks for your comments. Should I put it as the following?

Whether to reject transactions from network peers. Transactions from the wallet, RPC and relay whitelisted inbound peers might be affected depending on the parameter interaction.

birtony commented at 9:42 PM on October 29, 2019:

@MarcoFalke I have made an update which includes your remarks in a333b82. Please, let me know if it is correct?

DrahtBot commented at 8:06 PM on October 29, 2019: member



The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.



Conflicts

No conflicts as of last run.
birtony requested review from MarcoFalke on Oct 29, 2019
fanquake commented at 9:43 PM on October 29, 2019: member

@birtony You need to remove any trailing whitespace and squash your commits.
doc: Updated -blocksonly documentation 90eb11a1ef

in doc/reduce-traffic.md:52 in 90eb11a1ef

  47 | @@ -48,3 +48,5 @@ Be reminded of the effects of this setting.
  48 |    wallet is loaded or if you use the node to broadcast transactions.
  49 |  - It makes block propagation slower because compact block relay can only be
  50 |    used when transaction relay is enabled.
  51 | +- Transactions from the wallet, RPC and relay whitelisted inbound peers 
  52 | +  might be affected depending on the parameter interaction.

MarcoFalke commented at 12:53 AM on October 30, 2019:

As a user reading this, there is no way to extract any useful information. This should exactly explain which parameters can interact.

MarcoFalke added the label Up for grabs on Dec 4, 2019
fanquake closed this on Jan 5, 2020
fanquake commented at 1:53 AM on March 23, 2020: member

No longer up for grabs (#18391).
fanquake removed the label Up for grabs on Mar 23, 2020
DrahtBot locked this on Feb 15, 2022

Contributors

Labels

Linked (view graph)

#17294 code for blocksonly disagrees with documentation

doc: Updated -blocksonly documentation #17305

Conflicts