diff options
Diffstat (limited to 'docs/README.build')
| -rw-r--r-- | docs/README.build | 106 |
1 files changed, 72 insertions, 34 deletions
diff --git a/docs/README.build b/docs/README.build index 8a95625..eae43fe 100644 --- a/docs/README.build +++ b/docs/README.build @@ -6,9 +6,7 @@ INDEX * File format for aitab. * Why the /isolinux and /parabola/boot/syslinux directories? * Git branches and build configurations. -* Building the most basic Parabola GNU/Linux-libre live media. (configs/baseline) -* Building official Parabola GNU/Linux-libre live media. (configs/releng) - +* Building Parabola GNU/Linux-libre live media. *** Build requirements @@ -39,6 +37,27 @@ INDEX + (none) +*** Temporary filesystems generated by mkparabolaiso. + +* work/x86_64/root-image/ + => # x86_64 chroot install target +* work/i686/root-image/ + => # i686 chroot install target +* work/root-image/ + => # transient per-arch hard copy of each work/<ARCH>/root-image/ + => # transient source for each per-arch ./work/root-image.fs +* work/root-image.fs + => # transient source for per-arch root-image.fs.sfs +* work/mnt/root-image/ + => # mountpoint for packing work/root-image.fs +* work/iso/parabola/x86_64/root-image.fs.sfs or + work/iso/parabola/x86_64/root-image.sfs + => # r/o loopback filesystem for live x86_64 environment (see "Image types " section) +* work/iso/parabola/i686/root-image.fs.sfs or + work/iso/parabola/i686/root-image.sfs + => # r/o loopback filesystem for live i686 environment (see "Image types " section) + + *** Image types generated by mkparabolaiso. * image-name.sfs SquashFS image with all files directly on it. @@ -84,6 +103,10 @@ module of SYSLINUX. ISOLINUX can not find config files on The parabolaiso git repo consists of several branches; only some of which are useful for building ISOs. Others exist only for merging with upstream. The build configurations on the 'master' branch are used to build the official release ISOs. +Note that the ISOs can built by an unprivileged user with sudo but all files under the configs/releng/root-image directory must be owned by root during the build process. The configs/releng/build.sh script manages this automatically; but it will cause problems when checking-out or switching branches if the git command is not also run as a superuser. To avoid a corrupted working tree, the entire contents of the configs/releng/root-image directory should be chown'ed to the unprivileged user before running any git command that would modify them. + + $ sudo chown -R user:group root-image/ + ** Branches not intended for building ISOs. * helper/rebrand - Branch to aid rebranding. Branch master of archiso.git plus Parabola rebranding of filenames and file contents. It is used as an intermediate step to merge Archiso, to aid git detecting file renames. @@ -102,40 +125,55 @@ The parabolaiso git repo consists of several branches; only some of which are us * 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. -** Build configurations. +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. -* configs/profile - the Parabola standard CLI release ISO -* configs/mate - the Parabola Mate release ISO -* configs/talkingparabola - the TalkingParabola CLI release ISO -* configs/talkingparabola-X11- the TalkingParabola Mate release ISO +** 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. -*** Building the most basic Parabola GNU/Linux-libre live media. (configs/baseline) - -* Install needed packages. - # pacman -S git make squashfs-tools libisoburn rsync --needed -* Install parabolaiso. - # git clone git://projects.parabolagnulinux.org/parabolaiso.git - # make -C parabolaiso install - -* Build a basic iso. - # /usr/share/parabolaiso/configs/baseline/build.sh - -Note: If you want to customize, just see the configs/releng directory which is -used to build official images with much more things. - - -*** Building official Parabola GNU/Linux-libre live media. (configs/releng) +*** Building Parabola GNU/Linux-libre Live ISOs. * Install needed packages. - # pacman -S git make squashfs-tools libisoburn dosfstools lynx --needed - -* Install parabolaiso. - # git clone git://projects.parabolagnulinux.org/parabolaiso.git - # make -C parabolaiso install - -* Build them! - # /usr/share/parabolaiso/configs/releng/build.sh - -Note: See build.sh -h for more options. This only runs on x86_64. + # pacman -S squashfs-tools libisoburn rsync --needed # 'baseline' ISO + # pacman -S squashfs-tools libisoburn dosfstools --needed # 'releng' derrived ISOs + +* Install parabolaiso via pacman to build the standard releases. + # pacman -S parabolaiso + # cd /usr/share/parabolaiso/configs/releng + +* Clone parabolaiso from git for development. + # pacman -R parabolaiso + # pacman -S parabolaiso-data git + # git clone git://git.parabola.nu/packages/parabolaiso.git + # cd parabolaiso/configs/releng + +* Build one or more ISOs. + # ./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 + # ./build.sh -E OpenRC/CLI -O # OpenRC/CLI for offline install + # ./build.sh -E OpenRC/LXDE -O # OpenRC/LXDE for offline install + # ./build.sh -E SystemD/Talking # SystemD/TalkingParabola + # ./build.sh -T x86_64 -V "`date +%Y.%m.%d.%H.%M`-alpha" # development filename + +Note: See build.sh -h for more options. +Note: This script needs to be run on an x86_64 ArchLinux derrivative +Note: Specifying a single architecture with the -T option builds in half of the time + and results in the ISO being about half of the size as the dual-architecture ISO. +Note: The argument to the -E option must consist of an init/wm pair separated by a '/' slash. + This will determine which package lists will be used. Although the package lists + files are named in lowercase, this argument may contain captial letters. + It will be printed verbatim in the titles of the boot menu and the MOTD. +Note: The rebuild.sh script can be handly during development. Among other things, + it can delete the work directory while retaining the chroot package caches + (the 'wipe' option); which will speed up repeated clean re-builds. |