doc: -whitelist/-whitebind documentation improvements #19207

pull jonatack wants to merge 1 commits into bitcoin:master from jonatack:whitelist-whitebind-doc-improvements changing 1 files +4 −4
  1. jonatack commented at 12:30 PM on June 8, 2020: member

    Result:

      -whitebind=<[permissions@]addr>
           Bind to the given address and whitelist the 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.
    
      -whitelist=<[permissions@]IP address or network>
           Whitelist the peers connecting from the given IP address (e.g. 1.2.3.4)
           or CIDR-notated network (e.g. 1.2.3.0/24). Uses the same
           permissions as -whitebind. Can be specified multiple times.
    
  2. fanquake added the label Docs on Jun 8, 2020
  3. fanquake commented at 12:36 PM on June 8, 2020: member

    I think this can just be one commit.

  4. fanquake requested review from MarcoFalke on Jun 8, 2020
  5. MarcoFalke commented at 12:36 PM on June 8, 2020: member

    I liked that it said the whitelist permission are identical to the whitebind ones without repeating them verbosely. Now the user is left wonering whether they differ.

  6. MarcoFalke commented at 12:37 PM on June 8, 2020: member

    @fanquake (bot) I fulfilled your review request in less than a second. Beat that!

  7. doc: improve -whitelist and -whitebind documentation
    - alleviate ambiguity stemming from "whitelist" being both a noun and a verb
    - s/network(e.g./network (e.g./
    - s/CIDR notated/CIDR-notated/
    b6d9d7403c
  8. jonatack force-pushed on Jun 8, 2020
  9. jonatack commented at 12:46 PM on June 8, 2020: member

    Done, removed the last commit and squashed.

  10. DrahtBot commented at 12:08 AM on June 9, 2020: member

    <!--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:

    • #18077 (net: Add NAT-PMP port forwarding support by hebasto)

    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.

  11. amitiuttarwar commented at 12:17 AM on June 9, 2020: contributor

    Now the user is left wonering whether they differ.

    I'm also wondering what the difference is. @jonatack maybe you could add some explanation?

  12. jonatack commented at 5:47 PM on June 22, 2020: member

    There are many open PRs right now, this has no ACKs, and I don't plan to spend further time on this.

  13. jonatack closed this on Jun 22, 2020

  14. DrahtBot 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-04-14 21:14 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me