doc: update reduce-memory.md and bitcoin.conf -maxconnections info #21709

pull jonatack wants to merge 2 commits into bitcoin:master from jonatack:update-reduce-memory-doc changing 2 files +13 −4
  1. jonatack commented at 6:41 PM on April 16, 2021: member

    This patch updates the documentation in doc/reduce-memory.md and share/examples/bitcoin.conf regarding the peer connections limits and -maxconnections

  2. DrahtBot added the label Docs on Apr 16, 2021
  3. ghost commented at 10:21 PM on April 16, 2021: none

    Concept ACK. Will test today.

  4. jonatack renamed this:
    doc: update doc/reduce-memory.md peer connections info
    doc: update reduce-memory.md and bitcoin.conf -maxconnections info
    on Apr 17, 2021
  5. jonatack force-pushed on Apr 17, 2021
  6. jonatack force-pushed on Apr 17, 2021
  7. ghost commented at 5:00 PM on April 17, 2021: none

    ACK

    More details: #21710 (comment)

  8. jonatack force-pushed on Apr 17, 2021
  9. jonatack force-pushed on Apr 17, 2021
  10. in share/examples/bitcoin.conf:69 in 23287c3323 outdated
      62 | @@ -63,7 +63,12 @@
      63 |  # Port on which to listen for connections (default: 8333, testnet: 18333, signet: 38333, regtest: 18444)
      64 |  #port=
      65 |  
      66 | -# Maximum number of inbound+outbound connections.
      67 | +# Maximum number of inbound + outbound connections (default: 125). This option
      68 | +# applies only if inbound connections are enabled, otherwise the number of connections
      69 | +# will not be more than 11 (8 full-relay connections, 2 block-relay-only ones, and
      70 | +# occasionally 1 short-lived feeler or extra outbound block-relay-only connection.
    


    jarolrod commented at 6:03 PM on April 17, 2021:

    missing closing parentheses

    # occasionally 1 short-lived feeler or extra outbound block-relay-only connection).
    

    jonatack commented at 6:10 PM on April 17, 2021:

    Thanks! sorry, was just re-pushing a change. Fixing by replacing the opening one with a colon.

  11. in share/examples/bitcoin.conf:71 in 23287c3323 outdated
      67 | +# Maximum number of inbound + outbound connections (default: 125). This option
      68 | +# applies only if inbound connections are enabled, otherwise the number of connections
      69 | +# will not be more than 11 (8 full-relay connections, 2 block-relay-only ones, and
      70 | +# occasionally 1 short-lived feeler or extra outbound block-relay-only connection.
      71 | +# These limits do not apply to connections added manually with the -addnode
      72 | +# configuration option or the addnode RPC, which have a separate limit of 8 connections.
    


    jarolrod commented at 6:04 PM on April 17, 2021:

    nit?

    # configuration option or the addnode RPC command, which have a separate limit of 8 connections.
    

    jonatack commented at 6:09 PM on April 17, 2021:

    The C in RPC means call, so "command" seems redundant (to me).

  12. in doc/reduce-memory.md:33 in 23287c3323 outdated
      31 | +  memory. This option applies only if inbound connections are enabled, otherwise the number of connections will not
      32 | +  be more than 11. Of the 11 outbound peers, there can be 8 full-relay connections, 2 block-relay-only ones,
      33 | +  and occasionally 1 short-lived feeler or extra outbound block-relay-only connection.
      34 | +
      35 | +- These limits do not apply to connections added manually with the `-addnode` configuration option or
      36 | +  the `addnode` RPC, which have a separate limit of 8 connections.
    


    jarolrod commented at 6:05 PM on April 17, 2021:

    nit?

      the `addnode` RPC command, which have a separate limit of 8 connections.
    

    jonatack commented at 6:11 PM on April 17, 2021:

    (idem)

  13. in doc/reduce-memory.md:28 in 23287c3323 outdated
      23 | @@ -24,9 +24,13 @@ 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
      28 | -  memory. This option applies only if incoming connections are enabled, otherwise the number of connections will never
      29 | -  be more than 10. Of the 10 outbound peers, there can be 8 full-relay connections and 2 block-relay-only ones.
      30 | +- `-maxconnections=<n>` - the maximum number of connections, which defaults to 125. Each active connection takes up some
      31 | +  memory. This option applies only if inbound connections are enabled, otherwise the number of connections will not
    


    jarolrod commented at 6:08 PM on April 17, 2021:
      memory. This option applies only if inbound connections are enabled. Otherwise, the number of connections will not
    

    or

      memory. This option applies only if inbound connections are enabled; otherwise, the number of connections will not
    

    jonatack commented at 6:13 PM on April 17, 2021:

    done (thanks!)

  14. in share/examples/bitcoin.conf:67 in 23287c3323 outdated
      62 | @@ -63,7 +63,12 @@
      63 |  # Port on which to listen for connections (default: 8333, testnet: 18333, signet: 38333, regtest: 18444)
      64 |  #port=
      65 |  
      66 | -# Maximum number of inbound+outbound connections.
      67 | +# Maximum number of inbound + outbound connections (default: 125). This option
      68 | +# applies only if inbound connections are enabled, otherwise the number of connections
    


    jarolrod commented at 6:08 PM on April 17, 2021:
    # applies only if inbound connections are enabled. Otherwise, the number of connections
    

    or

    # applies only if inbound connections are enabled; otherwise, the number of connections
    

    jonatack commented at 6:13 PM on April 17, 2021:

    thanks, semi-colon + comma seems good

  15. jarolrod commented at 6:09 PM on April 17, 2021: member

    concept ACK

  16. doc: update reduce-memory.md peer connections info 926827065f
  17. jonatack force-pushed on Apr 17, 2021
  18. jonatack commented at 6:20 PM on April 17, 2021: member

    Thanks @prayank23 and @jarolrod! Updated.

  19. jarolrod commented at 6:22 PM on April 17, 2021: member

    ACK fe44429dbdd064f5b63b531f5086ad90c4ad417f

  20. doc: update bitcoin.conf maxconnections info 300234ab66
  21. jonatack force-pushed on Apr 17, 2021
  22. jonatack commented at 6:44 PM on April 17, 2021: member

    (@jarolrod, the last push applied your semi-colon/comma feedback to the second commit as well)

  23. jarolrod commented at 12:51 AM on April 18, 2021: member

    re-ACK 300234ab6698277fb261a87be72f89ef94d3697a

  24. unknown approved
  25. DrahtBot commented at 9:32 AM on May 3, 2021: member

    <!--4a62be1de6b64f3ed646cdc7932c8cf5-->

    🕵️ @harding @fanquake have been requested to review this pull request as specified in the REVIEWERS file.

  26. in doc/reduce-memory.md:30 in 300234ab66
      28 | -  memory. This option applies only if incoming connections are enabled, otherwise the number of connections will never
      29 | -  be more than 10. Of the 10 outbound peers, there can be 8 full-relay connections and 2 block-relay-only ones.
      30 | +- `-maxconnections=<n>` - the maximum number of connections, which defaults to 125. Each active connection takes up some
      31 | +  memory. This option applies only if inbound connections are enabled; otherwise, the number of connections will not
      32 | +  be more than 11. Of the 11 outbound peers, there can be 8 full-relay connections, 2 block-relay-only ones,
      33 | +  and occasionally 1 short-lived feeler or extra outbound block-relay-only connection.
    


    laanwj commented at 2:06 PM on May 5, 2021:

    I'm not actually sure all these details are needed for a 'reducing memory usage' document, all in all it was simply intended as suggestion to reduce the number :smile: But of course getting it correct instead of having outdated information here is an improvement.

  27. laanwj commented at 2:10 PM on May 5, 2021: member

    ACK 300234ab6698277fb261a87be72f89ef94d3697a

  28. laanwj merged this on May 5, 2021
  29. laanwj closed this on May 5, 2021

  30. jonatack deleted the branch on May 5, 2021
  31. sidhujag referenced this in commit 2678fd934a on May 5, 2021
  32. PastaPastaPasta referenced this in commit b577d61a24 on Apr 3, 2022
  33. PastaPastaPasta referenced this in commit 58fb52b2c2 on Apr 4, 2022
  34. PastaPastaPasta referenced this in commit 6525ca37a7 on Apr 6, 2022
  35. gwillen referenced this in commit a5a02a17ab on Jun 1, 2022
  36. DrahtBot locked this on Aug 18, 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