Skip to content

Commit

Permalink
Merge bitcoin#15513: docs: add "sections" info to example bitcoin.conf
Browse files Browse the repository at this point in the history
3eac2d5 docs: add "sections" info to example bitcoin.conf (Alistair Mann)

Pull request description:

  Rebased / commit message fixed version of bitcoin#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.

Tree-SHA512: 3331f2cac23d082bda2dcdea7d579360bc464d8e2123d634b810e9ba8edb5162bd62bd86f846b5299a04a3d77636a77e2fd3837c3272b22bc0d9a685d5156062
  • Loading branch information
laanwj committed Mar 5, 2019
2 parents 4b57b7f + 3eac2d5 commit 3800ca6
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions share/examples/bitcoin.conf
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

# Network-related settings:

# Note that if you use testnet or regtest, particularly with the options
# addnode, connect, port, bind, rpcport, rpcbind or wallet, you will also
# want to read "[Sections]" further down.

# Run on the test network instead of the real bitcoin network.
#testnet=0

Expand Down Expand Up @@ -53,6 +57,9 @@
# Listening mode, enabled by default except when 'connect' is being used
#listen=1

# Port on which to listen for connections (default: 8333, testnet: 18333, regtest: 18444)
#port=

# Maximum number of inbound+outbound connections.
#maxconnections=

Expand Down Expand Up @@ -115,6 +122,10 @@

# Wallet options

# Specify where to find wallet, lockfile and logs. If not present, those files will be
# created as new.
#wallet=</path/to/dir>

# Create transactions that have enough fees so they are likely to begin confirmation within n blocks (default: 6).
# This setting is over-ridden by the -paytxfee option.
#txconfirmtarget=n
Expand Down Expand Up @@ -142,3 +153,19 @@

# Minimize to the system tray
#minimizetotray=1

# [Sections]
# Most options apply to mainnet, testnet and regtest.
# If you want to confine an option to just one network, you should add it in the
# relevant section below.
# EXCEPTIONS: The options addnode, connect, port, bind, rpcport, rpcbind and wallet
# only apply to mainnet unless they appear in the appropriate section below.

# Options only for mainnet
[main]

# Options only for testnet
[test]

# Options only for regtest
[regtest]

0 comments on commit 3800ca6

Please sign in to comment.