| Message ID | 20211028171727.246342-2-amikan@ilbers.de |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | Update Isar documentation | expand |
Am Thu, 28 Oct 2021 20:17:25 +0300 schrieb Anton Mikanovich <amikan@ilbers.de>: > Include into user_manual.md explanation of imager dependencies should > be added if using wic image type with bootloader-related plugins. > > Inspired by issue #69 > > Signed-off-by: Anton Mikanovich <amikan@ilbers.de> > --- > doc/user_manual.md | 16 ++++++++++++++++ > 1 file changed, 16 insertions(+) > > diff --git a/doc/user_manual.md b/doc/user_manual.md > index 01fe701..1b00a47 100644 > --- a/doc/user_manual.md > +++ b/doc/user_manual.md > @@ -586,6 +586,22 @@ Isar contains additional image type classes that > can be used as reference: > - `ubi-img` > - `wic-img` > > +### Imager dependencies and bootloaders > + > +External tools used for final image prepare inside image type > classes should be declared as `IMAGER_INSTALL`. +It will make Isar to > install following packages into buildchroot before proceeding. + > +If using `wic-img` image type correct bootloader dependecy should be > added to target machine config based on selected wic plugin. + I would make that more generic and explain what IMAGER_INSTALL is in general. Maybe even refer to "native" from OE. The tools are not "external", they are build tools (coming from upstream or maybe a layer) that are not part of the image but needed to construct it. In fact we use that variable in many of our imager classes, not just wic. > +When using legacy BIOS bootloader (amd64/i386 only) dependency on > syslinux should be used: +``` > +IMAGER_INSTALL += "${SYSLINUX_BOOTLOADER_INSTALL}" > +``` > +When using EFI bootloader dependency on GRUB should be added: > +``` > +IMAGER_INSTALL += "${GRUB_BOOTLOADER_INSTALL}" wic makes a good example to explain the concept. Note that EFI does not mean grub and having to set IMAGER_INSTALL. It can also mean systemd-boot and no IMAGER_INSTALL. Henning > +``` > + > --- > > ## Customize and configure image
diff --git a/doc/user_manual.md b/doc/user_manual.md index 01fe701..1b00a47 100644 --- a/doc/user_manual.md +++ b/doc/user_manual.md @@ -586,6 +586,22 @@ Isar contains additional image type classes that can be used as reference: - `ubi-img` - `wic-img` +### Imager dependencies and bootloaders + +External tools used for final image prepare inside image type classes should be declared as `IMAGER_INSTALL`. +It will make Isar to install following packages into buildchroot before proceeding. + +If using `wic-img` image type correct bootloader dependecy should be added to target machine config based on selected wic plugin. + +When using legacy BIOS bootloader (amd64/i386 only) dependency on syslinux should be used: +``` +IMAGER_INSTALL += "${SYSLINUX_BOOTLOADER_INSTALL}" +``` +When using EFI bootloader dependency on GRUB should be added: +``` +IMAGER_INSTALL += "${GRUB_BOOTLOADER_INSTALL}" +``` + --- ## Customize and configure image
Include into user_manual.md explanation of imager dependencies should be added if using wic image type with bootloader-related plugins. Inspired by issue #69 Signed-off-by: Anton Mikanovich <amikan@ilbers.de> --- doc/user_manual.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)