doc: Extract net permissions doc #19192

1. 
   MarcoFalke commented at 5:20 pm on June 6, 2020: member

   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.
2. MarcoFalke added the label Docs on Jun 6, 2020
3. 
   MarcoFalke commented at 5:25 pm on June 6, 2020: member

   Can be tested by calling ./contrib/devtools/gen-manpages.sh before and after and observing the difference.
4. 
   DrahtBot commented at 1:13 am on June 7, 2020: member

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

   Conflicts

   Reviewers, this pull request conflicts with the following ones:

   • #19191 (net: Extract download permission from noban by MarcoFalke)
   • #19180 (refactor: Replace RecursiveMutex with Mutex in Shutdown() by hebasto)
   • #19176 (refactor: Error message bilingual_str consistency by laanwj)
   • #18972 (WIP: net: Add blockfilters white{bind,list} permission flag by luke-jr)

   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.

5. 
   Sjors commented at 10:36 am on June 8, 2020: member

   tACK faeb4f4fd4ba07063213e5a7fda797b2c53cc29f
6. doc: Extract net permissions doc fa2c2b50d8
7. MarcoFalke force-pushed on Jun 8, 2020
8. 
   MarcoFalke commented at 11:00 am on June 8, 2020: member

   Rebased to solve merge conflict and reduce diff by +1-1
9. 
   jonatack commented at 11:12 am on June 8, 2020: member

   ACK faeb4f4fd4ba07063213e5a7fda797b2c53cc29f

    0$ bitcoind -regtest -h | grep -A8 whitebind
    1  -whitebind=<[permissions@]addr>
    2       Bind to given address and whitelist peers connecting to it. Use
    3       [host]:port notation for IPv6. Allowed permissions: bloomfilter
    4       (allow requesting BIP37 filtered blocks and transactions), noban
    5       (do not ban for misbehavior), forcerelay (relay transactions that
    6       are already in the mempool; implies relay), relay (relay even in
    7       -blocksonly mode), mempool (allow requesting BIP35 mempool
    8       contents). Specify multiple permissions separated by commas
    9       (default: noban,mempool,relay). Can be specified multiple times.
   10--
   

   It might be helpful to append an example at the end of the help.

10. 
    MarcoFalke commented at 11:26 am on June 8, 2020: member

    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 -whitebind=<[permissions@]addr>, with the (default: noban,mempool,relay) already serve as a good example.

11. 
    Sjors commented at 11:26 am on June 8, 2020: member

    re-utACK fa2c2b50d895ff3402b82ce3db69bfc43053b519
12. MarcoFalke merged this on Jun 8, 2020
13. MarcoFalke closed this on Jun 8, 2020

    ---

14. 
    jonatack commented at 11:29 am on June 8, 2020: member

    re-ACK fa2c2b50d895ff3402b82ce3db69bfc43053b519
15. MarcoFalke deleted the branch on Jun 8, 2020
16. MarcoFalke referenced this in commit 1beb02ae0c on Jan 4, 2021
17. MarcoFalke referenced this in commit d0c75abb28 on Jan 5, 2021
18. deadalnix referenced this in commit 630e4f7fd5 on Mar 22, 2021
19. DrahtBot locked this on Feb 15, 2022

Contributors
MarcoFalke DrahtBot Sjors jonatack

Labels
Docs