summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-12-09 08:37:17 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-11 14:19:29 +0000
commita6f4ea77bf7920383fcf75e664db8585e73fbf1a (patch)
treed426ae00085096695e29302b2129c559048ee700 /documentation
parent3a9d7760f88ca159dc840851e9f55f6d619d6ee5 (diff)
downloadpoky-a6f4ea77bf7920383fcf75e664db8585e73fbf1a.tar.gz
ref-manual: Edits to classes "I" through "K"
Added opening reason for the icecc class. Also cleared up the sentence describing ICECC_PATH. Minor fix to image class. Also added some reference links. Minor fix to image-mklibs class. Also combined rouge sentence stating that the class in enabled. Same fix to rogue sentence in image-prelink class. Fixed "insserve" into "insserv" throughout. Added many links to some missing classes in the kernel class. Subsequent commit to actually add the class documentation. (From yocto-docs rev: 150de3e52d6c8c775b1128118e7d6eff51014c4e) 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.xml66
1 files changed, 40 insertions, 26 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 9a095a21bc..0dc8c8d5f8 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -902,9 +902,15 @@
902 <title><filename>icecc.bbclass</filename></title> 902 <title><filename>icecc.bbclass</filename></title>
903 903
904 <para> 904 <para>
905 The <filename>icecc</filename> class stages directories with symlinks 905 The <filename>icecc</filename> class supports Icecream, which
906 from <filename>gcc</filename> and <filename>g++</filename> to 906 facilitates taking compile jobs and distributing them among remote
907 <filename>icecc</filename>, for both native and cross compilers. 907 machines to achieve parallelism during the build.
908 </para>
909
910 <para>
911 The class stages directories with symlinks from <filename>gcc</filename>
912 and <filename>g++</filename> to <filename>icecc</filename>, for both
913 native and cross compilers.
908 Depending on each configure or compile, the OpenEmbedded build system 914 Depending on each configure or compile, the OpenEmbedded build system
909 adds the directories at the head of the <filename>PATH</filename> list 915 adds the directories at the head of the <filename>PATH</filename> list
910 and then sets 916 and then sets
@@ -931,7 +937,8 @@
931 <para> 937 <para>
932 If <link linkend='var-ICECC_PATH'><filename>ICECC_PATH</filename></link> 938 If <link linkend='var-ICECC_PATH'><filename>ICECC_PATH</filename></link>
933 is not set in your <filename>local.conf</filename> file, then the 939 is not set in your <filename>local.conf</filename> file, then the
934 class tries to locate it using <filename>which</filename>. 940 class tries to locate the <filename>icecc</filename> binary
941 using <filename>which</filename>.
935 942
936 If 943 If
937 <link linkend='var-ICECC_ENV_EXEC'><filename>ICECC_ENV_EXEC</filename></link> 944 <link linkend='var-ICECC_ENV_EXEC'><filename>ICECC_ENV_EXEC</filename></link>
@@ -977,8 +984,8 @@
977 in different formats. 984 in different formats.
978 First, the root filesystem is created from packages using 985 First, the root filesystem is created from packages using
979 one of the <filename>rootfs_*.bbclass</filename> 986 one of the <filename>rootfs_*.bbclass</filename>
980 files (depending on the package format used) and then the image is 987 files (depending on the package format used) and then one or more image
981 created. 988 files are created.
982 <itemizedlist> 989 <itemizedlist>
983 <listitem><para>The 990 <listitem><para>The
984 <filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></filename> 991 <filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></filename>
@@ -989,6 +996,11 @@
989 variable controls the list of packages to install into the 996 variable controls the list of packages to install into the
990 image.</para></listitem> 997 image.</para></listitem>
991 </itemizedlist> 998 </itemizedlist>
999 For more information on customizing images, see the
1000 "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage'>Customizing Images</ulink>"
1001 section in the Yocto Project Development Manual and the
1002 "<link linkend='images-dev-environment'>Images</link>" section elsewhere
1003 in this manual.
992 </para> 1004 </para>
993</section> 1005</section>
994 1006
@@ -1042,20 +1054,17 @@
1042 <title><filename>image-mklibs.bbclass</filename></title> 1054 <title><filename>image-mklibs.bbclass</filename></title>
1043 1055
1044 <para> 1056 <para>
1045 The <filename>mklibs</filename> class 1057 The <filename>image-mklibs</filename> class
1046 enables the use of the <filename>mklibs</filename> utility during the 1058 enables the use of the <filename>mklibs</filename> utility during the
1047 <filename>do_rootfs</filename> task, which optimizes the size of 1059 <filename>do_rootfs</filename> task, which optimizes the size of
1048 libraries contained in the image. 1060 libraries contained in the image.
1049 </para> 1061 </para>
1050 1062
1051 <para> 1063 <para>
1052 The
1053 <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link>
1054 variable enables this class.
1055 By default, the class is enabled in the 1064 By default, the class is enabled in the
1056 <filename>local.conf.template</filename> in the 1065 <filename>local.conf.template</filename> using the
1057 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> 1066 <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link>
1058 as follows: 1067 variable as follows:
1059 <literallayout class='monospaced'> 1068 <literallayout class='monospaced'>
1060 USER_CLASSES ?= "buildstats image-mklibs image-prelink" 1069 USER_CLASSES ?= "buildstats image-mklibs image-prelink"
1061 </literallayout> 1070 </literallayout>
@@ -1073,13 +1082,10 @@
1073 </para> 1082 </para>
1074 1083
1075 <para> 1084 <para>
1076 The
1077 <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link>
1078 variable enables this class.
1079 By default, the class is enabled in the 1085 By default, the class is enabled in the
1080 <filename>local.conf.template</filename> in the 1086 <filename>local.conf.template</filename> using the
1081 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> 1087 <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link>
1082 as follows: 1088 variable as follows:
1083 <literallayout class='monospaced'> 1089 <literallayout class='monospaced'>
1084 USER_CLASSES ?= "buildstats image-mklibs image-prelink" 1090 USER_CLASSES ?= "buildstats image-mklibs image-prelink"
1085 </literallayout> 1091 </literallayout>
@@ -1475,11 +1481,11 @@
1475 </para> 1481 </para>
1476</section> 1482</section>
1477 1483
1478<section id='ref-classes-insserve'> 1484<section id='ref-classes-insserv'>
1479 <title><filename>insserve.bbclass</filename></title> 1485 <title><filename>insserv.bbclass</filename></title>
1480 1486
1481 <para> 1487 <para>
1482 The <filename>insserve</filename> class 1488 The <filename>insserv</filename> class
1483 uses the <filename>insserv</filename> utility to update the order of 1489 uses the <filename>insserv</filename> utility to update the order of
1484 symbolic links in <filename>/etc/rc?.d/</filename> within an image 1490 symbolic links in <filename>/etc/rc?.d/</filename> within an image
1485 based on dependencies specified by LSB headers in the 1491 based on dependencies specified by LSB headers in the
@@ -1495,7 +1501,10 @@
1495 The class contains code to build all kernel trees. 1501 The class contains code to build all kernel trees.
1496 All needed headers are staged into the 1502 All needed headers are staged into the
1497 <filename><link linkend='var-STAGING_KERNEL_DIR'>STAGING_KERNEL_DIR</link></filename> 1503 <filename><link linkend='var-STAGING_KERNEL_DIR'>STAGING_KERNEL_DIR</link></filename>
1498 directory to allow out-of-tree module builds using <filename>module.bbclass</filename>. 1504 directory to allow out-of-tree module builds using
1505 the
1506 <link linkend='ref-classes-module'><filename>module</filename></link>
1507 class.
1499 </para> 1508 </para>
1500 1509
1501 <para> 1510 <para>
@@ -1507,9 +1516,14 @@
1507 </para> 1516 </para>
1508 1517
1509 <para> 1518 <para>
1510 Various other classes are used by the kernel and module classes internally including 1519 Various other classes are used by the <filename>kernel</filename>
1511 <filename>kernel-arch.bbclass</filename>, <filename>module_strip.bbclass</filename>, 1520 and <filename>module</filename> classes internally including the
1512 <filename>module-base.bbclass</filename>, and <filename>linux-kernel-base.bbclass</filename>. 1521 <link linkend='ref-classes-kernel-arch'><filename>kernel-arch</filename></link>,
1522 <link linkend='ref-classes-module_strip'><filename>module_strip</filename></link>,
1523 <link linkend='ref-classes-module-base'><filename>module-base</filename></link>,
1524 and
1525 <link linkend='ref-classes-linux-kernel-base'><filename>linux-kernel-base</filename></link>
1526 classes.
1513 </para> 1527 </para>
1514</section> 1528</section>
1515 1529