docs: add "sections" info to example bitcoin.conf #15513

pull fanquake wants to merge 1 commits into bitcoin:master from fanquake:rebase-fixup-15387 changing 1 files +27 −0

fanquake commented at 9:36 AM on March 2, 2019: member

Rebased / commit message fixed version of #15387. This had ACKs, but just needed the commit message fixed up.

Most bitcoin.conf options apply to all three networks, however some apply only to mainnet unless specified in a section. As stands, conf file has no indication that sections are now in use or are in some circumstances mandatory (eg, changing rpcport for testnet.)

Proposed change notifies the reader early which options are affected, specifically adds those options affected but not already in the example, adds brief explanation as to what's going on and provides a skeleton template for the sections themselves.

docs: add "sections" info to example bitcoin.conf

Most bitcoin.conf options apply to all three networks,
however some apply only to mainnet unless specified in a section.
As stands, conf file has no indication that sections are now in use
or are in some circumstances mandatory (eg, changing rpcport for testnet.)

Proposed change notifies the reader early which options are affected,
specifically adds those options affected but not already in the example,
adds brief explanation as to what's going on and provides a skeleton template for the sections themselves.

3eac2d57b1

fanquake added the label Docs on Mar 2, 2019
fanquake commented at 9:37 AM on March 2, 2019: member

@laanwj , @jonasschnelli , @luke-jr Could you re-review here.

in share/examples/bitcoin.conf:60 in 3eac2d57b1

  56 | @@ -53,6 +57,9 @@
  57 |  # Listening mode, enabled by default except when 'connect' is being used
  58 |  #listen=1
  59 |  
  60 | +# Port on which to listen for connections (default: 8333, testnet: 18333, regtest: 18444)

laanwj commented at 11:02 AM on March 2, 2019:

would make sense to add this example to one (or multiple) of the sections

practicalswift commented at 10:00 AM on March 3, 2019: contributor

ACK 3eac2d57b1ff563bc9cfe123f6ded2764cc50da0
promag commented at 4:32 PM on March 3, 2019: member

utACK 3eac2d5.
laanwj merged this on Mar 5, 2019
laanwj closed this on Mar 5, 2019
laanwj referenced this in commit 3800ca6068 on Mar 5, 2019
fanquake deleted the branch on Mar 5, 2019
Munkybooty referenced this in commit 6763f03ef9 on Sep 16, 2021
Munkybooty referenced this in commit 54181d1816 on Sep 27, 2021
Munkybooty referenced this in commit 22c85b72fe on Sep 27, 2021
Munkybooty referenced this in commit ae7bb8cb1f on Sep 30, 2021
Munkybooty referenced this in commit b5c4423b58 on Oct 1, 2021
kittywhiskers referenced this in commit 9f703e1f79 on Oct 12, 2021
pravblockc referenced this in commit 06f05ca58d on Nov 18, 2021
DrahtBot locked this on Dec 16, 2021

Contributors

Labels

Linked (view graph)

#15387 docs: add "sections" info to example bitcoin.conf