From 526e28220a351db2f439793b4a310c8863c123a9 Mon Sep 17 00:00:00 2001 From: "Wladimir J. van der Laan" Date: Wed, 31 Jan 2018 11:22:42 +0100 Subject: [PATCH] contrib: Add support for out-of-tree builds in gen-manpages.sh This adds support for setting the environment variable `BUILDDIR` to point to executables that are outside the source directory. E.g. to invoke the tool when the build is in $PWD/build: ```bash BUILDDIR=$PWD/build contrib/devtools/gen-manpages.sh ``` --- contrib/devtools/README.md | 8 ++++++++ contrib/devtools/gen-manpages.sh | 12 +++++++----- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/contrib/devtools/README.md b/contrib/devtools/README.md index 67c5e15a1..8ca8fa906 100644 --- a/contrib/devtools/README.md +++ b/contrib/devtools/README.md @@ -85,6 +85,14 @@ gen-manpages.sh 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/ +With in-tree builds this tool can be run from any directory within the +repostitory. To use this tool with out-of-tree builds set `BUILDDIR`. For +example: + +```bash +BUILDDIR=$PWD/build contrib/devtools/gen-manpages.sh +``` + git-subtree-check.sh ==================== diff --git a/contrib/devtools/gen-manpages.sh b/contrib/devtools/gen-manpages.sh index 925d6a625..27c80548c 100755 --- a/contrib/devtools/gen-manpages.sh +++ b/contrib/devtools/gen-manpages.sh @@ -1,13 +1,15 @@ #!/bin/bash TOPDIR=${TOPDIR:-$(git rev-parse --show-toplevel)} -SRCDIR=${SRCDIR:-$TOPDIR/src} +BUILDDIR=${BUILDDIR:-$TOPDIR} + +BINDIR=${BINDIR:-$BUILDDIR/src} MANDIR=${MANDIR:-$TOPDIR/doc/man} -BITCOIND=${BITCOIND:-$SRCDIR/bitcoind} -BITCOINCLI=${BITCOINCLI:-$SRCDIR/bitcoin-cli} -BITCOINTX=${BITCOINTX:-$SRCDIR/bitcoin-tx} -BITCOINQT=${BITCOINQT:-$SRCDIR/qt/bitcoin-qt} +BITCOIND=${BITCOIND:-$BINDIR/bitcoind} +BITCOINCLI=${BITCOINCLI:-$BINDIR/bitcoin-cli} +BITCOINTX=${BITCOINTX:-$BINDIR/bitcoin-tx} +BITCOINQT=${BITCOINQT:-$BINDIR/qt/bitcoin-qt} [ ! -x $BITCOIND ] && echo "$BITCOIND not found or not executable." && exit 1