Document installation testing

1 files changed, 33 insertions, 6 deletions

diff --git a/doc/manual.cli b/doc/manual.cli
index 5f4452d..46f947f 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -639,13 +639,13 @@ we wanted to test both 32 and 64-bit builds as well as debug and release, then
 we could have generated the following configurations:
 
 \
-windows*-vc_14* windows-vc_14-32-debug   i686-microsoft-win32-msvc14.0   config.cc.coptions=/Z7 config.cc.loptions=/DEBUG ~\"warning C4\d{3}: \"
+windows*-vc_14* windows-vc_14-32-debug i686-microsoft-win32-msvc14.0 config.cc.coptions=/Z7 config.cc.loptions=/DEBUG ~\"warning C4\d{3}: \"
 
-windows*-vc_14* windows-vc_14-32-release i686-microsoft-win32-msvc14.0   config.cc.coptions=\"/O2 /Oi\"                   ~\"warning C4\d{3}: \"
+windows*-vc_14* windows-vc_14-32-release i686-microsoft-win32-msvc14.0 config.cc.coptions=\"/O2 /Oi\" ~\"warning C4\d{3}: \"
 
-windows*-vc_14* windows-vc_14-64-debug   x86_64-microsoft-win32-msvc14.0 config.cc.coptions=/Z7 config.cc.loptions=/DEBUG ~\"warning C4\d{3}: \"
+windows*-vc_14* windows-vc_14-64-debug x86_64-microsoft-win32-msvc14.0 config.cc.coptions=/Z7 config.cc.loptions=/DEBUG ~\"warning C4\d{3}: \"
 
-windows*-vc_14* windows-vc_14-64-release x86_64-microsoft-win32-msvc14.0 config.cc.coptions=\"/O2 /Oi\"                   ~\"warning C4\d{3}: \"
+windows*-vc_14* windows-vc_14-64-release x86_64-microsoft-win32-msvc14.0 config.cc.coptions=\"/O2 /Oi\" ~\"warning C4\d{3}: \"
 \
 
 As another example, let's say we have \c{linux_fedora_25-gcc_6} and
@@ -653,7 +653,34 @@ As another example, let's say we have \c{linux_fedora_25-gcc_6} and
 builds on Linux, then our configurations could look like this:
 
 \
-linux*-gcc-6 linux-gcc_6-debug   x86_64-linux-gnu config.cc.coptions=-g
-linux*-gcc-6 linux-gcc_6-release x86_64-linux-gnu config.cc.coptions=-O3
+linux*-gcc_6 linux-gcc_6-debug x86_64-linux-gnu config.cc.coptions=-g
+linux*-gcc_6 linux-gcc_6-release x86_64-linux-gnu config.cc.coptions=-O3
 \
+
+If \c{<config-vars>} contains the \c{config.install.root} variable then, in
+addition to building and running tests, the \c{bbot} worker will also test
+installing and uninstalling each package. Furthermore, if the package contains
+the \c{tests} subdirectory that is a subproject, then the worker will
+additionally build and run tests against the installation.
+
+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},
+that will be searched by the compiler toolchain by default. A private
+installation uses a private directory, such as \c{/opt}, that will have to be
+explicitly mentioned to the compiler. While the system installation is usually
+preferable, it may not be always usable because of the potential conflicts
+with the already installed software, for example, by the system package
+manager.
+
+As an example, the following two configurations could be used to test system
+and private installations:
+
+\
+linux*-gcc* linux-gcc-sys x86_64-linux-gnu config.install.root=/usr config.install.sudo=sudo
+linux*-gcc* linux-gcc-prv x86_64-linux-gnu config.install.root=/tmp/install config.cc.poptions=-I/tmp/install/include config.cc.loptions=-L/tmp/install/lib
+\
+
+Note also that while building and run tests against the installation the
+worker makes the \c{bin} subdirectory of \c{config.install.root} the first
+entry in the \c{PATH} environment variable.
 "