summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-04-15 07:57:37 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-04-18 16:28:24 +0100
commit4d5ff5e0757b72112c902fb067fa91907759ff18 (patch)
tree946c4030b6c5bc290ac709f927a8f18fa1b2f3d1 /documentation
parentcd2aaaa31008b7aae4b9ef7b2b7aacb6ffce174f (diff)
downloadpoky-4d5ff5e0757b72112c902fb067fa91907759ff18.tar.gz
ref-manual, dev-manual: Scrubbed boot-directdisk and bootimg classes
These classes have been removed. The bootimg class was sucked into the image-live class. I removed the reference sections to both classes and fixed the references throughout the manual set as needed. (From yocto-docs rev: 649d56b54987580039cbd52f54642112f810ffad) 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/dev-manual/dev-manual-common-tasks.xml4
-rw-r--r--documentation/ref-manual/ref-classes.xml58
-rw-r--r--documentation/ref-manual/ref-variables.xml8
3 files changed, 6 insertions, 64 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 927dcf021b..e97cc734f9 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -3843,8 +3843,8 @@
3843 standalone utility that initially provides 3843 standalone utility that initially provides
3844 easier-to-use and more flexible replacements for a 3844 easier-to-use and more flexible replacements for a
3845 couple bits of existing functionality in OE Core's 3845 couple bits of existing functionality in OE Core's
3846 <filename>boot-directdisk.bbclass</filename> and 3846 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-image-live'><filename>image-live</filename></ulink>
3847 <filename>mkefidisk.sh</filename> scripts. 3847 class and <filename>mkefidisk.sh</filename> script.
3848 The difference between 3848 The difference between
3849 <filename>wic</filename> and those examples is 3849 <filename>wic</filename> and those examples is
3850 that with <filename>wic</filename> the 3850 that with <filename>wic</filename> the
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 1351991985..ccab5e68ab 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -319,64 +319,6 @@
319 </para> 319 </para>
320</section> 320</section>
321 321
322<section id='ref-classes-boot-directdisk'>
323 <title><filename>boot-directdisk.bbclass</filename></title>
324
325 <para>
326 The <filename>boot-directdisk</filename> class
327 creates an image that can be placed directly onto a hard disk using
328 <filename>dd</filename> and then booted.
329 The image uses SYSLINUX.
330 </para>
331
332 <para>
333 The end result is a 512 boot sector populated with a
334 Master Boot Record (MBR) and partition table followed by an MSDOS
335 FAT16 partition containing SYSLINUX and a Linux kernel completed by
336 the <filename>ext2</filename> and <filename>ext3</filename>
337 root filesystems.
338 </para>
339</section>
340
341<section id='ref-classes-bootimg'>
342 <title><filename>bootimg.bbclass</filename></title>
343
344 <para>
345 The <filename>bootimg</filename> class creates a bootable
346 image using SYSLINUX, your kernel, and an optional initial RAM disk
347 (<filename>initrd</filename>).
348 </para>
349
350 <para>
351 When you use this class, two things happen:
352 <itemizedlist>
353 <listitem><para>
354 A <filename>.hddimg</filename> file is created.
355 This file is an MSDOS filesystem that contains SYSLINUX,
356 a kernel, an <filename>initrd</filename>, and a root filesystem
357 image.
358 All three of these can be written to hard drives directly and
359 also booted on a USB flash disks using <filename>dd</filename>.
360 </para></listitem>
361 <listitem><para>
362 A CD <filename>.iso</filename> image is created.
363 When this file is booted, the <filename>initrd</filename>
364 boots and processes the label selected in SYSLINUX.
365 Actions based on the label are then performed (e.g. installing
366 to a hard drive).</para></listitem>
367 </itemizedlist>
368 </para>
369
370 <para>
371 The <filename>bootimg</filename> class supports the
372 <link linkend='var-INITRD'><filename>INITRD</filename></link>,
373 <link linkend='var-NOISO'><filename>NOISO</filename></link>,
374 <link linkend='var-NOHDD'><filename>NOHDD</filename></link>, and
375 <link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>
376 variables.
377 </para>
378</section>
379
380<section id='ref-classes-bugzilla'> 322<section id='ref-classes-bugzilla'>
381 <title><filename>bugzilla.bbclass</filename></title> 323 <title><filename>bugzilla.bbclass</filename></title>
382 324
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 244f68a3f7..d66fe1b0c6 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -6109,7 +6109,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6109 <para> 6109 <para>
6110 The <filename>INITRD</filename> variable is an optional 6110 The <filename>INITRD</filename> variable is an optional
6111 variable used with the 6111 variable used with the
6112 <link linkend='ref-classes-bootimg'><filename>bootimg</filename></link> 6112 <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
6113 class. 6113 class.
6114 </para> 6114 </para>
6115 </glossdef> 6115 </glossdef>
@@ -8073,7 +8073,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8073 Causes the OpenEmbedded build system to skip building the 8073 Causes the OpenEmbedded build system to skip building the
8074 <filename>.hddimg</filename> image. 8074 <filename>.hddimg</filename> image.
8075 The <filename>NOHDD</filename> variable is used with the 8075 The <filename>NOHDD</filename> variable is used with the
8076 <link linkend='ref-classes-bootimg'><filename>bootimg</filename></link> 8076 <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
8077 class. 8077 class.
8078 Set the variable to "1" to prevent the 8078 Set the variable to "1" to prevent the
8079 <filename>.hddimg</filename> image from being built. 8079 <filename>.hddimg</filename> image from being built.
@@ -8091,7 +8091,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8091 Causes the OpenEmbedded build system to skip building the 8091 Causes the OpenEmbedded build system to skip building the
8092 ISO image. 8092 ISO image.
8093 The <filename>NOISO</filename> variable is used with the 8093 The <filename>NOISO</filename> variable is used with the
8094 <link linkend='ref-classes-bootimg'><filename>bootimg</filename></link> 8094 <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
8095 class. 8095 class.
8096 Set the variable to "1" to prevent the ISO image from 8096 Set the variable to "1" to prevent the ISO image from
8097 being built. 8097 being built.
@@ -10212,7 +10212,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10212 <para> 10212 <para>
10213 The <filename>ROOTFS</filename> variable is an optional 10213 The <filename>ROOTFS</filename> variable is an optional
10214 variable used with the 10214 variable used with the
10215 <link linkend='ref-classes-bootimg'><filename>bootimg</filename></link> 10215 <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
10216 class. 10216 class.
10217 </para> 10217 </para>
10218 </glossdef> 10218 </glossdef>