Skip to content

Commit a937458

Browse files
committed
Merge bitcoin/bitcoin#30154: doc: update mention of generating bitcoin.conf
9013e2b Link to gen-bitcoin-conf.sh instead of bitcoin.conf placeholder (Epic Curious) Pull request description: Closes #30153. This PR updates `doc/init.md` to mention generating an example bitcoin.conf instead of referencing the placeholder `share/examples/bitcoin.conf`. Also changes the code-formatted text to a markdown link. ## Background - Two years ago, `share/examples/bitcoin.conf` was replaced with [a placeholder file](bitcoin/bitcoin@b483084). To see an example `bitcoin.conf`, the user now runs the `contrib/devtools/gen-bitcoin-conf.sh` script, which replaces the placeholder file with the parsed contents of `bitcoind --help`. - The instructions in `init.md` about an example `bitcoin.conf` haven't changed significantly since they were [added almost 10 years ago](https://github.com/bitcoin/bitcoin/blame/234bfbf6a5fcba37e510e9cb6c1f2a629cd0290e/doc/init.md#L39). They should be updated to improve clarity. ACKs for top commit: edilmedeiros: ACK 9013e2b kevkevinpal: reACK [9013e2b](bitcoin/bitcoin@9013e2b) achow101: ACK 9013e2b stickies-v: ACK 9013e2b tdb3: ACK for 9013e2b Tree-SHA512: 5ac5ad672ad181d574e19e29c3727fb9e5373282444fae09b42d113d5c8915cb2829d496212638cdc4b70540b7e1794a751fcdc9539f956a594cddd70c8fd747
2 parents e54c392 + 9013e2b commit a937458

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/init.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ This allows for running bitcoind without having to do any manual configuration.
4343
`conf`, `pid`, and `wallet` accept relative paths which are interpreted as
4444
relative to the data directory. `wallet` *only* supports relative paths.
4545

46-
For an example configuration file that describes the configuration settings,
47-
see `share/examples/bitcoin.conf`.
46+
To generate an example configuration file that describes the configuration settings,
47+
see [contrib/devtools/README.md](../contrib/devtools/README.md#gen-bitcoin-confsh).
4848

4949
Paths
5050
---------------------------------

0 commit comments

Comments
 (0)