mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-22 23:07:59 +01:00
Code Issues Projects Releases Wiki Activity

contrib: fix BUILDDIR in gen-bitcoin-conf script and gen-manpages.py

Browse source 
the cmake build steps suggest a build/ directory, which breaks these
scripts. Additionally, in-tree builds are no longer allowed, so it makes
sense to update the code and the README accordingly.
This commit is contained in:
jurraca 2025-01-27 20:12:59 +00:00
parent 0a931a9787
commit 63a8791e15
3 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
contrib/devtools/README.md
View file

@ -82,12 +82,12 @@ gen-manpages.py
A small script to automatically create manpages in ../../doc/man by running the release binaries with the -help option. A small script to automatically create manpages in ../../doc/man by running the release binaries with the -help option.
This requires help2man which can be found at: https://www.gnu.org/software/help2man/ This requires help2man which can be found at: https://www.gnu.org/software/help2man/
With in-tree builds this tool can be run from any directory within the This script assumes a build directory named `build` as suggested by example build documentation.
repository. To use this tool with out-of-tree builds set `BUILDDIR`. For To use it with a different build directory, set `BUILDDIR`.
example: For example:
```bash ```bash
BUILDDIR=$PWD/build contrib/devtools/gen-manpages.py BUILDDIR=$PWD/my-build-dir contrib/devtools/gen-manpages.py
``` ```
headerssync-params.py headerssync-params.py
@ -107,12 +107,12 @@ Generates a bitcoin.conf file in `share/examples/` by parsing the output from `b
release process to include a bitcoin.conf with the release binaries and can also be run by users to generate a file locally. 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. 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 This script assumes a build directory named `build` as suggested by example build documentation.
repository. To use this tool with out-of-tree builds set `BUILDDIR`. For To use it with a different build directory, set `BUILDDIR`.
example: For example:
```bash ```bash
BUILDDIR=$PWD/build contrib/devtools/gen-bitcoin-conf.sh BUILDDIR=$PWD/my-build-dir contrib/devtools/gen-bitcoin-conf.sh
``` ```
security-check.py and test-security-check.py security-check.py and test-security-check.py

2
contrib/devtools/gen-bitcoin-conf.sh
View file

@ -5,7 +5,7 @@
export LC_ALL=C export LC_ALL=C
TOPDIR=${TOPDIR:-$(git rev-parse --show-toplevel)} TOPDIR=${TOPDIR:-$(git rev-parse --show-toplevel)}
BUILDDIR=${BUILDDIR:-$TOPDIR} BUILDDIR=${BUILDDIR:-$TOPDIR/build}
BINDIR=${BINDIR:-$BUILDDIR/src} BINDIR=${BINDIR:-$BUILDDIR/src}
BITCOIND=${BITCOIND:-$BINDIR/bitcoind} BITCOIND=${BITCOIND:-$BINDIR/bitcoind}
SHARE_EXAMPLES_DIR=${SHARE_EXAMPLES_DIR:-$TOPDIR/share/examples} SHARE_EXAMPLES_DIR=${SHARE_EXAMPLES_DIR:-$TOPDIR/share/examples}

2
contrib/devtools/gen-manpages.py
View file

@ -40,7 +40,7 @@ if not topdir:
topdir = r.stdout.rstrip() topdir = r.stdout.rstrip()
# Get input and output directories. # Get input and output directories.
builddir = os.getenv('BUILDDIR', topdir) builddir = os.getenv('BUILDDIR', os.path.join(topdir, 'build'))
mandir = os.getenv('MANDIR', os.path.join(topdir, 'doc/man')) mandir = os.getenv('MANDIR', os.path.join(topdir, 'doc/man'))
# Verify that all the required binaries are usable, and extract copyright # Verify that all the required binaries are usable, and extract copyright