diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-11-26 08:55:01 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-03 12:53:24 +0000 |
commit | 77f2a85f6065f91d9627e09946c1719364d09128 (patch) | |
tree | 4e5a70c7ecbcbd0affd0ad8d0e8632f2fe7b0b36 | |
parent | ff7f5da85ef1f67509e539e6a438685cb5e80b08 (diff) | |
download | poky-77f2a85f6065f91d9627e09946c1719364d09128.tar.gz |
ref-manual: Added bootimg class description.
(From yocto-docs rev: f39da3cecf4d2f066b8a7becc175dc02446dafa6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index c1c3baa392..ce8f6a6ba2 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -256,6 +256,45 @@ | |||
256 | </para> | 256 | </para> |
257 | </section> | 257 | </section> |
258 | 258 | ||
259 | <section id='ref-classes-bootimg.bbclass'> | ||
260 | <title><filename>bootimg.bbclass</filename></title> | ||
261 | |||
262 | <para> | ||
263 | The boot image (<filename>bootimg</filename> class creates a bootable | ||
264 | image using SYSLINUX, your kernel and an optional initial ram disk | ||
265 | (<filename>initrd</filename>). | ||
266 | </para> | ||
267 | |||
268 | <para> | ||
269 | When you use this class, two things happen: | ||
270 | <itemizedlist> | ||
271 | <listitem><para> | ||
272 | A <filename>.hddimg</filename> file is created. | ||
273 | This file which is an MSDOS filesystem that contains SYSLINUX, | ||
274 | a kernel, an <filename>initrd</filename>, and a root filesystem | ||
275 | image. | ||
276 | All three of these can be written to hard drives directly and | ||
277 | also booted on a USB flash disks using <filename>dd</filename>. | ||
278 | </para></listitem> | ||
279 | <listitem><para> | ||
280 | A CD <filename>.iso</filename> image is created. | ||
281 | When this file is booted, the <filename>initrd</filename> | ||
282 | boots and processes the label selected in SYSLINUX. | ||
283 | Actions based on the label are then performed (e.g. installing | ||
284 | to a hard drive).</para></listitem> | ||
285 | </itemizedlist> | ||
286 | </para> | ||
287 | |||
288 | <para> | ||
289 | The <filename>bootimg</filename> class supports the | ||
290 | <link linkend='var-INITRD'><filename>INITRD</filename></link>, | ||
291 | <link linkend='var-NOISO'><filename>NOISO</filename></link>, | ||
292 | <link linkend='var-NOHDD'><filename>NOHDD</filename></link>, and | ||
293 | <link linkend='var-ROOTFS'><filename>ROOTFS</filename></link> | ||
294 | variables. | ||
295 | </para> | ||
296 | </section> | ||
297 | |||
259 | <section id='ref-classes-debian'> | 298 | <section id='ref-classes-debian'> |
260 | <title>Debian Renaming - <filename>debian.bbclass</filename></title> | 299 | <title>Debian Renaming - <filename>debian.bbclass</filename></title> |
261 | 300 | ||