diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2018-02-18 18:04:54 -0500 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2018-02-18 18:04:57 -0500 |
| commit | dcfe218626b05204e9fbc95ba5d95ca0eb72ec9b (patch) | |
| tree | 52601806b5cd25049590df2d9ba1149cfd4fb6ce /contrib/devtools/README.md | |
| parent | 8a98dfeebf58b8fc9b7c966ae0f99ad0760d7800 (diff) | |
| parent | 526e28220a351db2f439793b4a310c8863c123a9 (diff) | |
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
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 ==================== |