Merge #12308: contrib: Add support for out-of-tree builds in gen-manpages.sh
526e28220a
contrib: Add support for out-of-tree builds in gen-manpages.sh (Wladimir J. van der Laan)
Pull request description:
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
```
This avoids having to manually copy the generated manpages after they end up in the build instead of source path, when setting TOPDIR instead.
Tree-SHA512: 8dc6dd7a47a0c014ae7d27f0ac9d86f69238ec6bac8a3007b975bb88c9f37014755c716c5e62604dd91baad2f8a41fd1544cdca3ba4b59bc76602e6593f4a4a7
This commit is contained in:
commit
dcfe218626
2 changed files with 15 additions and 5 deletions
|
@ -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.
|
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
|
||||||
|
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
|
git-subtree-check.sh
|
||||||
====================
|
====================
|
||||||
|
|
||||||
|
|
|
@ -1,13 +1,15 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
TOPDIR=${TOPDIR:-$(git rev-parse --show-toplevel)}
|
TOPDIR=${TOPDIR:-$(git rev-parse --show-toplevel)}
|
||||||
SRCDIR=${SRCDIR:-$TOPDIR/src}
|
BUILDDIR=${BUILDDIR:-$TOPDIR}
|
||||||
|
|
||||||
|
BINDIR=${BINDIR:-$BUILDDIR/src}
|
||||||
MANDIR=${MANDIR:-$TOPDIR/doc/man}
|
MANDIR=${MANDIR:-$TOPDIR/doc/man}
|
||||||
|
|
||||||
BITCOIND=${BITCOIND:-$SRCDIR/bitcoind}
|
BITCOIND=${BITCOIND:-$BINDIR/bitcoind}
|
||||||
BITCOINCLI=${BITCOINCLI:-$SRCDIR/bitcoin-cli}
|
BITCOINCLI=${BITCOINCLI:-$BINDIR/bitcoin-cli}
|
||||||
BITCOINTX=${BITCOINTX:-$SRCDIR/bitcoin-tx}
|
BITCOINTX=${BITCOINTX:-$BINDIR/bitcoin-tx}
|
||||||
BITCOINQT=${BITCOINQT:-$SRCDIR/qt/bitcoin-qt}
|
BITCOINQT=${BITCOINQT:-$BINDIR/qt/bitcoin-qt}
|
||||||
|
|
||||||
[ ! -x $BITCOIND ] && echo "$BITCOIND not found or not executable." && exit 1
|
[ ! -x $BITCOIND ] && echo "$BITCOIND not found or not executable." && exit 1
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue