Skip to content

Commit 970b998

Browse files
committed
doc: update devtools, release-process readmes
include running `gen-bitcoin-conf.sh` as part of the release process.
1 parent 50635d2 commit 970b998

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

contrib/devtools/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,21 @@ example:
9090
BUILDDIR=$PWD/build contrib/devtools/gen-manpages.py
9191
```
9292

93+
gen-bitcoin-conf.sh
94+
===================
95+
96+
Generates a bitcoin.conf file in `share/examples/` by parsing the output from `bitcoind --help`. This script is run during the
97+
release process to include a bitcoin.conf with the release binaries and can also be run by users to generate a file locally.
98+
When generating a file as part of the release process, make sure to commit the changes after running the script.
99+
100+
With in-tree builds this tool can be run from any directory within the
101+
repository. To use this tool with out-of-tree builds set `BUILDDIR`. For
102+
example:
103+
104+
```bash
105+
BUILDDIR=$PWD/build contrib/devtools/gen-bitcoin-conf.sh
106+
```
107+
93108
security-check.py and test-security-check.py
94109
============================================
95110

doc/release-process.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Release Process
88
* Update translations see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations).
99
* Update release candidate version in `configure.ac` (`CLIENT_VERSION_RC`).
1010
* Update manpages (after rebuilding the binaries), see [gen-manpages.py](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-manpagespy).
11+
* Update bitcoin.conf and commit, see [gen-bitcoin-conf.sh](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-bitcoin-confsh).
1112

1213
### Before every major and minor release
1314

0 commit comments

Comments
 (0)