Add support for bbot.sys-install:config.install.root variable

1 files changed, 19 insertions, 11 deletions

diff --git a/doc/manual.cli b/doc/manual.cli
index e61e6ef..3a00e2d 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -2329,16 +2329,16 @@ linux*-gcc_8 linux-gcc_8 x86_64-linux-gnu \"all gcc-8+:gcc-7+\"
 \
 
 If the \c{<tgt-config-arg>} list contains the \c{config.install.root} variable
-that applies to the \c{bpkg.create} step, then in addition to building and
-possibly running tests, the \c{bbot} worker will also test installing and
-uninstalling each package (unless replaced with the \c{bbot.sys-install}
-step). Furthermore, if the package contains subprojects that support the test
-operation and/or refers to other packages via the \c{tests}, \c{examples}, or
-\c{benchmarks} manifest values which are not excluded by the \c{bbot}
-controller, then the worker will additionally build such subprojects/packages
-against the installation (created either from source or from the binary
-distribution package) and run their tests (test installed and test separate
-installed phases).
+that applies to the \c{bpkg.target.create} or, as a fallback, \c{b.create} or
+\c{bpkg.create} steps, then in addition to building and possibly running
+tests, the \c{bbot} worker will also test installing and uninstalling each
+package (unless replaced with the \c{bbot.sys-install} step). Furthermore, if
+the package contains subprojects that support the test operation and/or refers
+to other packages via the \c{tests}, \c{examples}, or \c{benchmarks} manifest
+values which are not excluded by the \c{bbot} controller, then the worker will
+additionally build such subprojects/packages against the installation (created
+either from source or from the binary distribution package) and run their
+tests (test installed and test separate installed phases).
 
 Two types of installations can be tested: \i{system} and \i{private}. A system
 installation uses a well-known location, such as \c{/usr} or \c{/usr/local},
@@ -2362,7 +2362,15 @@ Note also that while building and running tests against the installation
 created either from source or from the archive distribution package the worker
 makes the \c{bin} subdirectory of \c{config.install.root} the first entry in
 the \c{PATH} environment variable, except for build system modules which
-supposedly don't install any executables.
+supposedly don't install any executables. As was mentioned earlier, normally
+the \c{config.install.root} variable is expected to be prefixed with the
+\c{bpkg.target.create} or, as a fallback, \c{b.create} or \c{bpkg.create} step
+ids. However, for testing of the relocatable installations it can be desirable
+to extract the archive distribution package content at the
+\c{bbot.sys-install.tar.extract} step into a different installation
+directory. If that's the case, then this directory needs to also be specified
+as \c{bbot.sys-install:config.install.root}. If specified, this directory will
+be preferred as a base for forming the \c{bin/} directory path.
 
 The \c{bbot} controller normally issues the build task by picking an unbuilt
 package configuration and one of the produced (via the machine names match)