doc: Extract net permissions doc #19192

pull MarcoFalke wants to merge 1 commits into bitcoin:master from MarcoFalke:2006-docNetPerm changing 3 files +17 −6
  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: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

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

    <!--174a7506f384e20aa4161008e828411d-->

    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. DrahtBot cross-referenced this on Jun 7, 2020 from issue net: Extract download permission from noban by MarcoFalke
  6. DrahtBot cross-referenced this on Jun 7, 2020 from issue refactor: Replace RecursiveMutex with Mutex in Shutdown() by hebasto
  7. DrahtBot cross-referenced this on Jun 7, 2020 from issue refactor: Error message bilingual_str consistency by laanwj
  8. DrahtBot cross-referenced this on Jun 7, 2020 from issue net: Add blockfilters white{bind,list} permission flag by luke-jr
  9. Sjors commented at 10:36 AM on June 8, 2020: member

    tACK faeb4f4fd4ba07063213e5a7fda797b2c53cc29f

  10. Sjors cross-referenced this on Jun 8, 2020 from issue rpc: separate bumpfee's psbt creation function into psbtbumpfee by achow101
  11. doc: Extract net permissions doc fa2c2b50d8
  12. MarcoFalke force-pushed on Jun 8, 2020
  13. MarcoFalke commented at 11:00 AM on June 8, 2020: member

    Rebased to solve merge conflict and reduce diff by +1-1

  14. jonatack commented at 11:12 AM on June 8, 2020: contributor

    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.

  15. 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.

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

    re-utACK fa2c2b50d895ff3402b82ce3db69bfc43053b519

  17. MarcoFalke merged this on Jun 8, 2020
  18. MarcoFalke closed this on Jun 8, 2020

  19. jonatack commented at 11:29 AM on June 8, 2020: contributor

    re-ACK fa2c2b50d895ff3402b82ce3db69bfc43053b519

  20. MarcoFalke deleted the branch on Jun 8, 2020
  21. jonatack cross-referenced this on Jun 8, 2020 from issue doc: -whitelist/-whitebind documentation improvements by jonatack
  22. pinheadmz cross-referenced this on Jul 1, 2020 from issue Cache responses to GETADDR to prevent topology leaks by naumenkogs
  23. MarcoFalke referenced this in commit 1beb02ae0c on Jan 4, 2021
  24. MarcoFalke referenced this in commit d0c75abb28 on Jan 5, 2021
  25. deadalnix referenced this in commit 630e4f7fd5 on Mar 22, 2021
  26. bitcoin locked this on Feb 15, 2022

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-05-20 06:54 UTC