Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the bitcoin.conf instructions in init.md doc #30153

Closed
epiccurious opened this issue May 22, 2024 · 0 comments · Fixed by #30154
Closed

Improve the bitcoin.conf instructions in init.md doc #30153

epiccurious opened this issue May 22, 2024 · 0 comments · Fixed by #30154

Comments

@epiccurious
Copy link
Contributor

epiccurious commented May 22, 2024

Update the init.md instructions about generating an example bitcoin.conf file.

Additionally, the share/examples/bitcoin.conf placeholder file says to follow the instructions in contrib/devtools/README.md, which was confusing to me since that README talks about many scripts. It would be helpful to point out to the user which section to refer to. (EDIT: removed this change from the PR.)

This issue includes an accompanying PR #30154.

Background

  • Two years ago, share/examples/bitcoin.conf was replaced with a placeholder file. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant