doc: block-relay-only vs blocksonly #18464

pull MarcoFalke wants to merge 1 commits into bitcoin:master from MarcoFalke:2003-docBlockRelayOnly changing 2 files +5 −3
  1. MarcoFalke commented at 12:38 pm on March 29, 2020: member
    Those are different concepts, see https://github.com/bitcoin/bitcoin/blob/master/doc/release-notes/release-notes-0.19.0.1.md#p2p-changes for the block-relay-only nodes.
  2. fanquake added the label Docs on Mar 29, 2020
  3. in doc/reduce-traffic.md:8 in fa7547575e outdated 
    5@@ -6,7 +6,7 @@ Some node operators need to deal with bandwidth caps imposed by their ISPs.
6 By default, Bitcoin Core allows up to 125 connections to different peers, 10 of
7 which are outbound. You can therefore, have at most 115 inbound connections.
8 Of the 10 outbound peers, there can be 8 full outgoing connections and 2 with
    jonatack commented at 1:28 pm on March 29, 2020:
    suggest s/full outgoing/full-relay/ as the sentence already stated that these are outbound and the codebase (net.h/net.cpp/net_processing.cpp) and debug log call them full-relay
    MarcoFalke commented at 1:48 pm on March 29, 2020:
    Fixed both occurrences
  4. in doc/reduce-memory.md:28 in fa7547575e outdated 
    23@@ -24,7 +24,9 @@ The size of some in-memory caches can be reduced. As caches trade off memory usa
24 
25 ## Number of peers
26 
27-- `-maxconnections=<n>` - the maximum number of connections, this defaults to `125`. Each active connection takes up some memory. Only significant if incoming connections are enabled, otherwise the number of connections will never be more than `10`. Of the 10 outbound peers, there can be 8 full outgoing connections and 2 -blocksonly peers, in which case they are block/addr peers, but not tx peers.
28+- `-maxconnections=<n>` - the maximum number of connections, this defaults to `125`. Each active connection takes up
29+  some memory. Only significant if incoming connections are enabled, otherwise the number of connections will never be
    jonatack commented at 1:33 pm on March 29, 2020:

    suggest clarifying with s/Only significant/This option applies only/ or something similar

    (as is, it reads almost like the memory use is only significant if…)

  5. in doc/reduce-memory.md:29 in fa7547575e outdated 
    23@@ -24,7 +24,9 @@ The size of some in-memory caches can be reduced. As caches trade off memory usa
24 
25 ## Number of peers
26 
27-- `-maxconnections=<n>` - the maximum number of connections, this defaults to `125`. Each active connection takes up some memory. Only significant if incoming connections are enabled, otherwise the number of connections will never be more than `10`. Of the 10 outbound peers, there can be 8 full outgoing connections and 2 -blocksonly peers, in which case they are block/addr peers, but not tx peers.
28+- `-maxconnections=<n>` - the maximum number of connections, this defaults to `125`. Each active connection takes up
29+  some memory. Only significant if incoming connections are enabled, otherwise the number of connections will never be
30+  more than `10`. Of the 10 outbound peers, there can be 8 full outgoing connections and 2 block-relay-only peers.
    jonatack commented at 1:33 pm on March 29, 2020:
    not sure why 125 and 10 are enclosed with code markup
  6. jonatack commented at 1:36 pm on March 29, 2020: member
    ACK with a few additional suggestions
  7. MarcoFalke force-pushed on Mar 29, 2020
  8. MarcoFalke commented at 1:48 pm on March 29, 2020: member
    Addressed feedback by @jonatack
  9. jonatack commented at 1:56 pm on March 29, 2020: member
    ACK fae5d88
  10. in doc/reduce-memory.md:29 in fae5d88fc3 outdated 
    23@@ -24,7 +24,9 @@ The size of some in-memory caches can be reduced. As caches trade off memory usa
24 
25 ## Number of peers
26 
27-- `-maxconnections=<n>` - the maximum number of connections, this defaults to `125`. Each active connection takes up some memory. Only significant if incoming connections are enabled, otherwise the number of connections will never be more than `10`. Of the 10 outbound peers, there can be 8 full outgoing connections and 2 -blocksonly peers, in which case they are block/addr peers, but not tx peers.
28+- `-maxconnections=<n>` - the maximum number of connections, this defaults to 125. Each active connection takes up some
29+  memory. This option applies only if incoming connections are enabled, otherwise the number of connections will never
30+  be more than 10. Of the 10 outbound peers, there can be 8 full-relay connections and 2 block-relay-only peers.
    hebasto commented at 12:31 pm on March 30, 2020: 
    0  be more than 10. Of the 10 outbound peers, there can be 8 full-relay connections and 2 block-relay-only ones.
    jonatack commented at 1:51 pm on March 30, 2020:
    Agree, this is better.
  11. in doc/reduce-traffic.md:9 in fae5d88fc3 outdated 
     4@@ -5,8 +5,8 @@ Some node operators need to deal with bandwidth caps imposed by their ISPs.
 5 
 6 By default, Bitcoin Core allows up to 125 connections to different peers, 10 of
 7 which are outbound. You can therefore, have at most 115 inbound connections.
 8-Of the 10 outbound peers, there can be 8 full outgoing connections and 2 with
 9-the -blocksonly mode turned on. You can therefore, have at most 115 inbound connections.
10+Of the 10 outbound peers, there can be 8 full-relay connections and 2 with
11+block-relay only.
    hebasto commented at 12:33 pm on March 30, 2020: 
    0Of the 10 outbound peers, there can be 8 full-relay connections and 2
1block-relay-only ones.
  12. hebasto commented at 12:34 pm on March 30, 2020: member
    I assume that “block-relay-only” should be applied to the “connection”, but not to the “peer”.
  13. doc: block-relay-only is not blocksonly 
    Co-Authored-By: Hennadii Stepanov <32963518+hebasto@users.noreply.github.com>
    fa6e01f2a1
  14. MarcoFalke force-pushed on Mar 30, 2020
  15. hebasto approved
  16. hebasto commented at 1:27 pm on March 30, 2020: member
    ACK fa6e01f2a163511a735088895ab02232b150801b
  17. jonatack commented at 1:49 pm on March 30, 2020: member

    ACK fa6e01f

    pico-nit: as the outbound peer connections are called “full-relay” and “block-relay” in the debug log, perhaps use “block-relay” rather than “block-relay-only”. Though the code comments use block-relay-only, the -only seems redundant, though I may be saying that out of habit of seeing “block-relay” in the log.

  18. MarcoFalke merged this on Apr 2, 2020
  19. MarcoFalke closed this on Apr 2, 2020
  20. MarcoFalke deleted the branch on Apr 2, 2020
  21. sidhujag referenced this in commit 5aa95dbb49 on Apr 3, 2020
  22. deadalnix referenced this in commit d5a049238e on Jan 14, 2021
  23. DrahtBot locked this on Feb 15, 2022


MarcoFalke jonatack hebasto

Labels
Docs

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: 2024-12-18 15:12 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me