aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2023-03-24 07:46:38 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2023-03-24 07:46:38 +0200
commit74f55224442b17ef5d6a03783790f1a2fbd22aaa (patch)
tree8a4edc10a609e35d4dc13cfbe508c8c575cd9412
parentceb8d922d6cadefd835278d20184348b1b1dbf98 (diff)
Note relocatable installation in pkg-bindist documentation
-rw-r--r--bpkg/pkg-bindist.cli15
1 files changed, 15 insertions, 0 deletions
diff --git a/bpkg/pkg-bindist.cli b/bpkg/pkg-bindist.cli
index 3f4c847..2c05aaa 100644
--- a/bpkg/pkg-bindist.cli
+++ b/bpkg/pkg-bindist.cli
@@ -597,6 +597,21 @@ namespace bpkg
-C / --strip-components=1
\
+ If you expect the binary package to be unpacked into a directory other
+ than its original installation directory (\cb{--archive-install-root}),
+ then it's recommended to make it relocatable by specifying the
+ \cb{config.install.relocatable=true} configuration variable. For example:
+
+ \
+ bpkg bindist \
+ ... \
+ config.install.relocatable=true \
+ libhello
+ \
+
+ Note that not all source packages support relocatable installation (see
+ the \l{b#module-install \cb{install}} module documentation for details).
+
The installation archive package can be generated for a target other than
the host by specifying the target triplet with the \cb{--architecture}
option. In this case the \cb{bpkg} configuration is assumed to be