summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-05-12 11:45:07 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-05-18 13:18:56 +0100
commitb7626dc36f97d62dbf8a68b2061f5f93cd567b64 (patch)
treeafb05c4f0af8241ba73cf9abed0e3de1ed970b5e /documentation
parent69d1f536e47407f650e202c92db266d792e94180 (diff)
downloadpoky-b7626dc36f97d62dbf8a68b2061f5f93cd567b64.tar.gz
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: 788061b2911339c8396b798a0ab5635ab5bb89e1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-classes.xml18
-rw-r--r--documentation/ref-manual/ref-variables.xml4
2 files changed, 16 insertions, 6 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index fc0314b957..16af6f9d07 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1301,19 +1301,27 @@
1301 <title><filename>image-live.bbclass</filename></title> 1301 <title><filename>image-live.bbclass</filename></title>
1302 1302
1303 <para> 1303 <para>
1304 The <filename>image-live</filename> class supports building "live" 1304 This class controls building "live" (i.e. HDDIMG and ISO) images.
1305 images. 1305 Live images contain syslinux for legacy booting, as well as the
1306 bootloader specified by
1307 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
1308 if
1309 <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>
1310 contains "efi".
1306 </para> 1311 </para>
1307 1312
1308 <para> 1313 <para>
1309 Normally, you do not use this class directly. 1314 Normally, you do not use this class directly.
1310 Instead, you add "live" to 1315 Instead, you add "live" to
1311 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>. 1316 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>.
1317 You can selectively build just one of these types through the
1318 <link linkend='var-NOISO'><filename>NOISO</filename></link>
1319 and
1320 <link linkend='var-NOHDD'><filename>NOHDD</filename></link> variables.
1312 For example, if you were building an ISO image, you would add "live" 1321 For example, if you were building an ISO image, you would add "live"
1313 to <filename>IMAGE_FSTYPES</filename>, set the 1322 to <filename>IMAGE_FSTYPES</filename>, set the
1314 <link linkend='var-NOISO'><filename>NOISO</filename></link> variable to 1323 <filename>NOISO</filename> variable to "0" and the build system would
1315 "0" and the build system would use the <filename>image-live</filename> 1324 use the <filename>image-live</filename> class to build the ISO image.
1316 class to build the ISO image.
1317 </para> 1325 </para>
1318</section> 1326</section>
1319 1327
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index be509c4a81..94558df4b9 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -3880,7 +3880,9 @@
3880 <para> 3880 <para>
3881 See the 3881 See the
3882 <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link> 3882 <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link>
3883 class for more information. 3883 and
3884 <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
3885 classes for more information.
3884 </para> 3886 </para>
3885 </glossdef> 3887 </glossdef>
3886 </glossentry> 3888 </glossentry>