doc: Extract net permissions doc #19192
Conversation
|
Can be tested by calling |
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsReviewers, this pull request conflicts with the following ones:
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. |
|
tACK faeb4f4fd4ba07063213e5a7fda797b2c53cc29f |
|
Rebased to solve merge conflict and reduce diff by +1-1 |
jonatack
left a comment
There was a problem hiding this comment.
ACK faeb4f4fd4ba07063213e5a7fda797b2c53cc29f
$ bitcoind -regtest -h | grep -A8 whitebind
-whitebind=<[permissions@]addr>
Bind to given address and whitelist peers connecting to it. Use
[host]:port notation for IPv6. Allowed permissions: bloomfilter
(allow requesting BIP37 filtered blocks and transactions), noban
(do not ban for misbehavior), forcerelay (relay transactions that
are already in the mempool; implies relay), relay (relay even in
-blocksonly mode), mempool (allow requesting BIP35 mempool
contents). Specify multiple permissions separated by commas
(default: noban,mempool,relay). Can be specified multiple times.
--
It might be helpful to append an example at the end of the help.
I'll keep it as is for now to minimize the rendered diff. If deemed important, this can be done in a follow-up, but I think |
|
re-utACK fa2c2b5 |
|
re-ACK fa2c2b5 |
Github-Pull: bitcoin#19192 Rebased-From: fa2c2b5
Summary: ``` Moving the documentation of each flag form the already over-large init.cpp into the net permissions module should clean up the code a bit. Moreover, making the documentation available is also required for an (currently imaginary) setnetpermissions RPC. ``` Backport of [[bitcoin/bitcoin#19192 | core#19192]]. Test Plan: bitcoind -help Check the -whitebind option is unchanged. Reviewers: #bitcoin_abc, majcosta Reviewed By: #bitcoin_abc, majcosta Differential Revision: https://reviews.bitcoinabc.org/D9325
Moving the documentation of each flag form the already over-large init.cpp into the net permissions module should clean up the code a bit. Moreover, making the documentation available is also required for an (currently imaginary)
setnetpermissionsRPC.