Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Updated -blocksonly documentation #17305

Closed
wants to merge 1 commit into from
Closed

doc: Updated -blocksonly documentation #17305

wants to merge 1 commit into from

Conversation

birtony
Copy link

@birtony birtony commented Oct 29, 2019

Updated documentation for blocksonly according to #17294.

@fanquake fanquake added the Docs label Oct 29, 2019
src/init.cpp Outdated
@@ -366,7 +366,7 @@ void SetupServerArgs()
gArgs.AddArg("-blocknotify=<cmd>", "Execute command when the best block changes (%s in cmd is replaced by block hash)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
#endif
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);
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);
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);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@DrahtBot
Copy link
Contributor

DrahtBot commented Oct 29, 2019

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

Conflicts

No conflicts as of last run.

@birtony birtony requested a review from maflcko October 29, 2019 21:42
@fanquake
Copy link
Member

@birtony You need to remove any trailing whitespace and squash your commits.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@fanquake
Copy link
Member

No longer up for grabs (#18391).

@bitcoin bitcoin locked as resolved and limited conversation to collaborators Feb 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants