summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/closer-look.xml
diff options
context:
space:
mode:
authorRobert P. J. Day <rpjday@crashcourse.ca>2013-11-05 10:06:18 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-03 12:53:02 +0000
commit2a8596d06ad970c8ca7c77eddb063326f8877bd7 (patch)
tree04e6eb34870889016faeb14d33ec98a5ed63f806 /documentation/ref-manual/closer-look.xml
parentf3c4d68e9e46472208e9c5521ff1a7c8fcbea14d (diff)
downloadpoky-2a8596d06ad970c8ca7c77eddb063326f8877bd7.tar.gz
ref-manual: Grammar and typo edits to "Closer Look" section.
Patch applied from Robert P. J. Day that basically amounted to a good review of this section. Robert caught several typos and small writing issues throughout the section. (From yocto-docs rev: e44bb5897dbcc7e96bfbc730f6abe87cc2df2f3f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/closer-look.xml')
-rw-r--r--documentation/ref-manual/closer-look.xml30
1 files changed, 15 insertions, 15 deletions
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml
index 25c03e0a52..4883981985 100644
--- a/documentation/ref-manual/closer-look.xml
+++ b/documentation/ref-manual/closer-look.xml
@@ -267,7 +267,7 @@
267 267
268 <para> 268 <para>
269 The previous section described the user configurations that 269 The previous section described the user configurations that
270 define the BitBake's global behavior. 270 define BitBake's global behavior.
271 This section takes a closer look at the layers the build system 271 This section takes a closer look at the layers the build system
272 uses to further control the build. 272 uses to further control the build.
273 These layers provide Metadata for the software, machine, and 273 These layers provide Metadata for the software, machine, and
@@ -363,7 +363,7 @@
363 for what you typically find in the distribution layer: 363 for what you typically find in the distribution layer:
364 <itemizedlist> 364 <itemizedlist>
365 <listitem><para><emphasis>classes:</emphasis> 365 <listitem><para><emphasis>classes:</emphasis>
366 Class files (<filename>.bbclass</filename>) holds 366 Class files (<filename>.bbclass</filename>) hold
367 common functionality that can be shared among 367 common functionality that can be shared among
368 recipes in the distribution. 368 recipes in the distribution.
369 When your recipes inherit a class, they take on the 369 When your recipes inherit a class, they take on the
@@ -381,7 +381,7 @@
381 <listitem><para><emphasis>recipes-*:</emphasis> 381 <listitem><para><emphasis>recipes-*:</emphasis>
382 Recipes and append files that affect common 382 Recipes and append files that affect common
383 functionality across the distribution. 383 functionality across the distribution.
384 This area could include recipes and append files to 384 This area could include recipes and append files
385 to add distribution-specific configuration, 385 to add distribution-specific configuration,
386 initialization scripts, custom image recipes, 386 initialization scripts, custom image recipes,
387 and so forth.</para></listitem> 387 and so forth.</para></listitem>
@@ -421,7 +421,7 @@
421 Metadata can exist for multiple formfactors, graphics 421 Metadata can exist for multiple formfactors, graphics
422 support systems, and so forth. 422 support systems, and so forth.
423 <note> 423 <note>
424 While the figure shows several <filename>recipe-*</filename> 424 While the figure shows several <filename>recipes-*</filename>
425 directories, not all these directories appear in all 425 directories, not all these directories appear in all
426 BSP layers. 426 BSP layers.
427 </note> 427 </note>
@@ -487,7 +487,7 @@
487 487
488 <para> 488 <para>
489 Another area that plays a significant role in where source files 489 Another area that plays a significant role in where source files
490 comes from is pointed to by the 490 come from is pointed to by the
491 <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> 491 <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>
492 variable. 492 variable.
493 This area is a cache that can hold previously downloaded source. 493 This area is a cache that can hold previously downloaded source.
@@ -546,7 +546,7 @@
546 The canonical method through which to include a local project 546 The canonical method through which to include a local project
547 is to use the 547 is to use the
548 <link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link> 548 <link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>
549 class to include local project. 549 class to include that local project.
550 You use either the <filename>local.conf</filename> or a 550 You use either the <filename>local.conf</filename> or a
551 recipe's append file to override or set the 551 recipe's append file to override or set the
552 recipe to point to the local directory on your disk to pull 552 recipe to point to the local directory on your disk to pull
@@ -704,11 +704,11 @@
704 </para> 704 </para>
705 705
706 <para> 706 <para>
707 Unpacked source source files are pointed to by the 707 Unpacked source files are pointed to by the
708 <link linkend='var-S'><filename>S</filename></link> variable. 708 <link linkend='var-S'><filename>S</filename></link> variable.
709 Each recipe has an area in the Build Directory where the 709 Each recipe has an area in the Build Directory where the
710 unpacked source code resides. 710 unpacked source code resides.
711 The name of directory for any given recipe is defined from 711 The name of that directory for any given recipe is defined from
712 several different variables. 712 several different variables.
713 You can see the variables that define these directories 713 You can see the variables that define these directories
714 by looking at the figure: 714 by looking at the figure:
@@ -809,7 +809,7 @@
809 variable. 809 variable.
810 For information on how this variable works within 810 For information on how this variable works within
811 that class, see the 811 that class, see the
812 <filename>meta/classes/autotools.bbclass</filename>. 812 <filename>meta/classes/autotools.bbclass</filename> file.
813 </para></listitem> 813 </para></listitem>
814 <listitem><para><emphasis><filename>do_compile</filename>:</emphasis> 814 <listitem><para><emphasis><filename>do_compile</filename>:</emphasis>
815 Once a configuration task has been satisfied, BitBake 815 Once a configuration task has been satisfied, BitBake
@@ -818,8 +818,8 @@
818 Compilation occurs in the directory pointed to by the 818 Compilation occurs in the directory pointed to by the
819 <link linkend='var-B'><filename>B</filename></link> 819 <link linkend='var-B'><filename>B</filename></link>
820 variable. 820 variable.
821 Realize that the <filename>B</filename> directory, by 821 Realize that the <filename>B</filename> directory is, by
822 default, is the same as the 822 default, the same as the
823 <link linkend='var-S'><filename>S</filename></link> 823 <link linkend='var-S'><filename>S</filename></link>
824 directory.</para></listitem> 824 directory.</para></listitem>
825 <listitem><para><emphasis><filename>do_install</filename>:</emphasis> 825 <listitem><para><emphasis><filename>do_install</filename>:</emphasis>
@@ -948,7 +948,7 @@
948 948
949 <para> 949 <para>
950 During image generation, the build system attempts to run 950 During image generation, the build system attempts to run
951 all post installation scripts. 951 all post-installation scripts.
952 Any that fail to run on the build host are run on the 952 Any that fail to run on the build host are run on the
953 target when the target system is first booted. 953 target when the target system is first booted.
954 If you are using a 954 If you are using a
@@ -1052,7 +1052,7 @@
1052 <para> 1052 <para>
1053 The images produced by the OpenEmbedded build system 1053 The images produced by the OpenEmbedded build system
1054 are compressed forms of the 1054 are compressed forms of the
1055 root filesystems that are ready to boot on a target device. 1055 root filesystem that are ready to boot on a target device.
1056 You can see from the 1056 You can see from the
1057 <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> 1057 <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>
1058 that BitBake output in part consists of images. 1058 that BitBake output in part consists of images.
@@ -1062,14 +1062,14 @@
1062 1062
1063 <para> 1063 <para>
1064 For a list of example images that the Yocto Project provides, 1064 For a list of example images that the Yocto Project provides,
1065 the 1065 see the
1066 "<link linkend='ref-images'>Images</link>" chapter. 1066 "<link linkend='ref-images'>Images</link>" chapter.
1067 </para> 1067 </para>
1068 1068
1069 <para> 1069 <para>
1070 Images are written out to the 1070 Images are written out to the
1071 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 1071 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
1072 inside the <filename>deploy/images/&lt;machine&gt;/</filename> 1072 inside the <filename>tmp/deploy/images/&lt;machine&gt;/</filename>
1073 folder as shown in the figure. 1073 folder as shown in the figure.
1074 This folder contains any files expected to be loaded on the 1074 This folder contains any files expected to be loaded on the
1075 target device. 1075 target device.