|author||bill-auger <firstname.lastname@example.org>||2018-07-08 09:57:37 -0400|
|committer||bill-auger <email@example.com>||2018-07-08 09:57:37 -0400|
squashme - docs
1 files changed, 31 insertions, 12 deletions
diff --git a/docs/README.build b/docs/README.build
index ca4f477..55e3576 100644
@@ -125,20 +125,39 @@ Note that the ISOs can built by an unprivileged user with sudo but all files und
* master - Profile branch a.k.a "releng". Branch rebrand/releng with Parabola customizations. The files outside configs/ which are common to all variants are packaged from this branch.
-NOTE: This distinction is in the process of being deprecated or reverted. In the future, there will be only one 'releng' profile which is capable of building any of the variant editions via command-line options a single ./build.sh script on the master branch. See the "Package Lists" section the '-E' ./build.sh option below.
+NOTE: This distinction is in the process of being deprecated or reverted. In the future, there will be only one 'releng' profile which is capable of building any of the variant editions via command-line options a single ./build.sh script on the master branch. See the "Package Lists" section and the '-E' option to ./build.sh below.
** Package Lists
-For each valid edition, a file named 'packages/packages-<WM>.both' must exist, even if empty
-where: <WM> is 'cli' by default, or:
- <WM> corresponds to the part of the '-E' CLI option after the '/'
-This file lists the packages that are to be installed
-in one specific edition of live system for all architectures;
-but are not shared by other editions and are not coupled to a particular init system
-Files named 'packages-<WM>.<ARCH>' cat exist optionally to specify the packages
-that are to be installed for that same edition but only for specific architectures
- e.g. 'packages-lxde.x86_64'
-All packages/packages-* files must be named in lowercase.
+Each ISO edition is characterized by an init/WMDE pair such as 'OpenRC/LXDE'
+that is optionally passed into the ./build.sh script via the '-E' CLI option
+or 'systemd/cli' by default, and by the architecture(s) that it targets as
+optionally passed into the ./build.sh script via the '-T' CLI option or 'dual' by default.
+The valid INIT/WMDE combinations are specified in the VALID_INITS and VALID_GUIS arrays
+in the ./build.sh script. The valid architectures are''i686' and 'x86_64'.
+The '-T dual' option merely repeats each build stage over each valid architecture.
+During the package installation stage, the following package list files will be loaded
+if they exist and if they correspond to the current target INIT/WMDE/ARCH:
+ 'packages/install-all.all' - loaded for all targets
+ 'packages/install-gui.all' - loaded for all WMDE other than 'cli'
+ 'packages/install-<INIT>.all' - loaded for the corresponding INIT (default 'systemd')
+ 'packages/install-<WMDE>.all' - loaded for the corresponding WMDE (default 'cli')
+ 'packages/install-<INIT>-gui.all' - loaded for the corresponding INIT if WMDE other than 'cli'
+ <INIT> is any of 'VALID_INITS' and corresponds to the part of the '-E' CLI option before the '/'
+ <WMDE> is any of 'VALID_GUIS' and corresponds to the part of the '-E' CLI option after the '/'
+These files specify the packages that are to be installed into "live" system.
+An analogous set of package list files may exist, named with 'install' replaced by 'cache'.
+ e.g. 'packages/cache-all.all' - cached for all targets
+ e.g. 'packages/cache-gui.all' - cached for all targets if WMDE other than 'cli'
+The packages specified in these files will not be installed into "live" system;
+but will be downloaded and stored in the /isorepo directory on the ISO for offline install.
+As a supplement to any of the above mentioned files named ending with '.all',
+optional files may exist with corresponding names ending with '.<ARCH>'
+to specify the packages intended only for specific architectures.
+ e.g. 'packages/install-lxde.x86_64' - loaded for x86_64 targets if 'lxde' WMDE
+ e.g. 'packages/cache-gui.i686' - cached for i686 targets if WMDE other than 'cli'
+All packages/install-* and packages/cache-* files must be named entirely in lowercase.
*** Building Parabola GNU/Linux-libre Live ISOs.
@@ -157,7 +176,7 @@ All packages/packages-* files must be named in lowercase.
# git clone git://git.parabola.nu/packages/parabolaiso.git
# cd parabolaiso/configs/releng
-* Build one or more ISOs.
+* Build an ISO.
# ./build.sh # dual-architecture SystemD/CLI
# ./build.sh -T i686 # 32-bit x86 target SystemD/CLI
# ./build.sh -T x86_64 # 64-bit x86 target SystemD/CLI