sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

ref-manual: Updated image-live.bbclass description 

Fixes [YOCTO #9001]

Updated the image-live class description to specifically mention
creating *.iso and *.hddimg images as "live" images.  Provided more
explanation about usage through the NOISO and NOHDD variables.

Also, provided a cross-referencing link back to the updated
image-live class from the EFI_PROVIDERS variable.

(From yocto-docs rev: 10c81adc26bd0a7a8952eb362f958f92566d42db)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2017-05-12 11:45:07 -07:00 committed by Richard Purdie
parent 4fe09a11ee
commit aade3895d4
2 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
documentation/ref-manual/ref-classes.xml
View File

@ -1301,19 +1301,27 @@
<title><filename>image-live.bbclass</filename></title>
<para>
The <filename>image-live</filename> class supports building "live"
images.
This class controls building "live" (i.e. HDDIMG and ISO) images.
Live images contain syslinux for legacy booting, as well as the
bootloader specified by
<link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
if
<link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>
contains "efi".
</para>
<para>
Normally, you do not use this class directly.
Instead, you add "live" to
<link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>.
You can selectively build just one of these types through the
<link linkend='var-NOISO'><filename>NOISO</filename></link>
and
<link linkend='var-NOHDD'><filename>NOHDD</filename></link> variables.
For example, if you were building an ISO image, you would add "live"
to <filename>IMAGE_FSTYPES</filename>, set the
<link linkend='var-NOISO'><filename>NOISO</filename></link> variable to
"0" and the build system would use the <filename>image-live</filename>
class to build the ISO image.
<filename>NOISO</filename> variable to "0" and the build system would
use the <filename>image-live</filename> class to build the ISO image.
</para>
</section>

4
documentation/ref-manual/ref-variables.xml
View File

@ -3880,7 +3880,9 @@
<para>
See the
<link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link>
class for more information.
and
<link linkend='ref-classes-image-live'><filename>image-live</filename></link>
classes for more information.
</para>
</glossdef>
</glossentry>