diff options
| author | josibake <josibake@protonmail.com> | 2021-12-22 17:00:57 +0100 |
|---|---|---|
| committer | josibake <josibake@protonmail.com> | 2022-05-04 20:45:49 +0200 |
| commit | 970b9987ad5bcb72e581c40a7cdd408d94a48c81 (patch) | |
| tree | 812d8163c0ae29f9acc0e175b53c992cd99e179e /contrib | |
| parent | 50635d27b45d125b6264ac2abfbd6a1129c7228f (diff) | |
doc: update devtools, release-process readmes
include running `gen-bitcoin-conf.sh` as part of the release process.
Diffstat (limited to 'contrib')
| -rw-r--r-- | contrib/devtools/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/contrib/devtools/README.md b/contrib/devtools/README.md index 79b0134adc..54b1a85588 100644 --- a/contrib/devtools/README.md +++ b/contrib/devtools/README.md @@ -90,6 +90,21 @@ example: BUILDDIR=$PWD/build contrib/devtools/gen-manpages.py ``` +gen-bitcoin-conf.sh +=================== + +Generates a bitcoin.conf file in `share/examples/` by parsing the output from `bitcoind --help`. This script is run during the +release process to include a bitcoin.conf with the release binaries and can also be run by users to generate a file locally. +When generating a file as part of the release process, make sure to commit the changes after running the script. + +With in-tree builds this tool can be run from any directory within the +repository. To use this tool with out-of-tree builds set `BUILDDIR`. For +example: + +```bash +BUILDDIR=$PWD/build contrib/devtools/gen-bitcoin-conf.sh +``` + security-check.py and test-security-check.py ============================================ |