Johannes/ISO
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
e0a7a91874
ISO/README
Gerardo Exequiel Pozzi 4d02fff37e [configs/releng] Add new build mode: all 
This mode allow to build all 6 ISOs in just one step if build type is <all>.
So "build.sh build all all" -> (single-i686, single-x86_64, dual) X (netinstall, core).

Note that the <purge> command is executed between each build step to save space,
so do not use this mode if you want to keep all temporal files in work_dir.

Signed-off-by: Gerardo Exequiel Pozzi <vmlinuz386@yahoo.com.ar>
2012-03-17 12:43:47 -03:00

253 lines
9.3 KiB
Plaintext
Raw Blame History

INDEX
-----
* Boot parameters (initramfs stage)
* hooks/archiso
* hooks/archiso_pxe_common
* hooks/archiso_pxe_nbd
* hooks/archiso_pxe_http
* hooks/archiso_pxe_nfs
* hooks/archiso_loop_mnt
* Boot parameters (only for configs/releng)
* etc/rc.conf
* Build requirements
* Image types generated by mkarchiso.
* File format for aitab.
* Why the /isolinux and /arch/boot/syslinux directories?
* Know issues
* Building the most basic Arch Linux live media. (configs/baseline)
* Building official Arch Linux live media. (configs/releng)
*** Boot parameters (initramfs stage)
** hooks/archiso
* archisolabel= Set the filesystem label where archiso files reside.
Default: (unset)
* archisodevice= Set the device node where archiso medium is located.
Default: "/dev/disk/by-label/${archisolabel}"
* archisobasedir= Set the base directory where all files reside.
Default: "arch"
* aitab= Set the path for "aitab" file.
Default: ${archisobasedir}/aitab
* copytoram= If set to "y" or just "copytoram" without arguments,
all SquashFS are copied to "RAM".
Default: (unset)
* checksum= If set to "y" or just "checksum" without arguments,
performs a self-test of all files inside ${install_dir},
and continue booting if ok.
Default: (unset)
* cow_label= Set the filesystem label where COW (dm-snapshot)
files must be stored.
Default: (unset)
* cow_device= Set the device node where COW (dm-snapshot) files
must be stored.
Default: (unset) or "/dev/disk/by-label/${cow_label}"
* cow_directory= Set a directory inside ${cow_device}.
Default: "/persistent_${archisolabel}/${arch}"
* cow_persistent= Set if snapshots are persistent "P" or non-persistent "N".
Default: "N" (if no ${cow_device} is used) otherwise "P".
* cowspace_size= Set the size of tmpfs /cowspace. This space is used for
Copy-On-Write files of dm-snapshot.
Size is in bytes (suffix with "k", "m" and "g") or
in percentage of available RAM.
Default: "75%"
* copytoram_size= Set the size of tmpfs. This space is used for
copy of all SquashFS images used, if copytoram=y.
Size is in bytes (suffix with "k", "m" and "g") or
in percentage of available RAM.
Default: "75%"
* dm_snap_prefix= Set a prefix for device-mapper snapshot node names.
Default: "arch"
* arch= Force an architecture type (i686 | x86_64).
Do not set it for normal operations.
Useful for running a 64 bit kernel / 32 bit userspace.
Default: (architecture of running kernel)
** hooks/archiso_pxe_common
* ip= This parameter is setup automatically by PXELINUX
when option "IPAPPEND" is set to 1 or 2 in config.
ip=<client-ip>:<boot-server-ip>:<gw-ip>:<netmask>
Default: (set via PXE server)
* BOOTIF= This parameter is setup automatically by PXELINUX
when option "IPAPPEND" is set to 2 or 3 in config.
BOOTIF=<hardware-address-of-boot-interface>
Default: (set via PXELINUX)
** hooks/archiso_pxe_nbd
* archiso_nbd_name= Set NBD export name used by the server.
Default: archiso
* archiso_nbd_srv= Set an IP address where NBD reside.
If ${pxeserver} is used, PXE IP will be used.
Default: (unset)
** hooks/archiso_pxe_http
* archiso_http_srv= Set an HTTP URL (must end with /) where ${archisobasedir}
is found with all *.sfs files.
In the IP/domain part if ${pxeserver} is used, use PXE IP.
Default: (unset)
* archiso_http_spc= Set the size of tmpfs where *.sfs files are downloaded.
Default: "75%"
** hooks/archiso_pxe_nfs
* archiso_nfs_srv= Set the NFS-IP:/path of the server
In the IP part if ${pxeserver} is used, PXE IP will be used.
Default: (unset)
* archiso_nfs_opt= Set NFS mount options separated by comma.
Default: (unset, see below)
These are the implicit options:
port = as given by server portmap daemon
rsize = 1024
wsize = 1024
timeo = 7
retrans = 3
acregmin = 3
acregmax = 60
acdirmin = 30
acdirmax = 60
flags = hard, nointr, noposix, cto, ac
** hooks/archiso_loop_mnt
* img_label= Set the filesystem label where archiso-image.iso.
Default: (unset)
* img_dev= Device where archiso-image.iso reside.
Default: (unset) or "/dev/disk/by-label/${img_label}"
* img_loop= Full path where archiso-image.iso is located on ${img_dev}
Default: (unset)
*** Boot parameters (only for configs/releng)
** /etc/rc.conf
By default these parameters are set by default to these values
if nothing is specified on command line.
* locale= "en_US.UTF-8"
* daemon_locale= "no"
* hardwareclock= "UTC"
* timezone= "Canada/Pacific"
* keymap= "us"
* consolefont= (unset)
* consolemap= (unset)
* usecolor= "yes"
*** Build requirements
** For mkarchiso script needs these packages (build host):
+ squashfs-tools for mksquashfs
+ libisoburn for xorriso
** For these hooks needs these packages (on target root-image)
* archiso
+ (none)
* archiso_loop_mnt
+ (none)
* archiso_pxe_common
+ mkinitcpio-nfs-utils for ipconfig
* archiso_pxe_nbd
+ nbd for nbd-client
* archiso_pxe_http
+ curl for curl
* archiso_pxe_nfs
+ mkinitcpio-nfs-utils for nfsmount
* archiso_shutdown
+ (none)
*** Image types generated by mkarchiso.
* image-name.sfs SquashFS image with all files directly on it.
* image-name.fs.sfs SquashFS with only one file inside (image-name.fs),
which is an image of some type of filesystem
(ext4, ext3, ext2, xfs), all files reside on it.
*** File format for aitab.
The aitab file holds information about the filesystems images that must be
created by mkarchiso and mounted at initramfs stage from the archiso hook.
It consists of some fields which define the behaviour of images.
# <img> <mnt> <arch> <sfs_comp> <fs_type> <fs_size>
<img> Image name without extension (.fs .fs.sfs .sfs).
<mnt> Mount point.
<arch> Architecture { i686 | x86_64 | any }.
<sfs_comp> SquashFS compression type { gzip | lzo | xz }.
<fs_type> Set the filesystem type of the image { ext4 | ext3 | ext2 | xfs }.
A special value of "none" denotes no usage of a filesystem.
In that case all files are pushed directly to SquashFS filesystem.
<fs_size> An absolute value of file system image size in MiB.
(example: 100, 1000, 4096, etc)
A relative value of file system free space [in percent].
{1%..99%} (example 50%, 10%, 7%).
This is an estimation, and calculated in a simple way.
Space used + 10% (estimated for metadata overhead) + desired %
*** Why the /isolinux and /arch/boot/syslinux directories?
The /isolinux directory holds files needed for the ISOLINUX boot loader
module of SYSLINUX. ISOLINUX can not find config files on
/arch/boot/syslinux, like other boot loaders modules (EXTLINUX, SYSLINUX, etc).
When make your custom boot-pendrive, you need to copy /arch directory to it.
/isolinux/isolinux.cfg just holds /arch/boot/syslinux/syslinux.cfg
*** Know issues
** On shutdown there are two steps that [FAIL]:
"Unmounting Swap-backed Filesystems" and "Unmounting Non-API Filesystems",
These filesystem are in use at this stage by archiso, but...
This is not a real issue since, all mounted filesystem, loopback devices
and device mapper devices made by archiso will be "free" on "shutdown tmpfs"
(A.K.A deinitramfs), build at initramfs by [archiso_shutdown] initcpio hook.
*** Building the most basic Arch Linux live media. (configs/baseline)
* Install needed packages.
# pacman -S git make squashfs-tools libisoburn --needed
* Install archiso.
# git clone git://projects.archlinux.org/archiso.git
# make -C archiso/archiso install
* Build a basic iso.
# /usr/share/archiso/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 Arch Linux live media. (configs/releng)
* Install needed packages.
# pacman -S git make squashfs-tools libisoburn --needed
* Install archiso.
# git clone git://projects.archlinux.org/archiso.git
# make -C archiso/archiso install
* Build them!
# /usr/share/archiso/configs/releng/build.sh build all all
Note: See build.sh -h for more options.
Reference in New Issue View Git Blame Copy Permalink