summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-10-01 08:51:21 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-10-02 17:41:32 +0100
commit175e4bd923f34e088cd1965b3658a52a52d0b105 (patch)
tree704babf8049adbdef95dc596161cbdde7b18ba06
parentfc50139a1a50b45e6d2a0a4be2c07eb6d684cf8a (diff)
downloadpoky-175e4bd923f34e088cd1965b3658a52a52d0b105.tar.gz
documentation: dev-manual - Changes to "Source Directory" use.
I standardized the use of the term "Source Directory" when referring to the poky directory as set up on the host. (From yocto-docs rev: 3eaf7a734a4eecab2be2c8e71bee4d6c2cb7788b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-model.xml23
1 files changed, 12 insertions, 11 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index cf489df5c5..54a2beca4c 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -102,11 +102,11 @@
102 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both 102 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both
103 in the Yocto Project Quick Start for requirements.</para></listitem> 103 in the Yocto Project Quick Start for requirements.</para></listitem>
104 <listitem><para><emphasis>Establish a local copy of the project files on your 104 <listitem><para><emphasis>Establish a local copy of the project files on your
105 system</emphasis>: You need this <link linkend='source-directory'>source 105 system</emphasis>: You need this <link linkend='source-directory'>Source
106 directory</link> available on your host system. 106 Directory</link> available on your host system.
107 Having these files on your system gives you access to the build 107 Having these files on your system gives you access to the build
108 process and to the tools you need. 108 process and to the tools you need.
109 For information on how to set up the source directory, see the 109 For information on how to set up the Source Directory, see the
110 "<link linkend='getting-setup'>Getting Setup</link>" section.</para></listitem> 110 "<link linkend='getting-setup'>Getting Setup</link>" section.</para></listitem>
111 <listitem><para><emphasis>Establish a local copy of the base BSP files</emphasis>: Having 111 <listitem><para><emphasis>Establish a local copy of the base BSP files</emphasis>: Having
112 the BSP files on your system gives you access to the build 112 the BSP files on your system gives you access to the build
@@ -159,7 +159,7 @@
159 Yocto Project release: <filename>atom-pc</filename>, <filename>beagleboard</filename>, 159 Yocto Project release: <filename>atom-pc</filename>, <filename>beagleboard</filename>,
160 <filename>mpc8315e</filename>, and <filename>routerstationpro</filename>. 160 <filename>mpc8315e</filename>, and <filename>routerstationpro</filename>.
161 The recipes and configurations for these four BSPs are located and dispersed 161 The recipes and configurations for these four BSPs are located and dispersed
162 within the <link linkend='source-directory'>source directory</link>. 162 within the <link linkend='source-directory'>Source Directory</link>.
163 On the other hand, BSP layers for Cedar Trail, Chief River, Crown Bay, 163 On the other hand, BSP layers for Cedar Trail, Chief River, Crown Bay,
164 Crystal Forest, Emenlow, Fish River, Fish River 2, Jasper Forest, N450, 164 Crystal Forest, Emenlow, Fish River, Fish River 2, Jasper Forest, N450,
165 Romley, sys940x, Sugar Bay, and tlk exist in their own separate layers 165 Romley, sys940x, Sugar Bay, and tlk exist in their own separate layers
@@ -172,7 +172,7 @@
172 configuration information. 172 configuration information.
173 You can see the standard layout for the Crown Bay BSP in this example by examining the 173 You can see the standard layout for the Crown Bay BSP in this example by examining the
174 directory structure of the <filename>meta-crownbay</filename> layer inside the 174 directory structure of the <filename>meta-crownbay</filename> layer inside the
175 source directory.</para></listitem> 175 Source Directory.</para></listitem>
176 <listitem><para><emphasis>Make configuration changes to your new BSP 176 <listitem><para><emphasis>Make configuration changes to your new BSP
177 layer</emphasis>: The standard BSP layer structure organizes the files you need 177 layer</emphasis>: The standard BSP layer structure organizes the files you need
178 to edit in <filename>conf</filename> and several <filename>recipes-*</filename> 178 to edit in <filename>conf</filename> and several <filename>recipes-*</filename>
@@ -428,7 +428,7 @@
428 fragments, new kernel recipes, and the kernel <filename>.bbappend</filename> 428 fragments, new kernel recipes, and the kernel <filename>.bbappend</filename>
429 file used during the build. 429 file used during the build.
430 It is good practice to set this repository up inside your local 430 It is good practice to set this repository up inside your local
431 source directory. 431 <link linkend='source-directory'>Source Directory</link>.
432 For information on how to get these files, see the bulleted item 432 For information on how to get these files, see the bulleted item
433 "<link linkend='poky-extras-repo'>The <filename>poky-extras</filename> Git Repository</link>" 433 "<link linkend='poky-extras-repo'>The <filename>poky-extras</filename> Git Repository</link>"
434 earlier in this manual. 434 earlier in this manual.
@@ -1442,7 +1442,7 @@ directory.</para></listitem>
1442 to open a new recipe wizard.</para></listitem> 1442 to open a new recipe wizard.</para></listitem>
1443 <listitem><para>Point to your source by filling in the "SRC_URL" field. 1443 <listitem><para>Point to your source by filling in the "SRC_URL" field.
1444 For example, you can add a recipe to your 1444 For example, you can add a recipe to your
1445 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> 1445 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
1446 by defining "SRC_URL" as follows: 1446 by defining "SRC_URL" as follows:
1447 <literallayout class='monospaced'> 1447 <literallayout class='monospaced'>
1448 ftp://ftp.gnu.org/gnu/m4/m4-1.4.9.tar.gz 1448 ftp://ftp.gnu.org/gnu/m4/m4-1.4.9.tar.gz
@@ -1554,7 +1554,7 @@ directory.</para></listitem>
1554 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable. 1554 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable.
1555 Below is the default value for the <filename>S</filename> variable as defined in the 1555 Below is the default value for the <filename>S</filename> variable as defined in the
1556 <filename>meta/conf/bitbake.conf</filename> configuration file in the 1556 <filename>meta/conf/bitbake.conf</filename> configuration file in the
1557 <link linkend='source-directory'>source directory</link>: 1557 <link linkend='source-directory'>Source Directory</link>:
1558 <literallayout class='monospaced'> 1558 <literallayout class='monospaced'>
1559 S = ${WORKDIR}/${BP} 1559 S = ${WORKDIR}/${BP}
1560 </literallayout> 1560 </literallayout>
@@ -1579,7 +1579,8 @@ directory.</para></listitem>
1579 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 1579 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
1580 </literallayout> 1580 </literallayout>
1581 Let's look at an example without variables. 1581 Let's look at an example without variables.
1582 Assuming a top-level source directory named <filename>poky</filename> 1582 Assuming a top-level <link linkend='source-directory'>Source Directory</link>
1583 named <filename>poky</filename>
1583 and a default build directory of <filename>poky/build</filename>, 1584 and a default build directory of <filename>poky/build</filename>,
1584 the following is the work directory for the <filename>acl</filename> package: 1585 the following is the work directory for the <filename>acl</filename> package:
1585 <literallayout class='monospaced'> 1586 <literallayout class='monospaced'>
@@ -1592,7 +1593,7 @@ directory.</para></listitem>
1592 <literallayout class='monospaced'> 1593 <literallayout class='monospaced'>
1593 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 1594 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
1594 </literallayout> 1595 </literallayout>
1595 Again, assuming top-level source directory named <filename>poky</filename> 1596 Again, assuming top-level Source Directory named <filename>poky</filename>
1596 and a default build directory of <filename>poky/build</filename>, the 1597 and a default build directory of <filename>poky/build</filename>, the
1597 following is the work directory for the <filename>acl</filename> package that is being 1598 following is the work directory for the <filename>acl</filename> package that is being
1598 built for a MIPS-based device: 1599 built for a MIPS-based device:
@@ -1918,7 +1919,7 @@ directory.</para></listitem>
1918 or <filename>compile</filename> commands as if they were being run by 1919 or <filename>compile</filename> commands as if they were being run by
1919 the OpenEmbedded build system itself. 1920 the OpenEmbedded build system itself.
1920 As noted earlier, the working directory also automatically changes to the 1921 As noted earlier, the working directory also automatically changes to the
1921 source directory (<ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink>). 1922 Source Directory (<ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink>).
1922 </para> 1923 </para>
1923 1924
1924 <para> 1925 <para>