diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual.cli | 26 |
1 files changed, 16 insertions, 10 deletions
diff --git a/doc/manual.cli b/doc/manual.cli index b168675..ec29fcd 100644 --- a/doc/manual.cli +++ b/doc/manual.cli @@ -51,12 +51,12 @@ OS and building of the latest \c{build2} toolchain and \c{bbot}. @@ TODO: init steps. The monitor service (and \c{bbot} that it starts) are executed as the -\c{build} user/group. The home directory of this user is \c{/build}. It has +\c{build} user/group. The home directory of this user is \c{/build/}. It has the following subdirectories: \ul| -\li|\n\c{/build/tftp}\n +\li|\n\c{/build/tftp/}\n A size-limited \c{tmpfs} filesystem that is used to communicate with build machines as well as for build host log access. @@ -66,7 +66,13 @@ the following subdirectories: temporarily write-accessible to build machines by running custom instances of the TFTP server on other ports.| -\li|\n\c{/build/machines}\n +\li|\n\c{/build/toolchains/}\n + + Contains \c{build2} toolchain installations after bootstrap. Each toolchain + is installed into a subdirectory names as the toolchain name. See + \l{#config-toolchains Toolchains} for details.| + +\li|\n\c{/build/machines/}\n Contains virtual machines and containers. See \l{#config-storage-machines Machines} for details.|| @@ -87,7 +93,7 @@ kernel command line parameters. The \c{buildos.buildid_url} value should point to the \c{buildos-buildid} file that comes along the kernel image and initrd. The \c{buildos.toolchain_url} value is the location of the toolchain checksums file as described in -\l{#config-toolchain Toolchain}. See \l{#boot-net Network Boot} for the usage +\l{#config-toolchains Toolchains}. See \l{#boot-net Network Boot} for the usage example. \h#boot-net|Network Boot| @@ -291,7 +297,7 @@ quotes): buildos.ssh_key=\"ssh-rsa AAA...OA0DB user@host\" \ -\h#config-toolchain|Toolchain| +\h#config-toolchains|Toolchains| The first step performed by the Build OS monitor is to bootstrap the \c{build2} toolchain. The location of the toolchain packages is specified with @@ -305,7 +311,7 @@ default toolchain repository location embedded into the build scripts in the It is also possible to use multiple toolchains on a single Build OS instance. In this case a toolchain name can be appended after \c{buildos.toolchain_*}, -for example, \c{buildos.toolchain_url.stage} (values without the toolchain +for example, \c{buildos.toolchain_url.<name>} (values without the toolchain name use the toolchain name \c{default}). Each line in the checksums file is the output of the \c{shaNNNsum(1)} utility, @@ -323,10 +329,10 @@ e723[...]c305 *0.4.0/build2-mingw-0.4.0-x86_64-windows.tar.xz \ Based on the checksums file the monitor downloads each file into -\c{/build/tftp/} (the file path is taken as relative to \c{toolchain_url}), -verifies their checksums, and creates \i{predictable name} symlinks (names -without the version). Continuing with the above example, the contents of -\c{/build/tftp/} would be: +\c{/build/tftp/toolchains/<name>/} (the file path is taken as relative to +\c{toolchain_url}), verifies their checksums, and creates \i{predictable name} +symlinks (names without the version). Continuing with the above example, the +contents of \c{/build/tftp/toolchains/default/} would be: \ build2-toolchain-0.4.0.tar.xz |