Revised pretend-boot description master
authorRalph Ronnquist <ralph.ronnquist@gmail.com>
Fri, 4 Mar 2022 01:37:33 +0000 (12:37 +1100)
committerRalph Ronnquist <ralph.ronnquist@gmail.com>
Fri, 4 Mar 2022 01:37:33 +0000 (12:37 +1100)
README.adoc

index f0416026e706d36aaf3d451041a7b0f8f59e86ea..e1ebe93ea560be845dea593022df42eeaff353d2 100644 (file)
@@ -10,26 +10,22 @@ than within virtual machines (VM).
 pretend-boot
 ------------
 
-The +pretend-boot+ script works together with the +subhost-init+
-script to run a subhost almost as if booted in a virtual machine,
-except of course, that it really is merely an "unshared sandboxing"
-executed by the the host kernel.
+The +pretend-boot+ script runs a subhost almost as if booted in a
+virtual machine, except of course, that it really is merely an
+"unshared sandboxing" executed by the the host kernel.
 
 .Example
 ----
 # ./pretend-boot mysubhost
 ----
 
-The named subhost must then be set up in the directory
-+/opt/sub/mysubhost+ with firstly a +config+ file and secondly a
-+live+ subdirectory that will be used as root filesystem mount point.
-
- 1. +config+ configuration that defines +DISKS+ and +BRIDGES+
- 2. +live+ empty directory for the root filesystem mount
-
-The +config+ file is a textfile, or in fact a +bash+ source file, that
-should set the variables +DISKS+ and +BRIDGES+ for the subhost.
-
++pretend-boot+ sets up the +/opt/sub/mysubhost/live+ directory that it
+uses as root filesystem mount point. It requires the variables DISKS
+and BRIDGES to be set, either as environment variables, or via a
+configuration file that it by default expects to find at
++/opt/sub/mysubhost/config+ That +config+ would be a textfile, or in
+fact a +bash+ source file, that should set the variables +DISKS+ and
++BRIDGES+ for running the subhost.
 
 ====
 **The +DISKS+ variable** is an array declaring the disks in terms the