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: 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 ++++++++ 1 file changed, 8 insertions(+) (limited to 'contrib/devtools/README.md') diff --git a/contrib/devtools/README.md b/contrib/devtools/README.md index 67c5e15a15..8ca8fa9066 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 ==================== -- cgit v1.2.3