diff options
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 32 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 35 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 52 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 31 |
4 files changed, 79 insertions, 71 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 20742ad539..b909305f68 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -208,7 +208,7 @@ | |||
208 | To enable your layer, simply add your layer's path to the | 208 | To enable your layer, simply add your layer's path to the |
209 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'>BBLAYERS</ulink></filename> | 209 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'>BBLAYERS</ulink></filename> |
210 | variable in your <filename>conf/bblayers.conf</filename> file, which is found in the | 210 | variable in your <filename>conf/bblayers.conf</filename> file, which is found in the |
211 | <link linkend='build-directory'>build directory</link>. | 211 | <link linkend='build-directory'>Build Directory</link>. |
212 | The following example shows how to enable a layer named <filename>meta-mylayer</filename>: | 212 | The following example shows how to enable a layer named <filename>meta-mylayer</filename>: |
213 | <literallayout class='monospaced'> | 213 | <literallayout class='monospaced'> |
214 | LCONF_VERSION = "6" | 214 | LCONF_VERSION = "6" |
@@ -315,7 +315,7 @@ | |||
315 | <literallayout class='monospaced'> | 315 | <literallayout class='monospaced'> |
316 | FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" | 316 | FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" |
317 | 317 | ||
318 | PRINC := "${@int(PRINC) + 1}" | 318 | PRINC := "${@int(PRINC) + 2}" |
319 | </literallayout> | 319 | </literallayout> |
320 | This example adds or overrides files in | 320 | This example adds or overrides files in |
321 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> | 321 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> |
@@ -581,7 +581,7 @@ | |||
581 | You can also add more features by configuring the | 581 | You can also add more features by configuring the |
582 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</ulink></filename> | 582 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</ulink></filename> |
583 | variable in the <filename>local.conf</filename> file found in the Source Directory | 583 | variable in the <filename>local.conf</filename> file found in the Source Directory |
584 | located in the build directory. | 584 | located in the Build Directory. |
585 | </para> | 585 | </para> |
586 | 586 | ||
587 | <para> | 587 | <para> |
@@ -1240,7 +1240,7 @@ | |||
1240 | combination of multiple libraries you want to build. | 1240 | combination of multiple libraries you want to build. |
1241 | You accomplish this through your <filename>local.conf</filename> | 1241 | You accomplish this through your <filename>local.conf</filename> |
1242 | configuration file in the | 1242 | configuration file in the |
1243 | <link linkend='build-directory'>build directory</link>. | 1243 | <link linkend='build-directory'>Build Directory</link>. |
1244 | An example configuration would be as follows: | 1244 | An example configuration would be as follows: |
1245 | <literallayout class='monospaced'> | 1245 | <literallayout class='monospaced'> |
1246 | MACHINE = "qemux86-64" | 1246 | MACHINE = "qemux86-64" |
@@ -1285,7 +1285,7 @@ | |||
1285 | <listitem><para>A unique architecture is defined for the Multilib packages, | 1285 | <listitem><para>A unique architecture is defined for the Multilib packages, |
1286 | along with creating a unique deploy folder under | 1286 | along with creating a unique deploy folder under |
1287 | <filename>tmp/deploy/rpm</filename> in the | 1287 | <filename>tmp/deploy/rpm</filename> in the |
1288 | <link linkend='build-directory'>build directory</link>. | 1288 | <link linkend='build-directory'>Build Directory</link>. |
1289 | For example, consider <filename>lib32</filename> in a | 1289 | For example, consider <filename>lib32</filename> in a |
1290 | <filename>qemux86-64</filename> image. | 1290 | <filename>qemux86-64</filename> image. |
1291 | The possible architectures in the system are "all", "qemux86_64", | 1291 | The possible architectures in the system are "all", "qemux86_64", |
@@ -1407,7 +1407,7 @@ | |||
1407 | Saving the selections updates the <filename>.config</filename> configuration file. | 1407 | Saving the selections updates the <filename>.config</filename> configuration file. |
1408 | This is the file that the OpenEmbedded build system uses to configure the | 1408 | This is the file that the OpenEmbedded build system uses to configure the |
1409 | kernel during the build. | 1409 | kernel during the build. |
1410 | You can find and examine this file in the build directory in | 1410 | You can find and examine this file in the Build Directory in |
1411 | <filename>tmp/work/</filename>. | 1411 | <filename>tmp/work/</filename>. |
1412 | The actual <filename>.config</filename> is located in the area where the | 1412 | The actual <filename>.config</filename> is located in the area where the |
1413 | specific kernel is built. | 1413 | specific kernel is built. |
@@ -1463,7 +1463,7 @@ | |||
1463 | placed where the OpenEmbedded build system can find and apply them. | 1463 | placed where the OpenEmbedded build system can find and apply them. |
1464 | Syntactically, the configuration statement is identical to what would appear | 1464 | Syntactically, the configuration statement is identical to what would appear |
1465 | in the <filename>.config</filename> file, which is in the | 1465 | in the <filename>.config</filename> file, which is in the |
1466 | <link linkend='build-directory'>build directory</link> in | 1466 | <link linkend='build-directory'>Build Directory</link> in |
1467 | <filename>tmp/work/<arch>-poky-linux/linux-yocto-<release-specific-string>/linux-<arch>-<build-type></filename>. | 1467 | <filename>tmp/work/<arch>-poky-linux/linux-yocto-<release-specific-string>/linux-<arch>-<build-type></filename>. |
1468 | </para> | 1468 | </para> |
1469 | 1469 | ||
@@ -1801,7 +1801,7 @@ | |||
1801 | <itemizedlist> | 1801 | <itemizedlist> |
1802 | <listitem><para><emphasis>Build for the Correct Target Architecture:</emphasis> Your | 1802 | <listitem><para><emphasis>Build for the Correct Target Architecture:</emphasis> Your |
1803 | selected <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> | 1803 | selected <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> |
1804 | definition within the <filename>local.conf</filename> file in the build directory | 1804 | definition within the <filename>local.conf</filename> file in the Build Directory |
1805 | specifies the target architecture used when building the Linux kernel. | 1805 | specifies the target architecture used when building the Linux kernel. |
1806 | By default, <filename>MACHINE</filename> is set to | 1806 | By default, <filename>MACHINE</filename> is set to |
1807 | <filename>qemux86</filename>, which specifies a 32-bit | 1807 | <filename>qemux86</filename>, which specifies a 32-bit |
@@ -1847,12 +1847,12 @@ | |||
1847 | </para></listitem> | 1847 | </para></listitem> |
1848 | <listitem><para><emphasis>Clean up</emphasis>: | 1848 | <listitem><para><emphasis>Clean up</emphasis>: |
1849 | Be sure to clean the shared state out by running the | 1849 | Be sure to clean the shared state out by running the |
1850 | <filename>cleansstate</filename> BitBake task as follows from your build directory: | 1850 | <filename>cleansstate</filename> BitBake task as follows from your Build Directory: |
1851 | <literallayout class='monospaced'> | 1851 | <literallayout class='monospaced'> |
1852 | $ bitbake -c cleansstate linux-yocto | 1852 | $ bitbake -c cleansstate linux-yocto |
1853 | </literallayout></para> | 1853 | </literallayout></para> |
1854 | <para><note>Never remove any files by hand from the <filename>tmp/deploy</filename> | 1854 | <para><note>Never remove any files by hand from the <filename>tmp/deploy</filename> |
1855 | directory inside the build directory. | 1855 | directory inside the Build Directory. |
1856 | Always use the various BitBake clean tasks to clear out previous | 1856 | Always use the various BitBake clean tasks to clear out previous |
1857 | build artifacts. | 1857 | build artifacts. |
1858 | </note></para></listitem> | 1858 | </note></para></listitem> |
@@ -2022,7 +2022,7 @@ | |||
2022 | 2022 | ||
2023 | <para> | 2023 | <para> |
2024 | By default, the OpenEmbedded build system does its work from within the | 2024 | By default, the OpenEmbedded build system does its work from within the |
2025 | <link linkend='build-directory'>build directory</link>. | 2025 | <link linkend='build-directory'>Build Directory</link>. |
2026 | The build process involves fetching the source files, unpacking them, and then patching them | 2026 | The build process involves fetching the source files, unpacking them, and then patching them |
2027 | if necessary before the build takes place. | 2027 | if necessary before the build takes place. |
2028 | </para> | 2028 | </para> |
@@ -2058,17 +2058,17 @@ | |||
2058 | 2058 | ||
2059 | <para> | 2059 | <para> |
2060 | It is important to know that the <filename>externalsrc.bbclass</filename> assumes that the | 2060 | It is important to know that the <filename>externalsrc.bbclass</filename> assumes that the |
2061 | source directory <filename>S</filename> and the build directory | 2061 | source directory <filename>S</filename> and the Build Directory |
2062 | <ulink url='&YOCTO_DOCS_REF_URL;#var-B'><filename>B</filename></ulink> | 2062 | <ulink url='&YOCTO_DOCS_REF_URL;#var-B'><filename>B</filename></ulink> |
2063 | are different even though by default these directories are the same. | 2063 | are different even though by default these directories are the same. |
2064 | This assumption is important because it supports building different variants of the recipe | 2064 | This assumption is important because it supports building different variants of the recipe |
2065 | by using the | 2065 | by using the |
2066 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></ulink> | 2066 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></ulink> |
2067 | variable. | 2067 | variable. |
2068 | You could allow the build directory to be the same as the source directory but you would | 2068 | You could allow the Build Directory to be the same as the source directory but you would |
2069 | not be able to build more than one variant of the recipe. | 2069 | not be able to build more than one variant of the recipe. |
2070 | Consequently, if you are building multiple variants of the recipe, you need to establish a | 2070 | Consequently, if you are building multiple variants of the recipe, you need to establish a |
2071 | build directory that is different than the source directory. | 2071 | Build Directory that is different than the source directory. |
2072 | </para> | 2072 | </para> |
2073 | </section> | 2073 | </section> |
2074 | 2074 | ||
@@ -2114,7 +2114,7 @@ | |||
2114 | <para> | 2114 | <para> |
2115 | To enable this behavior, simply add the following to the <filename>local.conf</filename> | 2115 | To enable this behavior, simply add the following to the <filename>local.conf</filename> |
2116 | configuration file found in the | 2116 | configuration file found in the |
2117 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>: | 2117 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: |
2118 | <literallayout class='monospaced'> | 2118 | <literallayout class='monospaced'> |
2119 | SRCREV_pn-<PN> = "${AUTOREV}" | 2119 | SRCREV_pn-<PN> = "${AUTOREV}" |
2120 | </literallayout> | 2120 | </literallayout> |
@@ -2545,7 +2545,7 @@ | |||
2545 | </para> | 2545 | </para> |
2546 | 2546 | ||
2547 | <para> | 2547 | <para> |
2548 | Downloaded archives reside in the build directory in | 2548 | Downloaded archives reside in the Build Directory in |
2549 | <filename>/tmp</filename> and are cleared up when they are no longer in use. | 2549 | <filename>/tmp</filename> and are cleared up when they are no longer in use. |
2550 | </para> | 2550 | </para> |
2551 | 2551 | ||
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 4452d2a4e2..c14c524aa5 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml | |||
@@ -236,7 +236,7 @@ | |||
236 | "<link linkend='patching-the-kernel'>Patching the Kernel</link>" section | 236 | "<link linkend='patching-the-kernel'>Patching the Kernel</link>" section |
237 | for an example that changes the source code of the kernel. | 237 | for an example that changes the source code of the kernel. |
238 | For information on how to configure the kernel, see the | 238 | For information on how to configure the kernel, see the |
239 | "<link linkend='configuring-the-kernel'>Configuring the Kernel</link> section. | 239 | "<link linkend='configuring-the-kernel'>Configuring the Kernel</link>" section. |
240 | </para> | 240 | </para> |
241 | 241 | ||
242 | <section id='kernel-overview'> | 242 | <section id='kernel-overview'> |
@@ -347,7 +347,8 @@ | |||
347 | What happens during the build? | 347 | What happens during the build? |
348 | When you build the kernel on your development system, all files needed for the build | 348 | When you build the kernel on your development system, all files needed for the build |
349 | are taken from the source repositories pointed to by the | 349 | are taken from the source repositories pointed to by the |
350 | <filename>SRC_URI</filename> variable and gathered in a temporary work area | 350 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> variable |
351 | and gathered in a temporary work area | ||
351 | where they are subsequently used to create the unique kernel. | 352 | where they are subsequently used to create the unique kernel. |
352 | Thus, in a sense, the process constructs a local source tree specific to your | 353 | Thus, in a sense, the process constructs a local source tree specific to your |
353 | kernel to generate the new kernel image - a source generator if you will. | 354 | kernel to generate the new kernel image - a source generator if you will. |
@@ -394,8 +395,8 @@ | |||
394 | "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both | 395 | "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both |
395 | in the Yocto Project Quick Start for requirements.</para></listitem> | 396 | in the Yocto Project Quick Start for requirements.</para></listitem> |
396 | <listitem><para><emphasis>Establish a local copy of project files on your | 397 | <listitem><para><emphasis>Establish a local copy of project files on your |
397 | system</emphasis>: Having the <link linkend='source-directory'>source | 398 | system</emphasis>: Having the <link linkend='source-directory'>Source |
398 | directory</link> on your system gives you access to the build process and tools | 399 | Directory</link> on your system gives you access to the build process and tools |
399 | you need. | 400 | you need. |
400 | For information on how to get these files, see the bulleted item | 401 | For information on how to get these files, see the bulleted item |
401 | "<link linkend='local-yp-release'>Yocto Project Release</link>" earlier in this manual. | 402 | "<link linkend='local-yp-release'>Yocto Project Release</link>" earlier in this manual. |
@@ -439,7 +440,7 @@ | |||
439 | <filename>.config</filename>. | 440 | <filename>.config</filename>. |
440 | Try to resist the temptation of directly editing the <filename>.config</filename> | 441 | Try to resist the temptation of directly editing the <filename>.config</filename> |
441 | file found in the | 442 | file found in the |
442 | <link linkend='build-directory'>build directory</link> at | 443 | <link linkend='build-directory'>Build Directory</link> at |
443 | <filename>tmp/sysroots/<machine-name>/kernel</filename>. | 444 | <filename>tmp/sysroots/<machine-name>/kernel</filename>. |
444 | Doing so, can produce unexpected results when the OpenEmbedded build system | 445 | Doing so, can produce unexpected results when the OpenEmbedded build system |
445 | regenerates the configuration file.</para> | 446 | regenerates the configuration file.</para> |
@@ -986,10 +987,10 @@ | |||
986 | <listitem><para><emphasis> | 987 | <listitem><para><emphasis> |
987 | <filename>Build System Derived Toolchain:</filename></emphasis> | 988 | <filename>Build System Derived Toolchain:</filename></emphasis> |
988 | Select this mode if the cross-toolchain has been installed and built | 989 | Select this mode if the cross-toolchain has been installed and built |
989 | as part of the build directory. | 990 | as part of the Build Directory. |
990 | When you select <filename>Build system derived toolchain</filename>, | 991 | When you select <filename>Build system derived toolchain</filename>, |
991 | you are using the toolchain bundled | 992 | you are using the toolchain bundled |
992 | inside the build directory. | 993 | inside the Build Directory. |
993 | </para></listitem> | 994 | </para></listitem> |
994 | </itemizedlist> | 995 | </itemizedlist> |
995 | </para></listitem> | 996 | </para></listitem> |
@@ -1008,9 +1009,9 @@ | |||
1008 | However, doing so is discouraged.</note></para> | 1009 | However, doing so is discouraged.</note></para> |
1009 | <para>If you are using a system-derived toolchain, the path you provide | 1010 | <para>If you are using a system-derived toolchain, the path you provide |
1010 | for the <filename>Toolchain Root Location</filename> | 1011 | for the <filename>Toolchain Root Location</filename> |
1011 | field is the build directory. | 1012 | field is the Build Directory. |
1012 | See the "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using | 1013 | See the "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using |
1013 | BitBake and the build directory</ulink>" section in the Yocto Project Application | 1014 | BitBake and the Build Directory</ulink>" section in the Yocto Project Application |
1014 | Developer's Guide for information on how to install the toolchain into the build | 1015 | Developer's Guide for information on how to install the toolchain into the build |
1015 | directory.</para></listitem> | 1016 | directory.</para></listitem> |
1016 | <listitem><para><emphasis>Specify the Sysroot Location:</emphasis> | 1017 | <listitem><para><emphasis>Specify the Sysroot Location:</emphasis> |
@@ -1053,7 +1054,7 @@ directory.</para></listitem> | |||
1053 | and specify any custom options.</para> | 1054 | and specify any custom options.</para> |
1054 | <para>If you selected <filename>Build system derived toolchain</filename>, | 1055 | <para>If you selected <filename>Build system derived toolchain</filename>, |
1055 | the target kernel you built will be located in the | 1056 | the target kernel you built will be located in the |
1056 | build directory in <filename>tmp/deploy/images</filename> directory. | 1057 | Build Directory in <filename>tmp/deploy/images</filename> directory. |
1057 | If you selected <filename>Standalone pre-built toolchain</filename>, the | 1058 | If you selected <filename>Standalone pre-built toolchain</filename>, the |
1058 | pre-built image you downloaded is located | 1059 | pre-built image you downloaded is located |
1059 | in the directory you specified when you downloaded the image.</para> | 1060 | in the directory you specified when you downloaded the image.</para> |
@@ -1409,7 +1410,7 @@ directory.</para></listitem> | |||
1409 | <orderedlist> | 1410 | <orderedlist> |
1410 | <listitem><para>Select your Yocto Bitbake Commander project.</para></listitem> | 1411 | <listitem><para>Select your Yocto Bitbake Commander project.</para></listitem> |
1411 | <listitem><para>Select <filename>Project -> Launch HOB</filename>.</para></listitem> | 1412 | <listitem><para>Select <filename>Project -> Launch HOB</filename>.</para></listitem> |
1412 | <listitem><para>Enter the build directory where you want to put your final images.</para></listitem> | 1413 | <listitem><para>Enter the Build Directory where you want to put your final images.</para></listitem> |
1413 | <listitem><para>Click <filename>OK</filename> to launch Hob.</para></listitem> | 1414 | <listitem><para>Click <filename>OK</filename> to launch Hob.</para></listitem> |
1414 | <listitem><para>Use Hob to customize and build your own images. | 1415 | <listitem><para>Use Hob to customize and build your own images. |
1415 | For information on Hob, see the | 1416 | For information on Hob, see the |
@@ -1480,7 +1481,7 @@ directory.</para></listitem> | |||
1480 | to figure out your solution. | 1481 | to figure out your solution. |
1481 | After you have initially built the package, you can iteratively tweak the | 1482 | After you have initially built the package, you can iteratively tweak the |
1482 | source code, which is located in the | 1483 | source code, which is located in the |
1483 | <link linkend='build-directory'>build directory</link>, and then | 1484 | <link linkend='build-directory'>Build Directory</link>, and then |
1484 | you can force a re-compile and quickly test your altered code. | 1485 | you can force a re-compile and quickly test your altered code. |
1485 | Once you settle on a solution, you can then preserve your changes in the form of | 1486 | Once you settle on a solution, you can then preserve your changes in the form of |
1486 | patches. | 1487 | patches. |
@@ -1494,7 +1495,7 @@ directory.</para></listitem> | |||
1494 | 1495 | ||
1495 | <para> | 1496 | <para> |
1496 | During a build, the unpacked temporary source code used by recipes | 1497 | During a build, the unpacked temporary source code used by recipes |
1497 | to build packages is available in the build directory as | 1498 | to build packages is available in the Build Directory as |
1498 | defined by the | 1499 | defined by the |
1499 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable. | 1500 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable. |
1500 | Below is the default value for the <filename>S</filename> variable as defined in the | 1501 | Below is the default value for the <filename>S</filename> variable as defined in the |
@@ -1528,7 +1529,7 @@ directory.</para></listitem> | |||
1528 | Let's look at an example without variables. | 1529 | Let's look at an example without variables. |
1529 | Assuming a top-level <link linkend='source-directory'>Source Directory</link> | 1530 | Assuming a top-level <link linkend='source-directory'>Source Directory</link> |
1530 | named <filename>poky</filename> | 1531 | named <filename>poky</filename> |
1531 | and a default build directory of <filename>poky/build</filename>, | 1532 | and a default Build Directory of <filename>poky/build</filename>, |
1532 | the following is the work directory for the <filename>acl</filename> recipe that | 1533 | the following is the work directory for the <filename>acl</filename> recipe that |
1533 | creates the <filename>acl</filename> package: | 1534 | creates the <filename>acl</filename> package: |
1534 | <literallayout class='monospaced'> | 1535 | <literallayout class='monospaced'> |
@@ -1543,7 +1544,7 @@ directory.</para></listitem> | |||
1543 | ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} | 1544 | ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} |
1544 | </literallayout> | 1545 | </literallayout> |
1545 | Again, assuming top-level Source Directory named <filename>poky</filename> | 1546 | Again, assuming top-level Source Directory named <filename>poky</filename> |
1546 | and a default build directory of <filename>poky/build</filename>, the | 1547 | and a default Build Directory of <filename>poky/build</filename>, the |
1547 | following are the work and temporary source directories, respectively, | 1548 | following are the work and temporary source directories, respectively, |
1548 | for the <filename>acl</filename> package that is being | 1549 | for the <filename>acl</filename> package that is being |
1549 | built for a MIPS-based device: | 1550 | built for a MIPS-based device: |
@@ -1591,7 +1592,7 @@ directory.</para></listitem> | |||
1591 | <orderedlist> | 1592 | <orderedlist> |
1592 | <listitem><para><emphasis>Find the Source Code:</emphasis> | 1593 | <listitem><para><emphasis>Find the Source Code:</emphasis> |
1593 | The temporary source code used by the OpenEmbedded build system is kept in the | 1594 | The temporary source code used by the OpenEmbedded build system is kept in the |
1594 | build directory. | 1595 | Build Directory. |
1595 | See the | 1596 | See the |
1596 | "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" | 1597 | "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" |
1597 | section to learn how to locate the directory that has the temporary source code for a | 1598 | section to learn how to locate the directory that has the temporary source code for a |
@@ -1689,7 +1690,7 @@ directory.</para></listitem> | |||
1689 | <orderedlist> | 1690 | <orderedlist> |
1690 | <listitem><para><emphasis>Find the Source Code:</emphasis> | 1691 | <listitem><para><emphasis>Find the Source Code:</emphasis> |
1691 | The temporary source code used by the OpenEmbedded build system is kept in the | 1692 | The temporary source code used by the OpenEmbedded build system is kept in the |
1692 | build directory. | 1693 | Build Directory. |
1693 | See the | 1694 | See the |
1694 | "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" | 1695 | "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" |
1695 | section to learn how to locate the directory that has the temporary source code for a | 1696 | section to learn how to locate the directory that has the temporary source code for a |
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 20cf234a6b..bb01131c05 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -130,7 +130,7 @@ | |||
130 | From the interface, you can click on any particular item in the "Name" column and | 130 | From the interface, you can click on any particular item in the "Name" column and |
131 | see the URL at the bottom of the page that you need to set up a Git repository for | 131 | see the URL at the bottom of the page that you need to set up a Git repository for |
132 | that particular item. | 132 | that particular item. |
133 | Having a local Git repository of the source directory (poky) allows you to | 133 | Having a local Git repository of the Source Directory (poky) allows you to |
134 | make changes, contribute to the history, and ultimately enhance the Yocto Project's | 134 | make changes, contribute to the history, and ultimately enhance the Yocto Project's |
135 | tools, Board Support Packages, and so forth. | 135 | tools, Board Support Packages, and so forth. |
136 | </para> | 136 | </para> |
@@ -148,7 +148,7 @@ | |||
148 | <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink> and get a | 148 | <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink> and get a |
149 | tarball of the release. | 149 | tarball of the release. |
150 | You can also go to this site to download any supported BSP tarballs. | 150 | You can also go to this site to download any supported BSP tarballs. |
151 | Unpacking the tarball gives you a hierarchical source directory that lets you develop | 151 | Unpacking the tarball gives you a hierarchical Source Directory that lets you develop |
152 | using the Yocto Project. | 152 | using the Yocto Project. |
153 | </para> | 153 | </para> |
154 | 154 | ||
@@ -220,31 +220,31 @@ | |||
220 | <para id='build-directory'><emphasis>Build Directory:</emphasis> | 220 | <para id='build-directory'><emphasis>Build Directory:</emphasis> |
221 | This term refers to the area used by the OpenEmbedded build system for builds. | 221 | This term refers to the area used by the OpenEmbedded build system for builds. |
222 | The area is created when you <filename>source</filename> the setup | 222 | The area is created when you <filename>source</filename> the setup |
223 | environment script that is found in the source directory | 223 | environment script that is found in the Source Directory |
224 | (i.e. <filename>oe-init-build-env</filename>). | 224 | (i.e. <filename>&OE_INIT_FILE;</filename>). |
225 | The <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink> | 225 | The <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink> |
226 | variable points to the build directory.</para> | 226 | variable points to the Build Directory.</para> |
227 | 227 | ||
228 | <para>You have a lot of flexibility when creating the build directory. | 228 | <para>You have a lot of flexibility when creating the Build Directory. |
229 | Following are some examples that show how to create the directory: | 229 | Following are some examples that show how to create the directory: |
230 | <itemizedlist> | 230 | <itemizedlist> |
231 | <listitem><para>Create the build directory in your current working directory | 231 | <listitem><para>Create the Build Directory in your current working directory |
232 | and name it <filename>build</filename>. | 232 | and name it <filename>build</filename>. |
233 | This is the default behavior. | 233 | This is the default behavior. |
234 | <literallayout class='monospaced'> | 234 | <literallayout class='monospaced'> |
235 | $ source oe-init-build-env | 235 | $ source &OE_INIT_PATH; |
236 | </literallayout></para></listitem> | 236 | </literallayout></para></listitem> |
237 | <listitem><para>Provide a directory path and specifically name the build | 237 | <listitem><para>Provide a directory path and specifically name the build |
238 | directory. | 238 | directory. |
239 | This next example creates a build directory named <filename>YP-&POKYVERSION;</filename> | 239 | This next example creates a Build Directory named <filename>YP-&POKYVERSION;</filename> |
240 | in your home directory within the directory <filename>mybuilds</filename>. | 240 | in your home directory within the directory <filename>mybuilds</filename>. |
241 | If <filename>mybuilds</filename> does not exist, the directory is created for you: | 241 | If <filename>mybuilds</filename> does not exist, the directory is created for you: |
242 | <literallayout class='monospaced'> | 242 | <literallayout class='monospaced'> |
243 | $ source &OE_INIT_PATH; $HOME/mybuilds/YP-&POKYVERSION; | 243 | $ source &OE_INIT_PATH; $HOME/mybuilds/YP-&POKYVERSION; |
244 | </literallayout></para></listitem> | 244 | </literallayout></para></listitem> |
245 | <listitem><para>Provide an existing directory to use as the build directory. | 245 | <listitem><para>Provide an existing directory to use as the Build Directory. |
246 | This example uses the existing <filename>mybuilds</filename> directory | 246 | This example uses the existing <filename>mybuilds</filename> directory |
247 | as the build directory. | 247 | as the Build Directory. |
248 | <literallayout class='monospaced'> | 248 | <literallayout class='monospaced'> |
249 | $ source &OE_INIT_PATH; $HOME/mybuilds/ | 249 | $ source &OE_INIT_PATH; $HOME/mybuilds/ |
250 | </literallayout></para></listitem> | 250 | </literallayout></para></listitem> |
@@ -254,7 +254,7 @@ | |||
254 | this term refers to the OpenEmbedded build system used by the project. | 254 | this term refers to the OpenEmbedded build system used by the project. |
255 | This build system is based on the project known as "Poky." | 255 | This build system is based on the project known as "Poky." |
256 | For some historical information about Poky, see the | 256 | For some historical information about Poky, see the |
257 | <link linkend='poky'>poky</link> term further along in this section. | 257 | <link linkend='poky'>Poky</link> term further along in this section. |
258 | </para></listitem> | 258 | </para></listitem> |
259 | <listitem><para><emphasis>Classes:</emphasis> Files that provide for logic encapsulation | 259 | <listitem><para><emphasis>Classes:</emphasis> Files that provide for logic encapsulation |
260 | and inheritance allowing commonly used patterns to be defined once and easily used | 260 | and inheritance allowing commonly used patterns to be defined once and easily used |
@@ -264,14 +264,14 @@ | |||
264 | <listitem><para><emphasis>Configuration File:</emphasis> Configuration information in various | 264 | <listitem><para><emphasis>Configuration File:</emphasis> Configuration information in various |
265 | <filename>.conf</filename> files provides global definitions of variables. | 265 | <filename>.conf</filename> files provides global definitions of variables. |
266 | The <filename>conf/local.conf</filename> configuration file in the | 266 | The <filename>conf/local.conf</filename> configuration file in the |
267 | <link linkend='build-directory'>build directory</link> | 267 | <link linkend='build-directory'>Build Directory</link> |
268 | contains user-defined variables that affect each build. | 268 | contains user-defined variables that affect each build. |
269 | The <filename>meta-yocto/conf/distro/poky.conf</filename> configuration file | 269 | The <filename>meta-yocto/conf/distro/poky.conf</filename> configuration file |
270 | defines Yocto ‘distro’ configuration | 270 | defines Yocto ‘distro’ configuration |
271 | variables used only when building with this policy. | 271 | variables used only when building with this policy. |
272 | Machine configuration files, which | 272 | Machine configuration files, which |
273 | are located throughout the | 273 | are located throughout the |
274 | <link linkend='source-directory'>source directory</link>, define | 274 | <link linkend='source-directory'>Source Directory</link>, define |
275 | variables for specific hardware and are only used when building for that target | 275 | variables for specific hardware and are only used when building for that target |
276 | (e.g. the <filename>machine/beagleboard.conf</filename> configuration file defines | 276 | (e.g. the <filename>machine/beagleboard.conf</filename> configuration file defines |
277 | variables for the Texas Instruments ARM Cortex-A8 development board). | 277 | variables for the Texas Instruments ARM Cortex-A8 development board). |
@@ -332,7 +332,7 @@ | |||
332 | the Yocto Project's build system. | 332 | the Yocto Project's build system. |
333 | Within the Yocto Project source repositories, poky exists as a separate Git repository | 333 | Within the Yocto Project source repositories, poky exists as a separate Git repository |
334 | that can be cloned to yield a local copy on the host system. | 334 | that can be cloned to yield a local copy on the host system. |
335 | Thus, "poky" can refer to the local copy of the source directory used to develop within | 335 | Thus, "poky" can refer to the local copy of the Source Directory used to develop within |
336 | the Yocto Project.</para></listitem> | 336 | the Yocto Project.</para></listitem> |
337 | <listitem><para><emphasis>Recipe:</emphasis> A set of instructions for building packages. | 337 | <listitem><para><emphasis>Recipe:</emphasis> A set of instructions for building packages. |
338 | A recipe describes where you get source code and which patches to apply. | 338 | A recipe describes where you get source code and which patches to apply. |
@@ -349,15 +349,15 @@ | |||
349 | Sometimes you might here the term "poky directory" used to refer to this | 349 | Sometimes you might here the term "poky directory" used to refer to this |
350 | directory structure.</para> | 350 | directory structure.</para> |
351 | 351 | ||
352 | <para>The source directory contains BitBake, Documentation, metadata and | 352 | <para>The Source Directory contains BitBake, Documentation, metadata and |
353 | other files that all support the Yocto Project. | 353 | other files that all support the Yocto Project. |
354 | Consequently, you must have the source directory in place on your development | 354 | Consequently, you must have the Source Directory in place on your development |
355 | system in order to do any development using the Yocto Project.</para> | 355 | system in order to do any development using the Yocto Project.</para> |
356 | 356 | ||
357 | <para>For tarball expansion, the name of the top-level directory of the source directory | 357 | <para>For tarball expansion, the name of the top-level directory of the Source Directory |
358 | is derived from the Yocto Project release tarball. | 358 | is derived from the Yocto Project release tarball. |
359 | For example, downloading and unpacking <filename>&YOCTO_POKY_TARBALL;</filename> | 359 | For example, downloading and unpacking <filename>&YOCTO_POKY_TARBALL;</filename> |
360 | results in a source directory whose top-level folder is named | 360 | results in a Source Directory whose top-level folder is named |
361 | <filename>&YOCTO_POKY;</filename>. | 361 | <filename>&YOCTO_POKY;</filename>. |
362 | If you create a local copy of the Git repository, then you can name the repository | 362 | If you create a local copy of the Git repository, then you can name the repository |
363 | anything you like. | 363 | anything you like. |
@@ -366,15 +366,15 @@ | |||
366 | So, for example, cloning the <filename>poky</filename> Git repository results in a | 366 | So, for example, cloning the <filename>poky</filename> Git repository results in a |
367 | local Git repository whose top-level folder is also named <filename>poky</filename>.</para> | 367 | local Git repository whose top-level folder is also named <filename>poky</filename>.</para> |
368 | 368 | ||
369 | <para>It is important to understand the differences between the source directory created | 369 | <para>It is important to understand the differences between the Source Directory created |
370 | by unpacking a released tarball as compared to cloning | 370 | by unpacking a released tarball as compared to cloning |
371 | <filename>git://git.yoctoproject.org/poky</filename>. | 371 | <filename>git://git.yoctoproject.org/poky</filename>. |
372 | When you unpack a tarball, you have an exact copy of the files based on the time of | 372 | When you unpack a tarball, you have an exact copy of the files based on the time of |
373 | release - a fixed release point. | 373 | release - a fixed release point. |
374 | Any changes you make to your local files in the source directory are on top of the release. | 374 | Any changes you make to your local files in the Source Directory are on top of the release. |
375 | On the other hand, when you clone the <filename>poky</filename> Git repository, you have an | 375 | On the other hand, when you clone the <filename>poky</filename> Git repository, you have an |
376 | active development repository. | 376 | active development repository. |
377 | In this case, any local changes you make to the source directory can be later applied | 377 | In this case, any local changes you make to the Source Directory can be later applied |
378 | to active development branches of the upstream <filename>poky</filename> Git | 378 | to active development branches of the upstream <filename>poky</filename> Git |
379 | repository.</para> | 379 | repository.</para> |
380 | 380 | ||
@@ -438,7 +438,7 @@ | |||
438 | <filename>meta/files/common-licenses</filename>. | 438 | <filename>meta/files/common-licenses</filename>. |
439 | Once the build completes, the list of all licenses found and used during that build are | 439 | Once the build completes, the list of all licenses found and used during that build are |
440 | kept in the | 440 | kept in the |
441 | <link linkend='build-directory'>build directory</link> at | 441 | <link linkend='build-directory'>Build Directory</link> at |
442 | <filename>tmp/deploy/images/licenses</filename>. | 442 | <filename>tmp/deploy/images/licenses</filename>. |
443 | </para> | 443 | </para> |
444 | 444 | ||
@@ -466,6 +466,12 @@ | |||
466 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/files/common-licenses'>here</ulink>. | 466 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/files/common-licenses'>here</ulink>. |
467 | This wiki page discusses the license infrastructure used by the Yocto Project. | 467 | This wiki page discusses the license infrastructure used by the Yocto Project. |
468 | </para> | 468 | </para> |
469 | |||
470 | <para> | ||
471 | For information that can help you to maintain compliance with various open source licensing | ||
472 | during the lifecycle of a product created using the Yocto Project, see the | ||
473 | "<link linkend='maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</link>" section. | ||
474 | </para> | ||
469 | </section> | 475 | </section> |
470 | 476 | ||
471 | <section id='git'> | 477 | <section id='git'> |
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index e55a07d87a..11d4adca9f 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -56,8 +56,9 @@ | |||
56 | OpenSUSE, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project | 56 | OpenSUSE, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project |
57 | and officially supported. | 57 | and officially supported. |
58 | For a list of the distributions under validation and their status, see the | 58 | For a list of the distributions under validation and their status, see the |
59 | <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution | 59 | "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" section |
60 | Support</ulink> wiki page.</para> | 60 | in the Yocto Project Reference Manual and the wiki page at |
61 | <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink>.</para> | ||
61 | <para> | 62 | <para> |
62 | You should also have about 100 gigabytes of free disk space for building images. | 63 | You should also have about 100 gigabytes of free disk space for building images. |
63 | </para></listitem> | 64 | </para></listitem> |
@@ -69,12 +70,12 @@ | |||
69 | for the supported distributions.</para></listitem> | 70 | for the supported distributions.</para></listitem> |
70 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> | 71 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> |
71 | You need a release of the Yocto Project. | 72 | You need a release of the Yocto Project. |
72 | You set up a with local <link linkend='source-directory'>source directory</link> | 73 | You set up a with local <link linkend='source-directory'>Source Directory</link> |
73 | one of two ways depending on whether you | 74 | one of two ways depending on whether you |
74 | are going to contribute back into the Yocto Project or not. | 75 | are going to contribute back into the Yocto Project or not. |
75 | <note> | 76 | <note> |
76 | Regardless of the method you use, this manual refers to the resulting local | 77 | Regardless of the method you use, this manual refers to the resulting local |
77 | hierarchical set of files as the "source directory." | 78 | hierarchical set of files as the "Source Directory." |
78 | </note> | 79 | </note> |
79 | <itemizedlist> | 80 | <itemizedlist> |
80 | <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute | 81 | <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute |
@@ -83,7 +84,7 @@ | |||
83 | Once you have the tarball, just extract it into a directory of your choice.</para> | 84 | Once you have the tarball, just extract it into a directory of your choice.</para> |
84 | <para>For example, the following command extracts the Yocto Project &DISTRO; | 85 | <para>For example, the following command extracts the Yocto Project &DISTRO; |
85 | release tarball | 86 | release tarball |
86 | into the current working directory and sets up the local source directory | 87 | into the current working directory and sets up the local Source Directory |
87 | with a top-level folder named <filename>&YOCTO_POKY;</filename>: | 88 | with a top-level folder named <filename>&YOCTO_POKY;</filename>: |
88 | <literallayout class='monospaced'> | 89 | <literallayout class='monospaced'> |
89 | $ tar xfj &YOCTO_POKY_TARBALL; | 90 | $ tar xfj &YOCTO_POKY_TARBALL; |
@@ -125,11 +126,11 @@ | |||
125 | You can find Git repositories of supported Yocto Project Kernels organized under | 126 | You can find Git repositories of supported Yocto Project Kernels organized under |
126 | "Yocto Linux Kernel" in the Yocto Project Source Repositories at | 127 | "Yocto Linux Kernel" in the Yocto Project Source Repositories at |
127 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> | 128 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> |
128 | <para>This setup involves creating a bare clone of the Yocto Project kernel and then | 129 | <para>This setup can involve creating a bare clone of the Yocto Project kernel and then |
129 | copying that cloned repository. | 130 | copying that cloned repository. |
130 | You can create the bare clone and the copy of the bare clone anywhere you like. | 131 | You can create the bare clone and the copy of the bare clone anywhere you like. |
131 | For simplicity, it is recommended that you create these structures outside of the | 132 | For simplicity, it is recommended that you create these structures outside of the |
132 | source directory (usually <filename>poky</filename>).</para> | 133 | Source Directory (usually <filename>poky</filename>).</para> |
133 | <para>As an example, the following transcript shows how to create the bare clone | 134 | <para>As an example, the following transcript shows how to create the bare clone |
134 | of the <filename>linux-yocto-3.4</filename> kernel and then create a copy of | 135 | of the <filename>linux-yocto-3.4</filename> kernel and then create a copy of |
135 | that clone. | 136 | that clone. |
@@ -168,9 +169,9 @@ | |||
168 | <para>You can find the <filename>poky-extras</filename> Git Repository in the | 169 | <para>You can find the <filename>poky-extras</filename> Git Repository in the |
169 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at | 170 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at |
170 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. | 171 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. |
171 | It is good practice to create this Git repository inside the source directory.</para> | 172 | It is good practice to create this Git repository inside the Source Directory.</para> |
172 | <para>Following is an example that creates the <filename>poky-extras</filename> Git | 173 | <para>Following is an example that creates the <filename>poky-extras</filename> Git |
173 | repository inside the source directory, which is named <filename>poky</filename> | 174 | repository inside the Source Directory, which is named <filename>poky</filename> |
174 | in this case: | 175 | in this case: |
175 | <literallayout class='monospaced'> | 176 | <literallayout class='monospaced'> |
176 | $ cd ~/poky | 177 | $ cd ~/poky |
@@ -192,7 +193,7 @@ | |||
192 | layer. | 193 | layer. |
193 | You can get set up for BSP development one of two ways: tarball extraction or | 194 | You can get set up for BSP development one of two ways: tarball extraction or |
194 | with a local Git repository. | 195 | with a local Git repository. |
195 | It is a good idea to use the same method that you used to set up the source directory. | 196 | It is a good idea to use the same method that you used to set up the Source Directory. |
196 | Regardless of the method you use, the Yocto Project uses the following BSP layer | 197 | Regardless of the method you use, the Yocto Project uses the following BSP layer |
197 | naming scheme: | 198 | naming scheme: |
198 | <literallayout class='monospaced'> | 199 | <literallayout class='monospaced'> |
@@ -218,13 +219,13 @@ | |||
218 | Again, this method just produces a snapshot of the BSP layer in the form | 219 | Again, this method just produces a snapshot of the BSP layer in the form |
219 | of a hierarchical directory structure.</para></listitem> | 220 | of a hierarchical directory structure.</para></listitem> |
220 | <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working | 221 | <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working |
221 | with a local Git repository for your source directory, you should also use this method | 222 | with a local Git repository for your Source Directory, you should also use this method |
222 | to set up the <filename>meta-intel</filename> Git repository. | 223 | to set up the <filename>meta-intel</filename> Git repository. |
223 | You can locate the <filename>meta-intel</filename> Git repository in the | 224 | You can locate the <filename>meta-intel</filename> Git repository in the |
224 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at | 225 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at |
225 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> | 226 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> |
226 | <para>Typically, you set up the <filename>meta-intel</filename> Git repository inside | 227 | <para>Typically, you set up the <filename>meta-intel</filename> Git repository inside |
227 | the source directory. | 228 | the Source Directory. |
228 | For example, the following transcript shows the steps to clone the | 229 | For example, the following transcript shows the steps to clone the |
229 | <filename>meta-intel</filename> | 230 | <filename>meta-intel</filename> |
230 | Git repository inside the local <filename>poky</filename> Git repository. | 231 | Git repository inside the local <filename>poky</filename> Git repository. |
@@ -266,13 +267,13 @@ | |||
266 | <para> | 267 | <para> |
267 | The build process is as follows: | 268 | The build process is as follows: |
268 | <orderedlist> | 269 | <orderedlist> |
269 | <listitem><para>Make sure you have set up the source directory described in the | 270 | <listitem><para>Make sure you have set up the Source Directory described in the |
270 | previous section.</para></listitem> | 271 | previous section.</para></listitem> |
271 | <listitem><para>Initialize the build environment by sourcing a build environment | 272 | <listitem><para>Initialize the build environment by sourcing a build environment |
272 | script.</para></listitem> | 273 | script.</para></listitem> |
273 | <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file, | 274 | <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file, |
274 | which is found in the | 275 | which is found in the |
275 | <link linkend='build-directory'>build directory</link>, | 276 | <link linkend='build-directory'>Build Directory</link>, |
276 | is set up how you want it. | 277 | is set up how you want it. |
277 | This file defines many aspects of the build environment including | 278 | This file defines many aspects of the build environment including |
278 | the target machine architecture through the | 279 | the target machine architecture through the |
@@ -298,7 +299,7 @@ | |||
298 | <para> | 299 | <para> |
299 | Another option you have to get started is to use pre-built binaries. | 300 | Another option you have to get started is to use pre-built binaries. |
300 | The Yocto Project provides many types of binaries with each release. | 301 | The Yocto Project provides many types of binaries with each release. |
301 | See the <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink> | 302 | See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" |
302 | chapter in the Yocto Project Reference Manual | 303 | chapter in the Yocto Project Reference Manual |
303 | for descriptions of the types of binaries that ship with a Yocto Project | 304 | for descriptions of the types of binaries that ship with a Yocto Project |
304 | release. | 305 | release. |