doc: add maxuploadtarget to bitcoin.conf example #22080

pull jarolrod wants to merge 1 commits into bitcoin:master from jarolrod:maxuploadtarget-example changing 1 files +6 −0

jarolrod commented at 3:29 AM on May 27, 2021: member
picking up #21499, author has stated they can't squash.

This adds the maxuploadtarget option to the bitcoin.conf example file. This is useful for those looking to configure their bandwidth utilization.

Changes from Original PR:
- squash commits
- fix typo in commit message + reword commit message to be more appropriate
- Implement review suggestions (1, 2, 3)
- Fix spacing
DrahtBot added the label Docs on May 27, 2021

in share/examples/bitcoin.conf:74 in 219bbd2f52 outdated

  70 | @@ -71,6 +71,12 @@
  71 |  # configuration option or the addnode RPC, which have a separate limit of 8 connections.
  72 |  #maxconnections=
  73 |  
  74 | +# Maximum upload bandwidth target in MiB per day (e.g. 'maxuploadtarget=1024' is 1 GiB max throughput per day).

theStack commented at 1:16 PM on May 28, 2021:

# Maximum upload bandwidth target in MiB per day (e.g. 'maxuploadtarget=1024' is 1 GiB per day).

nit: The "max throughput" is kind of redundant to the part before the parantheses, but I'm fine with either version.

jonatack commented at 2:10 PM on May 28, 2021:

I agree, drop "max throughput".

jarolrod commented at 5:01 PM on May 28, 2021:

You're right, addressed in 947f973

theStack approved
theStack commented at 1:20 PM on May 28, 2021: member

ACK 219bbd2f52382c1b4720e8a74ded1a20676c3c9c 📝

doc: add maxuploadtarget to bitcoin.conf example

Introduce the maxuploadtarget option to the example bitcoin.conf file. This adds visibility for this option which is useful to those looking to configure bandwidth usage.

947f9734da

in share/examples/bitcoin.conf:76 in 219bbd2f52 outdated

  70 | @@ -71,6 +71,12 @@
  71 |  # configuration option or the addnode RPC, which have a separate limit of 8 connections.
  72 |  #maxconnections=
  73 |  
  74 | +# Maximum upload bandwidth target in MiB per day (e.g. 'maxuploadtarget=1024' is 1 GiB max throughput per day).
  75 | +# This limits the upload bandwidth for those with bandwidth limits. 0 = no limit (default: 0).
  76 | +# Limit does not apply to peers with 'download' permission.

jonatack commented at 2:12 PM on May 28, 2021:

s/Limit/This limit/ or (probably better as it is more explicit):

# -maxuploadtarget does not apply to peers with 'download' permission.

jarolrod commented at 5:01 PM on May 28, 2021:

Thanks, addressed in 947f973 by using the -maxuploadtarget suggestion

jarolrod force-pushed on May 28, 2021
jarolrod commented at 5:01 PM on May 28, 2021: member
updated from 219bbd2 -> 947f973 (pr22080.01 -> pr22080.02, diff)

Changes:
- Addressed suggestions (1, 2) from @theStack and @jonatack (thanks!)
jonatack commented at 5:37 PM on May 28, 2021: member

ACK 947f9734daab4e47c0abdc6ef7d52812102ecb6b
theStack approved
theStack commented at 6:00 PM on May 28, 2021: member

re-ACK 947f9734daab4e47c0abdc6ef7d52812102ecb6b
MarcoFalke merged this on May 31, 2021
MarcoFalke closed this on May 31, 2021
sidhujag referenced this in commit 6d84a579a6 on Jun 1, 2021
PastaPastaPasta referenced this in commit ceaaf1955b on Jun 27, 2021
PastaPastaPasta referenced this in commit a154c84ffe on Jun 28, 2021
PastaPastaPasta referenced this in commit 134cb9c269 on Jun 29, 2021
PastaPastaPasta referenced this in commit b3f7a98db7 on Jul 1, 2021
PastaPastaPasta referenced this in commit b5dbbc2418 on Jul 1, 2021
PastaPastaPasta referenced this in commit 509d69a641 on Jul 15, 2021
PastaPastaPasta referenced this in commit d2bf2dd4a1 on Jul 15, 2021
PastaPastaPasta referenced this in commit 8bf157ee80 on Jul 16, 2021
gabriel-bjg referenced this in commit 29cc67e117 on Jul 16, 2021
gwillen referenced this in commit 57dadc1274 on Jun 1, 2022
DrahtBot locked this on Aug 18, 2022

Contributors

Labels

Linked (view graph)

#21499 doc: add maxuploadtarget to bitcoinf.conf example