diff options
| author | Wladimir J. van der Laan <laanwj@gmail.com> | 2018-01-31 11:22:42 +0100 |
|---|---|---|
| committer | Wladimir J. van der Laan <laanwj@gmail.com> | 2018-01-31 11:27:36 +0100 |
| commit | 526e28220a351db2f439793b4a310c8863c123a9 (patch) | |
| tree | 0ef7fdb88226ac4e3fe4a5b420d178e64d6b6331 /contrib/devtools/README.md | |
| parent | 216f9a42e689b49a13387efff7a78d0d661b5d12 (diff) | |
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
```
Diffstat (limited to 'contrib/devtools/README.md')
| -rw-r--r-- | contrib/devtools/README.md | 8 |
1 files changed, 8 insertions, 0 deletions
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 ==================== |