aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-04-07 09:52:49 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-04-08 14:20:15 +0100
commit97d7aeb168409c2797662e08d3b5b3feed43122b (patch)
tree0fe0512caae0e16e570a1bbcd5eb8dbeaa24b7ee /documentation
parentd4a245824c649f7f4dbb4a3dbb0b2bc6cc515247 (diff)
downloadopenembedded-core-contrib-97d7aeb168409c2797662e08d3b5b3feed43122b.tar.gz
ref-manual: Edits to the image-live class description.
Fixes [YOCTO #605] I added an example showing what the user would need to do in order to build an ISO file. This seemed to be the best existing place in the YP docs to get this information in. (From yocto-docs rev: a715c28e533f723e0c2d4ab4d33b86b93fa2d66b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-classes.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index fae0c7832b..babe9bd2d6 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1154,9 +1154,17 @@
<para>
The <filename>image-live</filename> class supports building "live"
images.
+ </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>.
+ 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.
</para>
</section>