diff options
Diffstat (limited to 'documentation')
43 files changed, 312 insertions, 290 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index c6584af546..bb7f327598 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
@@ -88,6 +88,12 @@ ifeq ($(DOC),overview-manual) | |||
88 | XSLTOPTS = --xinclude | 88 | XSLTOPTS = --xinclude |
89 | ALLPREQ = html eclipse tarball | 89 | ALLPREQ = html eclipse tarball |
90 | TARFILES = overview-style.css overview-manual.html figures/overview-title.png \ | 90 | TARFILES = overview-style.css overview-manual.html figures/overview-title.png \ |
91 | figures/git-workflow.png figures/source-repos.png figures/index-downloads.png \ | ||
92 | figures/yp-download.png figures/yocto-environment-ref.png figures/user-configuration.png \ | ||
93 | figures/layer-input.png figures/source-input.png figures/package-feeds.png \ | ||
94 | figures/source-fetching.png figures/patching.png figures/configuration-compile-autoreconf.png \ | ||
95 | figures/analysis-for-package-splitting.png figures/image-generation.png \ | ||
96 | figures/sdk-generation.png figures/images.png figures/sdk.png \ | ||
91 | eclipse | 97 | eclipse |
92 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | 98 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse |
93 | FIGURES = figures | 99 | FIGURES = figures |
@@ -274,16 +280,11 @@ ifeq ($(DOC),ref-manual) | |||
274 | XSLTOPTS = --xinclude | 280 | XSLTOPTS = --xinclude |
275 | ALLPREQ = html eclipse tarball | 281 | ALLPREQ = html eclipse tarball |
276 | TARFILES = ref-manual.html ref-style.css figures/poky-title.png figures/YP-flow-diagram.png \ | 282 | TARFILES = ref-manual.html ref-style.css figures/poky-title.png figures/YP-flow-diagram.png \ |
277 | figures/buildhistory.png figures/buildhistory-web.png eclipse \ | 283 | figures/buildhistory.png figures/buildhistory-web.png \ |
278 | figures/cross-development-toolchains.png figures/layer-input.png \ | 284 | figures/cross-development-toolchains.png \ |
279 | figures/package-feeds.png figures/source-input.png \ | 285 | figures/building-an-image.png \ |
280 | figures/user-configuration.png figures/yocto-environment-ref.png \ | 286 | figures/build-workspace-directory.png \ |
281 | figures/images.png figures/sdk.png figures/source-fetching.png \ | 287 | eclipse |
282 | figures/patching.png figures/configuration-compile-autoreconf.png \ | ||
283 | figures/analysis-for-package-splitting.png figures/image-generation.png \ | ||
284 | figures/sdk-generation.png figures/building-an-image.png \ | ||
285 | figures/build-workspace-directory.png figures/source-repos.png \ | ||
286 | figures/index-downloads.png figures/yp-download.png figures/git-workflow.png | ||
287 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | 288 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse |
288 | FIGURES = figures | 289 | FIGURES = figures |
289 | STYLESHEET = $(DOC)/*.css | 290 | STYLESHEET = $(DOC)/*.css |
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 6f2aa384b2..6ae3ff9804 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml | |||
@@ -55,7 +55,7 @@ | |||
55 | To help understand the BSP layer concept, consider the BSPs that the | 55 | To help understand the BSP layer concept, consider the BSPs that the |
56 | Yocto Project supports and provides with each release. | 56 | Yocto Project supports and provides with each release. |
57 | You can see the layers in the | 57 | You can see the layers in the |
58 | <ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink> | 58 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink> |
59 | through a web interface at | 59 | through a web interface at |
60 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>. | 60 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>. |
61 | If you go to that interface, you will find near the bottom of the list | 61 | If you go to that interface, you will find near the bottom of the list |
@@ -1486,7 +1486,7 @@ | |||
1486 | 1486 | ||
1487 | <para> | 1487 | <para> |
1488 | Designed to have a command interface somewhat like | 1488 | Designed to have a command interface somewhat like |
1489 | <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>, each | 1489 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>, each |
1490 | tool is structured as a set of sub-commands under a | 1490 | tool is structured as a set of sub-commands under a |
1491 | top-level command. | 1491 | top-level command. |
1492 | The top-level command (<filename>yocto-bsp</filename> | 1492 | The top-level command (<filename>yocto-bsp</filename> |
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index dd74e7cd65..f04846ae36 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -1507,8 +1507,8 @@ | |||
1507 | </itemizedlist> | 1507 | </itemizedlist> |
1508 | <note> | 1508 | <note> |
1509 | For information on recipe syntax, see the | 1509 | For information on recipe syntax, see the |
1510 | "<ulink url='&YOCTO_DOCS_REF_URL;#recipe-syntax'>Recipe Syntax</ulink>" | 1510 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#recipe-syntax'>Recipe Syntax</ulink>" |
1511 | section in the Yocto Project Reference Manual. | 1511 | section in the Yocto Project Overview Manual. |
1512 | </note> | 1512 | </note> |
1513 | </para> | 1513 | </para> |
1514 | 1514 | ||
@@ -1798,8 +1798,8 @@ | |||
1798 | 1798 | ||
1799 | <para> | 1799 | <para> |
1800 | You can find more information about the build process in | 1800 | You can find more information about the build process in |
1801 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-development-environment'>The Yocto Project Development Environment</ulink>" | 1801 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#overview-development-environment'>The Yocto Project Development Environment</ulink>" |
1802 | chapter of the Yocto Project Reference Manual. | 1802 | chapter of the Yocto Project Overview Manual. |
1803 | </para> | 1803 | </para> |
1804 | </section> | 1804 | </section> |
1805 | 1805 | ||
@@ -1815,8 +1815,8 @@ | |||
1815 | Your recipe must have a <filename>SRC_URI</filename> variable | 1815 | Your recipe must have a <filename>SRC_URI</filename> variable |
1816 | that points to where the source is located. | 1816 | that points to where the source is located. |
1817 | For a graphical representation of source locations, see the | 1817 | For a graphical representation of source locations, see the |
1818 | "<ulink url='&YOCTO_DOCS_REF_URL;#sources-dev-environment'>Sources</ulink>" | 1818 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sources-dev-environment'>Sources</ulink>" |
1819 | section in the Yocto Project Reference Manual. | 1819 | section in the Yocto Project Overview Manual. |
1820 | </para> | 1820 | </para> |
1821 | 1821 | ||
1822 | <para> | 1822 | <para> |
@@ -5183,7 +5183,7 @@ | |||
5183 | can use an existing file provided by the Wic installation. | 5183 | can use an existing file provided by the Wic installation. |
5184 | As shipped, kickstart files can be found in the | 5184 | As shipped, kickstart files can be found in the |
5185 | Yocto Project | 5185 | Yocto Project |
5186 | <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> | 5186 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> |
5187 | in the following two locations: | 5187 | in the following two locations: |
5188 | <literallayout class='monospaced'> | 5188 | <literallayout class='monospaced'> |
5189 | poky/meta-yocto-bsp/wic | 5189 | poky/meta-yocto-bsp/wic |
@@ -7458,7 +7458,7 @@ Some notes from Cal: | |||
7458 | <filename>connman.inc</filename> file in the | 7458 | <filename>connman.inc</filename> file in the |
7459 | <filename>meta/recipes-connectivity/connman/</filename> | 7459 | <filename>meta/recipes-connectivity/connman/</filename> |
7460 | directory of the <filename>poky</filename> | 7460 | directory of the <filename>poky</filename> |
7461 | <ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>source repository</ulink>. | 7461 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>source repository</ulink>. |
7462 | You can also find examples in | 7462 | You can also find examples in |
7463 | <filename>meta/classes/kernel.bbclass</filename>. | 7463 | <filename>meta/classes/kernel.bbclass</filename>. |
7464 | </para> | 7464 | </para> |
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index a0fbb4bfd1..638d9112c7 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -99,7 +99,7 @@ | |||
99 | with the OpenEmbedded build system is advisable. | 99 | with the OpenEmbedded build system is advisable. |
100 | Of the SCMs BitBake supports, the | 100 | Of the SCMs BitBake supports, the |
101 | Yocto Project team strongly recommends using | 101 | Yocto Project team strongly recommends using |
102 | <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>. | 102 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>. |
103 | Git is a distributed system that is easy to backup, | 103 | Git is a distributed system that is easy to backup, |
104 | allows you to work remotely, and then connects back to the | 104 | allows you to work remotely, and then connects back to the |
105 | infrastructure. | 105 | infrastructure. |
@@ -310,7 +310,8 @@ | |||
310 | Consider the following: | 310 | Consider the following: |
311 | <itemizedlist> | 311 | <itemizedlist> |
312 | <listitem><para> | 312 | <listitem><para> |
313 | Use <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink> | 313 | Use |
314 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> | ||
314 | as the source control system. | 315 | as the source control system. |
315 | </para></listitem> | 316 | </para></listitem> |
316 | <listitem><para> | 317 | <listitem><para> |
@@ -324,7 +325,7 @@ | |||
324 | Separate the project's Metadata and code by using | 325 | Separate the project's Metadata and code by using |
325 | separate Git repositories. | 326 | separate Git repositories. |
326 | See the | 327 | See the |
327 | "<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" | 328 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" |
328 | section for information on these repositories. | 329 | section for information on these repositories. |
329 | See the | 330 | See the |
330 | "<link linkend='working-with-yocto-project-source-files'>Working With Yocto Project Source Files</link>" | 331 | "<link linkend='working-with-yocto-project-source-files'>Working With Yocto Project Source Files</link>" |
@@ -548,8 +549,8 @@ | |||
548 | pull the change into the component's upstream repository. | 549 | pull the change into the component's upstream repository. |
549 | You do this by pushing to a contribution repository that is upstream. | 550 | You do this by pushing to a contribution repository that is upstream. |
550 | See the | 551 | See the |
551 | "<ulink url='&YOCTO_DOCS_REF_URL;#workflows'>Workflows</ulink>" | 552 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#workflows'>Workflows</ulink>" |
552 | section in the Yocto Project Reference Manual for additional | 553 | section in the Yocto Project Overview Manual for additional |
553 | concepts on working in the Yocto Project development environment. | 554 | concepts on working in the Yocto Project development environment. |
554 | </para> | 555 | </para> |
555 | 556 | ||
@@ -748,7 +749,7 @@ | |||
748 | </para></listitem> | 749 | </para></listitem> |
749 | <listitem><para> | 750 | <listitem><para> |
750 | <emphasis>Search by File:</emphasis> | 751 | <emphasis>Search by File:</emphasis> |
751 | Using <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>, | 752 | Using <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>, |
752 | you can enter the following command to bring up a | 753 | you can enter the following command to bring up a |
753 | short list of all commits against a specific file: | 754 | short list of all commits against a specific file: |
754 | <literallayout class='monospaced'> | 755 | <literallayout class='monospaced'> |
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index ff8b56e62b..64d048d240 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -262,13 +262,13 @@ | |||
262 | <listitem><para> | 262 | <listitem><para> |
263 | For concepts and introductory information about Git as it | 263 | For concepts and introductory information about Git as it |
264 | is used in the Yocto Project, see the | 264 | is used in the Yocto Project, see the |
265 | "<ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>" | 265 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>" |
266 | section in the Yocto Project Reference Manual. | 266 | section in the Yocto Project Overview Manual. |
267 | </para></listitem> | 267 | </para></listitem> |
268 | <listitem><para> | 268 | <listitem><para> |
269 | For concepts on Yocto Project source repositories, see the | 269 | For concepts on Yocto Project source repositories, see the |
270 | "<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" | 270 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>" |
271 | section in the Yocto Project Reference Manual." | 271 | section in the Yocto Project Overview Manual." |
272 | </para></listitem> | 272 | </para></listitem> |
273 | </itemizedlist> | 273 | </itemizedlist> |
274 | </note> | 274 | </note> |
@@ -279,7 +279,7 @@ | |||
279 | 279 | ||
280 | <para> | 280 | <para> |
281 | Working from a copy of the upstream Yocto Project | 281 | Working from a copy of the upstream Yocto Project |
282 | <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> | 282 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> |
283 | is the preferred method for obtaining and using a Yocto Project | 283 | is the preferred method for obtaining and using a Yocto Project |
284 | release. | 284 | release. |
285 | You can view the Yocto Project Source Repositories at | 285 | You can view the Yocto Project Source Repositories at |
@@ -308,7 +308,7 @@ | |||
308 | <listitem><para> | 308 | <listitem><para> |
309 | <emphasis>Find the URL Used to Clone the Repository:</emphasis> | 309 | <emphasis>Find the URL Used to Clone the Repository:</emphasis> |
310 | At the bottom of the page, note the URL used to | 310 | At the bottom of the page, note the URL used to |
311 | <ulink url='&YOCTO_DOCS_REF_URL;#git-commands-clone'>clone</ulink> | 311 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git-commands-clone'>clone</ulink> |
312 | that repository (e.g. | 312 | that repository (e.g. |
313 | <filename>&YOCTO_GIT_URL;/poky</filename>). | 313 | <filename>&YOCTO_GIT_URL;/poky</filename>). |
314 | <note> | 314 | <note> |
@@ -468,7 +468,7 @@ | |||
468 | 468 | ||
469 | <para> | 469 | <para> |
470 | You create your Source Directory by using | 470 | You create your Source Directory by using |
471 | <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink> to clone a local | 471 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> to clone a local |
472 | copy of the upstream <filename>poky</filename> repository. | 472 | copy of the upstream <filename>poky</filename> repository. |
473 | <note><title>Tip</title> | 473 | <note><title>Tip</title> |
474 | The preferred method of getting the Yocto Project Source | 474 | The preferred method of getting the Yocto Project Source |
@@ -734,8 +734,8 @@ | |||
734 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> | 734 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
735 | under <filename>tmp/deploy/images</filename>. | 735 | under <filename>tmp/deploy/images</filename>. |
736 | For detailed information on the build process using BitBake, see the | 736 | For detailed information on the build process using BitBake, see the |
737 | "<ulink url='&YOCTO_DOCS_REF_URL;#images-dev-environment'>Images</ulink>" | 737 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" |
738 | section in the Yocto Project Reference Manual. | 738 | section in the Yocto Project Overview Manual. |
739 | You can also reference the | 739 | You can also reference the |
740 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" | 740 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" |
741 | section in the Yocto Project Quick Start. | 741 | section in the Yocto Project Quick Start. |
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml index c3013b8f76..11ab37ffaf 100644 --- a/documentation/kernel-dev/kernel-dev-advanced.xml +++ b/documentation/kernel-dev/kernel-dev-advanced.xml | |||
@@ -21,7 +21,7 @@ | |||
21 | <para> | 21 | <para> |
22 | Kernel Metadata exists in many places. | 22 | Kernel Metadata exists in many places. |
23 | One area in the Yocto Project | 23 | One area in the Yocto Project |
24 | <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> | 24 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> |
25 | is the <filename>yocto-kernel-cache</filename> Git repository. | 25 | is the <filename>yocto-kernel-cache</filename> Git repository. |
26 | You can find this repository grouped under the "Yocto Linux Kernel" | 26 | You can find this repository grouped under the "Yocto Linux Kernel" |
27 | heading in the | 27 | heading in the |
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml index b8fd870162..5b392a144c 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml | |||
@@ -79,7 +79,7 @@ | |||
79 | </literallayout> | 79 | </literallayout> |
80 | <note> | 80 | <note> |
81 | The previous commands assume the | 81 | The previous commands assume the |
82 | <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> | 82 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> |
83 | (i.e. <filename>poky</filename>) have been cloned | 83 | (i.e. <filename>poky</filename>) have been cloned |
84 | using Git and the local repository is named | 84 | using Git and the local repository is named |
85 | "poky". | 85 | "poky". |
@@ -303,7 +303,7 @@ | |||
303 | </literallayout> | 303 | </literallayout> |
304 | <note> | 304 | <note> |
305 | The previous commands assume the | 305 | The previous commands assume the |
306 | <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> | 306 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> |
307 | (i.e. <filename>poky</filename>) have been cloned | 307 | (i.e. <filename>poky</filename>) have been cloned |
308 | using Git and the local repository is named | 308 | using Git and the local repository is named |
309 | "poky". | 309 | "poky". |
diff --git a/documentation/kernel-dev/kernel-dev-concepts-appx.xml b/documentation/kernel-dev/kernel-dev-concepts-appx.xml index fbecc13875..231ef9a43d 100644 --- a/documentation/kernel-dev/kernel-dev-concepts-appx.xml +++ b/documentation/kernel-dev/kernel-dev-concepts-appx.xml | |||
@@ -49,7 +49,7 @@ | |||
49 | 49 | ||
50 | <para> | 50 | <para> |
51 | You can find a web interface to the Yocto Linux kernels in the | 51 | You can find a web interface to the Yocto Linux kernels in the |
52 | <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> | 52 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> |
53 | at | 53 | at |
54 | <ulink url='&YOCTO_GIT_URL;'></ulink>. | 54 | <ulink url='&YOCTO_GIT_URL;'></ulink>. |
55 | If you look at the interface, you will see to the left a | 55 | If you look at the interface, you will see to the left a |
@@ -239,8 +239,8 @@ | |||
239 | <ulink url='http://git-scm.com/documentation'></ulink>. | 239 | <ulink url='http://git-scm.com/documentation'></ulink>. |
240 | You can also get an introduction to Git as it | 240 | You can also get an introduction to Git as it |
241 | applies to the Yocto Project in the | 241 | applies to the Yocto Project in the |
242 | "<ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink>" | 242 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink>" |
243 | section in the Yocto Project Reference Manual. | 243 | section in the Yocto Project Overview Manual. |
244 | The latter reference provides an overview of | 244 | The latter reference provides an overview of |
245 | Git and presents a minimal set of Git commands | 245 | Git and presents a minimal set of Git commands |
246 | that allows you to be functional using Git. | 246 | that allows you to be functional using Git. |
@@ -381,7 +381,7 @@ | |||
381 | generic kernel just for conceptual purposes. | 381 | generic kernel just for conceptual purposes. |
382 | Also keep in mind that this structure represents the Yocto | 382 | Also keep in mind that this structure represents the Yocto |
383 | Project | 383 | Project |
384 | <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink> | 384 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> |
385 | that are either pulled from during the build or established | 385 | that are either pulled from during the build or established |
386 | on the host development system prior to the build by either | 386 | on the host development system prior to the build by either |
387 | cloning a particular kernel's Git repository or by | 387 | cloning a particular kernel's Git repository or by |
diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml index 22b3a86a4d..68fb1e17d8 100644 --- a/documentation/mega-manual/mega-manual.xml +++ b/documentation/mega-manual/mega-manual.xml | |||
@@ -138,6 +138,9 @@ | |||
138 | <xi:include | 138 | <xi:include |
139 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-intro.xml"/> | 139 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-intro.xml"/> |
140 | 140 | ||
141 | <xi:include | ||
142 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-development-environment.xml"/> | ||
143 | |||
141 | <!-- Includes dev-manual title image and then dev-manual chapters --> | 144 | <!-- Includes dev-manual title image and then dev-manual chapters --> |
142 | 145 | ||
143 | <para> | 146 | <para> |
@@ -234,9 +237,6 @@ | |||
234 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/usingpoky.xml"/> | 237 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/usingpoky.xml"/> |
235 | 238 | ||
236 | <xi:include | 239 | <xi:include |
237 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-development-environment.xml"/> | ||
238 | |||
239 | <xi:include | ||
240 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/technical-details.xml"/> | 240 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/technical-details.xml"/> |
241 | 241 | ||
242 | <xi:include | 242 | <xi:include |
diff --git a/documentation/ref-manual/figures/analysis-for-package-splitting.png b/documentation/overview-manual/figures/analysis-for-package-splitting.png index 04f2794ea9..04f2794ea9 100644 --- a/documentation/ref-manual/figures/analysis-for-package-splitting.png +++ b/documentation/overview-manual/figures/analysis-for-package-splitting.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/configuration-compile-autoreconf.png b/documentation/overview-manual/figures/configuration-compile-autoreconf.png index a07464f04c..a07464f04c 100644 --- a/documentation/ref-manual/figures/configuration-compile-autoreconf.png +++ b/documentation/overview-manual/figures/configuration-compile-autoreconf.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/git-workflow.png b/documentation/overview-manual/figures/git-workflow.png index e401330a12..e401330a12 100644 --- a/documentation/ref-manual/figures/git-workflow.png +++ b/documentation/overview-manual/figures/git-workflow.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/image-generation.png b/documentation/overview-manual/figures/image-generation.png index 71a48dc6f4..71a48dc6f4 100644 --- a/documentation/ref-manual/figures/image-generation.png +++ b/documentation/overview-manual/figures/image-generation.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/images.png b/documentation/overview-manual/figures/images.png index d99eac1fbf..d99eac1fbf 100644 --- a/documentation/ref-manual/figures/images.png +++ b/documentation/overview-manual/figures/images.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/index-downloads.png b/documentation/overview-manual/figures/index-downloads.png index 96303b8781..96303b8781 100644 --- a/documentation/ref-manual/figures/index-downloads.png +++ b/documentation/overview-manual/figures/index-downloads.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/layer-input.png b/documentation/overview-manual/figures/layer-input.png index 0a4f2e74f3..0a4f2e74f3 100644 --- a/documentation/ref-manual/figures/layer-input.png +++ b/documentation/overview-manual/figures/layer-input.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/package-feeds.png b/documentation/overview-manual/figures/package-feeds.png index 37c9c32506..37c9c32506 100644 --- a/documentation/ref-manual/figures/package-feeds.png +++ b/documentation/overview-manual/figures/package-feeds.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/patching.png b/documentation/overview-manual/figures/patching.png index 8ecd018502..8ecd018502 100644 --- a/documentation/ref-manual/figures/patching.png +++ b/documentation/overview-manual/figures/patching.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/sdk-generation.png b/documentation/overview-manual/figures/sdk-generation.png index adbe1f4acf..adbe1f4acf 100755 --- a/documentation/ref-manual/figures/sdk-generation.png +++ b/documentation/overview-manual/figures/sdk-generation.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/sdk.png b/documentation/overview-manual/figures/sdk.png index 5c36b7548b..5c36b7548b 100644 --- a/documentation/ref-manual/figures/sdk.png +++ b/documentation/overview-manual/figures/sdk.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/source-fetching.png b/documentation/overview-manual/figures/source-fetching.png index 26aefb50c2..26aefb50c2 100644 --- a/documentation/ref-manual/figures/source-fetching.png +++ b/documentation/overview-manual/figures/source-fetching.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/source-input.png b/documentation/overview-manual/figures/source-input.png index f7515058ef..f7515058ef 100644 --- a/documentation/ref-manual/figures/source-input.png +++ b/documentation/overview-manual/figures/source-input.png | |||
Binary files differ | |||
diff --git a/documentation/overview-manual/figures/source-repos.png b/documentation/overview-manual/figures/source-repos.png new file mode 100644 index 0000000000..603300b6d2 --- /dev/null +++ b/documentation/overview-manual/figures/source-repos.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/user-configuration.png b/documentation/overview-manual/figures/user-configuration.png index c298401fc3..c298401fc3 100755..100644 --- a/documentation/ref-manual/figures/user-configuration.png +++ b/documentation/overview-manual/figures/user-configuration.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/yocto-environment-ref.png b/documentation/overview-manual/figures/yocto-environment-ref.png index 650c6c8030..650c6c8030 100644 --- a/documentation/ref-manual/figures/yocto-environment-ref.png +++ b/documentation/overview-manual/figures/yocto-environment-ref.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/yp-download.png b/documentation/overview-manual/figures/yp-download.png index 5770be6883..5770be6883 100644 --- a/documentation/ref-manual/figures/yp-download.png +++ b/documentation/overview-manual/figures/yp-download.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/ref-development-environment.xml b/documentation/overview-manual/overview-development-environment.xml index 543a669e05..32fe1816ab 100644 --- a/documentation/ref-manual/ref-development-environment.xml +++ b/documentation/overview-manual/overview-development-environment.xml | |||
@@ -2,7 +2,7 @@ | |||
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > |
4 | 4 | ||
5 | <chapter id='ref-development-environment'> | 5 | <chapter id='overview-development-environment'> |
6 | <title>The Yocto Project Development Environment</title> | 6 | <title>The Yocto Project Development Environment</title> |
7 | 7 | ||
8 | <para> | 8 | <para> |
@@ -236,7 +236,7 @@ | |||
236 | release to facilitate this workflow. | 236 | release to facilitate this workflow. |
237 | You can find these scripts in the <filename>scripts</filename> | 237 | You can find these scripts in the <filename>scripts</filename> |
238 | folder of the | 238 | folder of the |
239 | <link linkend='source-directory'>Source Directory</link>. | 239 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. |
240 | For information on how to use these scripts, see the | 240 | For information on how to use these scripts, see the |
241 | "<ulink url='&YOCTO_DOCS_DEV_URL;#pushing-a-change-upstream'>Using Scripts to Push a Change Upstream and Request a Pull</ulink>" | 241 | "<ulink url='&YOCTO_DOCS_DEV_URL;#pushing-a-change-upstream'>Using Scripts to Push a Change Upstream and Request a Pull</ulink>" |
242 | section in the Yocto Project Development Tasks Manual. | 242 | section in the Yocto Project Development Tasks Manual. |
@@ -637,8 +637,8 @@ | |||
637 | column and see the URL at the bottom of the page that you need to clone | 637 | column and see the URL at the bottom of the page that you need to clone |
638 | a Git repository for that particular item. | 638 | a Git repository for that particular item. |
639 | Having a local Git repository of the | 639 | Having a local Git repository of the |
640 | <link linkend='source-directory'>Source Directory</link>, which is | 640 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>, |
641 | usually named "poky", allows | 641 | which is usually named "poky", allows |
642 | you to make changes, contribute to the history, and ultimately enhance | 642 | you to make changes, contribute to the history, and ultimately enhance |
643 | the Yocto Project's tools, Board Support Packages, and so forth. | 643 | the Yocto Project's tools, Board Support Packages, and so forth. |
644 | </para> | 644 | </para> |
@@ -654,7 +654,7 @@ | |||
654 | <itemizedlist> | 654 | <itemizedlist> |
655 | <listitem><para> | 655 | <listitem><para> |
656 | The recommended method for setting up the Yocto Project | 656 | The recommended method for setting up the Yocto Project |
657 | <link linkend='source-directory'>Source Directory</link> | 657 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> |
658 | and the files for supported BSPs | 658 | and the files for supported BSPs |
659 | (e.g., <filename>meta-intel</filename>) is to use | 659 | (e.g., <filename>meta-intel</filename>) is to use |
660 | <link linkend='git'>Git</link> to create a local copy of | 660 | <link linkend='git'>Git</link> to create a local copy of |
@@ -663,7 +663,7 @@ | |||
663 | <listitem><para> | 663 | <listitem><para> |
664 | Be sure to always work in matching branches for both | 664 | Be sure to always work in matching branches for both |
665 | the selected BSP repository and the | 665 | the selected BSP repository and the |
666 | <link linkend='source-directory'>Source Directory</link> | 666 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> |
667 | (i.e. <filename>poky</filename>) repository. | 667 | (i.e. <filename>poky</filename>) repository. |
668 | For example, if you have checked out the "master" branch | 668 | For example, if you have checked out the "master" branch |
669 | of <filename>poky</filename> and you are going to use | 669 | of <filename>poky</filename> and you are going to use |
@@ -774,11 +774,11 @@ | |||
774 | When you build an image using the Yocto Project, the build process | 774 | When you build an image using the Yocto Project, the build process |
775 | uses a known list of licenses to ensure compliance. | 775 | uses a known list of licenses to ensure compliance. |
776 | You can find this list in the | 776 | You can find this list in the |
777 | <link linkend='source-directory'>Source Directory</link> at | 777 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> |
778 | <filename>meta/files/common-licenses</filename>. | 778 | at <filename>meta/files/common-licenses</filename>. |
779 | Once the build completes, the list of all licenses found and used | 779 | Once the build completes, the list of all licenses found and used |
780 | during that build are kept in the | 780 | during that build are kept in the |
781 | <link linkend='build-directory'>Build Directory</link> | 781 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
782 | at <filename>tmp/deploy/licenses</filename>. | 782 | at <filename>tmp/deploy/licenses</filename>. |
783 | </para> | 783 | </para> |
784 | 784 | ||
@@ -809,7 +809,7 @@ | |||
809 | You can find a list of the combined SPDX and OSI licenses that the | 809 | You can find a list of the combined SPDX and OSI licenses that the |
810 | Yocto Project uses in the | 810 | Yocto Project uses in the |
811 | <filename>meta/files/common-licenses</filename> directory in your | 811 | <filename>meta/files/common-licenses</filename> directory in your |
812 | <link linkend='source-directory'>Source Directory</link>. | 812 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. |
813 | </para> | 813 | </para> |
814 | 814 | ||
815 | <para> | 815 | <para> |
@@ -1061,9 +1061,9 @@ | |||
1061 | You can use overrides to set a value conditionally, | 1061 | You can use overrides to set a value conditionally, |
1062 | typically based on how the recipe is being built. | 1062 | typically based on how the recipe is being built. |
1063 | For example, to set the | 1063 | For example, to set the |
1064 | <link linkend='var-KBRANCH'><filename>KBRANCH</filename></link> | 1064 | <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'><filename>KBRANCH</filename></ulink> |
1065 | variable's value to "standard/base" for any target | 1065 | variable's value to "standard/base" for any target |
1066 | <link linkend='var-MACHINE'><filename>MACHINE</filename></link>, | 1066 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>, |
1067 | except for qemuarm where it should be set to | 1067 | except for qemuarm where it should be set to |
1068 | "standard/arm-versatile-926ejs", you would do the | 1068 | "standard/arm-versatile-926ejs", you would do the |
1069 | following: | 1069 | following: |
@@ -1074,9 +1074,9 @@ | |||
1074 | Overrides are also used to separate alternate values | 1074 | Overrides are also used to separate alternate values |
1075 | of a variable in other situations. | 1075 | of a variable in other situations. |
1076 | For example, when setting variables such as | 1076 | For example, when setting variables such as |
1077 | <link linkend='var-FILES'><filename>FILES</filename></link> | 1077 | <ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'><filename>FILES</filename></ulink> |
1078 | and | 1078 | and |
1079 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> | 1079 | <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink> |
1080 | that are specific to individual packages produced by | 1080 | that are specific to individual packages produced by |
1081 | a recipe, you should always use an override that | 1081 | a recipe, you should always use an override that |
1082 | specifies the name of the package. | 1082 | specifies the name of the package. |
@@ -1127,7 +1127,7 @@ | |||
1127 | The following diagram represents development at a high level. | 1127 | The following diagram represents development at a high level. |
1128 | The remainder of this chapter expands on the fundamental input, output, | 1128 | The remainder of this chapter expands on the fundamental input, output, |
1129 | process, and | 1129 | process, and |
1130 | <link linkend='metadata'>Metadata</link>) blocks | 1130 | <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>) blocks |
1131 | that make up development in the Yocto Project environment. | 1131 | that make up development in the Yocto Project environment. |
1132 | </para> | 1132 | </para> |
1133 | 1133 | ||
@@ -1148,7 +1148,7 @@ | |||
1148 | Upstream releases, local projects, and SCMs.</para></listitem> | 1148 | Upstream releases, local projects, and SCMs.</para></listitem> |
1149 | <listitem><para><emphasis>Build System:</emphasis> | 1149 | <listitem><para><emphasis>Build System:</emphasis> |
1150 | Processes under the control of | 1150 | Processes under the control of |
1151 | <link linkend='bitbake-term'>BitBake</link>. | 1151 | <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink>. |
1152 | This block expands on how BitBake fetches source, applies | 1152 | This block expands on how BitBake fetches source, applies |
1153 | patches, completes compilation, analyzes output for package | 1153 | patches, completes compilation, analyzes output for package |
1154 | generation, creates and tests packages, generates images, and | 1154 | generation, creates and tests packages, generates images, and |
@@ -1187,7 +1187,7 @@ | |||
1187 | </para> | 1187 | </para> |
1188 | 1188 | ||
1189 | <para> | 1189 | <para> |
1190 | <imagedata fileref="figures/user-configuration.png" align="center" /> | 1190 | <imagedata fileref="figures/user-configuration.png" align="center" width="8in" depth="4.5in" /> |
1191 | </para> | 1191 | </para> |
1192 | 1192 | ||
1193 | <para> | 1193 | <para> |
@@ -1195,7 +1195,7 @@ | |||
1195 | a build. | 1195 | a build. |
1196 | These files are <filename>*.conf</filename> files. | 1196 | These files are <filename>*.conf</filename> files. |
1197 | The minimally necessary ones reside as example files in the | 1197 | The minimally necessary ones reside as example files in the |
1198 | <link linkend='source-directory'>Source Directory</link>. | 1198 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. |
1199 | For simplicity, this section refers to the Source Directory as | 1199 | For simplicity, this section refers to the Source Directory as |
1200 | the "Poky Directory." | 1200 | the "Poky Directory." |
1201 | </para> | 1201 | </para> |
@@ -1221,12 +1221,12 @@ | |||
1221 | configuration files when you source the build environment | 1221 | configuration files when you source the build environment |
1222 | script | 1222 | script |
1223 | (i.e. | 1223 | (i.e. |
1224 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>). | 1224 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>). |
1225 | </para> | 1225 | </para> |
1226 | 1226 | ||
1227 | <para> | 1227 | <para> |
1228 | Sourcing the build environment script creates a | 1228 | Sourcing the build environment script creates a |
1229 | <link linkend='build-directory'>Build Directory</link> | 1229 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
1230 | if one does not already exist. | 1230 | if one does not already exist. |
1231 | BitBake uses the Build Directory for all its work during builds. | 1231 | BitBake uses the Build Directory for all its work during builds. |
1232 | The Build Directory has a <filename>conf</filename> directory that | 1232 | The Build Directory has a <filename>conf</filename> directory that |
@@ -1273,26 +1273,26 @@ | |||
1273 | <itemizedlist> | 1273 | <itemizedlist> |
1274 | <listitem><para><emphasis>Parallelism Options:</emphasis> | 1274 | <listitem><para><emphasis>Parallelism Options:</emphasis> |
1275 | Controlled by the | 1275 | Controlled by the |
1276 | <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>, | 1276 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>, |
1277 | <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>, | 1277 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink>, |
1278 | and | 1278 | and |
1279 | <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> | 1279 | <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> |
1280 | variables.</para></listitem> | 1280 | variables.</para></listitem> |
1281 | <listitem><para><emphasis>Target Machine Selection:</emphasis> | 1281 | <listitem><para><emphasis>Target Machine Selection:</emphasis> |
1282 | Controlled by the | 1282 | Controlled by the |
1283 | <link linkend='var-MACHINE'><filename>MACHINE</filename></link> | 1283 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> |
1284 | variable.</para></listitem> | 1284 | variable.</para></listitem> |
1285 | <listitem><para><emphasis>Download Directory:</emphasis> | 1285 | <listitem><para><emphasis>Download Directory:</emphasis> |
1286 | Controlled by the | 1286 | Controlled by the |
1287 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> | 1287 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink> |
1288 | variable.</para></listitem> | 1288 | variable.</para></listitem> |
1289 | <listitem><para><emphasis>Shared State Directory:</emphasis> | 1289 | <listitem><para><emphasis>Shared State Directory:</emphasis> |
1290 | Controlled by the | 1290 | Controlled by the |
1291 | <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link> | 1291 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink> |
1292 | variable.</para></listitem> | 1292 | variable.</para></listitem> |
1293 | <listitem><para><emphasis>Build Output:</emphasis> | 1293 | <listitem><para><emphasis>Build Output:</emphasis> |
1294 | Controlled by the | 1294 | Controlled by the |
1295 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> | 1295 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink> |
1296 | variable.</para></listitem> | 1296 | variable.</para></listitem> |
1297 | </itemizedlist> | 1297 | </itemizedlist> |
1298 | <note> | 1298 | <note> |
@@ -1332,11 +1332,11 @@ | |||
1332 | You can set these default build properties here. | 1332 | You can set these default build properties here. |
1333 | A good example is perhaps the packaging format to use | 1333 | A good example is perhaps the packaging format to use |
1334 | through the | 1334 | through the |
1335 | <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> | 1335 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink> |
1336 | variable.</para> | 1336 | variable.</para> |
1337 | <para>One useful scenario for using the | 1337 | <para>One useful scenario for using the |
1338 | <filename>conf/site.conf</filename> file is to extend your | 1338 | <filename>conf/site.conf</filename> file is to extend your |
1339 | <link linkend='var-BBPATH'><filename>BBPATH</filename></link> | 1339 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BBPATH'><filename>BBPATH</filename></ulink> |
1340 | variable to include the path to a | 1340 | variable to include the path to a |
1341 | <filename>conf/site.conf</filename>. | 1341 | <filename>conf/site.conf</filename>. |
1342 | Then, when BitBake looks for Metadata using | 1342 | Then, when BitBake looks for Metadata using |
@@ -1495,7 +1495,8 @@ | |||
1495 | When your recipes inherit a class, they take on the | 1495 | When your recipes inherit a class, they take on the |
1496 | settings and functions for that class. | 1496 | settings and functions for that class. |
1497 | You can read more about class files in the | 1497 | You can read more about class files in the |
1498 | "<link linkend='ref-classes'>Classes</link>" section. | 1498 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes'>Classes</ulink>" |
1499 | section of the Yocto Reference Manual. | ||
1499 | </para></listitem> | 1500 | </para></listitem> |
1500 | <listitem><para><emphasis>conf:</emphasis> | 1501 | <listitem><para><emphasis>conf:</emphasis> |
1501 | This area holds configuration files for the | 1502 | This area holds configuration files for the |
@@ -1605,7 +1606,7 @@ | |||
1605 | 1606 | ||
1606 | <para> | 1607 | <para> |
1607 | BitBake uses the | 1608 | BitBake uses the |
1608 | <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> | 1609 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> |
1609 | variable to point to source files regardless of their location. | 1610 | variable to point to source files regardless of their location. |
1610 | Each recipe must have a <filename>SRC_URI</filename> variable | 1611 | Each recipe must have a <filename>SRC_URI</filename> variable |
1611 | that points to the source. | 1612 | that points to the source. |
@@ -1614,13 +1615,13 @@ | |||
1614 | <para> | 1615 | <para> |
1615 | Another area that plays a significant role in where source files | 1616 | Another area that plays a significant role in where source files |
1616 | come from is pointed to by the | 1617 | come from is pointed to by the |
1617 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> | 1618 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink> |
1618 | variable. | 1619 | variable. |
1619 | This area is a cache that can hold previously downloaded source. | 1620 | This area is a cache that can hold previously downloaded source. |
1620 | You can also instruct the OpenEmbedded build system to create | 1621 | You can also instruct the OpenEmbedded build system to create |
1621 | tarballs from Git repositories, which is not the default behavior, | 1622 | tarballs from Git repositories, which is not the default behavior, |
1622 | and store them in the <filename>DL_DIR</filename> by using the | 1623 | and store them in the <filename>DL_DIR</filename> by using the |
1623 | <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> | 1624 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></ulink> |
1624 | variable. | 1625 | variable. |
1625 | </para> | 1626 | </para> |
1626 | 1627 | ||
@@ -1671,7 +1672,7 @@ | |||
1671 | <para> | 1672 | <para> |
1672 | The canonical method through which to include a local project | 1673 | The canonical method through which to include a local project |
1673 | is to use the | 1674 | is to use the |
1674 | <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link> | 1675 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc</filename></ulink> |
1675 | class to include that local project. | 1676 | class to include that local project. |
1676 | You use either the <filename>local.conf</filename> or a | 1677 | You use either the <filename>local.conf</filename> or a |
1677 | recipe's append file to override or set the | 1678 | recipe's append file to override or set the |
@@ -1682,7 +1683,7 @@ | |||
1682 | <para> | 1683 | <para> |
1683 | For information on how to use the | 1684 | For information on how to use the |
1684 | <filename>externalsrc</filename> class, see the | 1685 | <filename>externalsrc</filename> class, see the |
1685 | "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>" | 1686 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink>" |
1686 | section. | 1687 | section. |
1687 | </para> | 1688 | </para> |
1688 | </section> | 1689 | </section> |
@@ -1695,9 +1696,9 @@ | |||
1695 | through an SCM such as Git or Subversion. | 1696 | through an SCM such as Git or Subversion. |
1696 | In this case, a repository is cloned or checked out. | 1697 | In this case, a repository is cloned or checked out. |
1697 | The | 1698 | The |
1698 | <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link> | 1699 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink> |
1699 | task inside BitBake uses | 1700 | task inside BitBake uses |
1700 | the <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> | 1701 | the <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> |
1701 | variable and the argument's prefix to determine the correct | 1702 | variable and the argument's prefix to determine the correct |
1702 | fetcher module. | 1703 | fetcher module. |
1703 | </para> | 1704 | </para> |
@@ -1705,15 +1706,15 @@ | |||
1705 | <note> | 1706 | <note> |
1706 | For information on how to have the OpenEmbedded build system | 1707 | For information on how to have the OpenEmbedded build system |
1707 | generate tarballs for Git repositories and place them in the | 1708 | generate tarballs for Git repositories and place them in the |
1708 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> | 1709 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink> |
1709 | directory, see the | 1710 | directory, see the |
1710 | <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> | 1711 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></ulink> |
1711 | variable. | 1712 | variable. |
1712 | </note> | 1713 | </note> |
1713 | 1714 | ||
1714 | <para> | 1715 | <para> |
1715 | When fetching a repository, BitBake uses the | 1716 | When fetching a repository, BitBake uses the |
1716 | <link linkend='var-SRCREV'><filename>SRCREV</filename></link> | 1717 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink> |
1717 | variable to determine the specific revision from which to | 1718 | variable to determine the specific revision from which to |
1718 | build. | 1719 | build. |
1719 | </para> | 1720 | </para> |
@@ -1724,15 +1725,16 @@ | |||
1724 | 1725 | ||
1725 | <para> | 1726 | <para> |
1726 | Two kinds of mirrors exist: pre-mirrors and regular mirrors. | 1727 | Two kinds of mirrors exist: pre-mirrors and regular mirrors. |
1727 | The <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> | 1728 | The |
1729 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PREMIRRORS'><filename>PREMIRRORS</filename></ulink> | ||
1728 | and | 1730 | and |
1729 | <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> | 1731 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MIRRORS'><filename>MIRRORS</filename></ulink> |
1730 | variables point to these, respectively. | 1732 | variables point to these, respectively. |
1731 | BitBake checks pre-mirrors before looking upstream for any | 1733 | BitBake checks pre-mirrors before looking upstream for any |
1732 | source files. | 1734 | source files. |
1733 | Pre-mirrors are appropriate when you have a shared directory | 1735 | Pre-mirrors are appropriate when you have a shared directory |
1734 | that is not a directory defined by the | 1736 | that is not a directory defined by the |
1735 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> | 1737 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink> |
1736 | variable. | 1738 | variable. |
1737 | A Pre-mirror typically points to a shared directory that is | 1739 | A Pre-mirror typically points to a shared directory that is |
1738 | local to your organization. | 1740 | local to your organization. |
@@ -1752,7 +1754,7 @@ | |||
1752 | <para> | 1754 | <para> |
1753 | When the OpenEmbedded build system generates an image or an SDK, | 1755 | When the OpenEmbedded build system generates an image or an SDK, |
1754 | it gets the packages from a package feed area located in the | 1756 | it gets the packages from a package feed area located in the |
1755 | <link linkend='build-directory'>Build Directory</link>. | 1757 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. |
1756 | The | 1758 | The |
1757 | <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> | 1759 | <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> |
1758 | shows this package feeds area in the upper-right corner. | 1760 | shows this package feeds area in the upper-right corner. |
@@ -1770,12 +1772,12 @@ | |||
1770 | The OpenEmbedded build system provides classes to generate | 1772 | The OpenEmbedded build system provides classes to generate |
1771 | different package types, and you specify which classes to enable | 1773 | different package types, and you specify which classes to enable |
1772 | through the | 1774 | through the |
1773 | <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> | 1775 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink> |
1774 | variable. | 1776 | variable. |
1775 | Before placing the packages into package feeds, | 1777 | Before placing the packages into package feeds, |
1776 | the build process validates them with generated output quality | 1778 | the build process validates them with generated output quality |
1777 | assurance checks through the | 1779 | assurance checks through the |
1778 | <link linkend='ref-classes-insane'><filename>insane</filename></link> | 1780 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-insane'><filename>insane</filename></ulink> |
1779 | class. | 1781 | class. |
1780 | </para> | 1782 | </para> |
1781 | 1783 | ||
@@ -1789,7 +1791,7 @@ | |||
1789 | In particular, the following defines where package files are | 1791 | In particular, the following defines where package files are |
1790 | kept: | 1792 | kept: |
1791 | <itemizedlist> | 1793 | <itemizedlist> |
1792 | <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: | 1794 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></ulink>: |
1793 | Defined as <filename>tmp/deploy</filename> in the Build | 1795 | Defined as <filename>tmp/deploy</filename> in the Build |
1794 | Directory. | 1796 | Directory. |
1795 | </para></listitem> | 1797 | </para></listitem> |
@@ -1797,14 +1799,14 @@ | |||
1797 | Depending on the package manager used, the package type | 1799 | Depending on the package manager used, the package type |
1798 | sub-folder. | 1800 | sub-folder. |
1799 | Given RPM, IPK, or DEB packaging and tarball creation, the | 1801 | Given RPM, IPK, or DEB packaging and tarball creation, the |
1800 | <link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link>, | 1802 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></ulink>, |
1801 | <link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link>, | 1803 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></ulink>, |
1802 | <link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link>, | 1804 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></ulink>, |
1803 | or | 1805 | or |
1804 | <link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link>, | 1806 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></ulink>, |
1805 | variables are used, respectively. | 1807 | variables are used, respectively. |
1806 | </para></listitem> | 1808 | </para></listitem> |
1807 | <listitem><para><link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link>: | 1809 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink>: |
1808 | Defines architecture-specific sub-folders. | 1810 | Defines architecture-specific sub-folders. |
1809 | For example, packages could exist for the i586 or qemux86 | 1811 | For example, packages could exist for the i586 or qemux86 |
1810 | architectures. | 1812 | architectures. |
@@ -1817,11 +1819,11 @@ | |||
1817 | generate packages and place them into the package holding area (e.g. | 1819 | generate packages and place them into the package holding area (e.g. |
1818 | <filename>do_package_write_ipk</filename> for IPK packages). | 1820 | <filename>do_package_write_ipk</filename> for IPK packages). |
1819 | See the | 1821 | See the |
1820 | "<link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link>", | 1822 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></ulink>", |
1821 | "<link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link>", | 1823 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></ulink>", |
1822 | "<link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link>", | 1824 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></ulink>", |
1823 | and | 1825 | and |
1824 | "<link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link>" | 1826 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></ulink>" |
1825 | sections for additional information. | 1827 | sections for additional information. |
1826 | As an example, consider a scenario where an IPK packaging manager | 1828 | As an example, consider a scenario where an IPK packaging manager |
1827 | is being used and package architecture support for both i586 | 1829 | is being used and package architecture support for both i586 |
@@ -1838,7 +1840,7 @@ | |||
1838 | 1840 | ||
1839 | <para> | 1841 | <para> |
1840 | The OpenEmbedded build system uses | 1842 | The OpenEmbedded build system uses |
1841 | <link linkend='bitbake-term'>BitBake</link> | 1843 | <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink> |
1842 | to produce images. | 1844 | to produce images. |
1843 | You can see from the | 1845 | You can see from the |
1844 | <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>, | 1846 | <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>, |
@@ -1864,15 +1866,15 @@ | |||
1864 | 1866 | ||
1865 | <para> | 1867 | <para> |
1866 | The | 1868 | The |
1867 | <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link> | 1869 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink> |
1868 | and | 1870 | and |
1869 | <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link> | 1871 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-unpack'><filename>do_unpack</filename></ulink> |
1870 | tasks fetch the source files and unpack them into the work | 1872 | tasks fetch the source files and unpack them into the work |
1871 | directory. | 1873 | directory. |
1872 | <note> | 1874 | <note> |
1873 | For every local file (e.g. <filename>file://</filename>) | 1875 | For every local file (e.g. <filename>file://</filename>) |
1874 | that is part of a recipe's | 1876 | that is part of a recipe's |
1875 | <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> | 1877 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> |
1876 | statement, the OpenEmbedded build system takes a checksum | 1878 | statement, the OpenEmbedded build system takes a checksum |
1877 | of the file for the recipe and inserts the checksum into | 1879 | of the file for the recipe and inserts the checksum into |
1878 | the signature for the <filename>do_fetch</filename>. | 1880 | the signature for the <filename>do_fetch</filename>. |
@@ -1881,17 +1883,18 @@ | |||
1881 | depend on it are re-executed. | 1883 | depend on it are re-executed. |
1882 | </note> | 1884 | </note> |
1883 | By default, everything is accomplished in the | 1885 | By default, everything is accomplished in the |
1884 | <link linkend='build-directory'>Build Directory</link>, | 1886 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, |
1885 | which has a defined structure. | 1887 | which has a defined structure. |
1886 | For additional general information on the Build Directory, | 1888 | For additional general information on the Build Directory, |
1887 | see the | 1889 | see the |
1888 | "<link linkend='structure-core-build'><filename>build/</filename></link>" | 1890 | "<ulink url='&YOCTO_DOCS_REF_URL;#structure-core-build'><filename>build/</filename></ulink>" |
1889 | section. | 1891 | section in the Yocto Project Reference Manual. |
1890 | </para> | 1892 | </para> |
1891 | 1893 | ||
1892 | <para> | 1894 | <para> |
1893 | Unpacked source files are pointed to by the | 1895 | Unpacked source files are pointed to by the |
1894 | <link linkend='var-S'><filename>S</filename></link> variable. | 1896 | <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> |
1897 | variable. | ||
1895 | Each recipe has an area in the Build Directory where the | 1898 | Each recipe has an area in the Build Directory where the |
1896 | unpacked source code resides. | 1899 | unpacked source code resides. |
1897 | The name of that directory for any given recipe is defined from | 1900 | The name of that directory for any given recipe is defined from |
@@ -1899,30 +1902,30 @@ | |||
1899 | You can see the variables that define these directories | 1902 | You can see the variables that define these directories |
1900 | by looking at the figure: | 1903 | by looking at the figure: |
1901 | <itemizedlist> | 1904 | <itemizedlist> |
1902 | <listitem><para><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - | 1905 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink> - |
1903 | The base directory where the OpenEmbedded build system | 1906 | The base directory where the OpenEmbedded build system |
1904 | performs all its work during the build. | 1907 | performs all its work during the build. |
1905 | </para></listitem> | 1908 | </para></listitem> |
1906 | <listitem><para><link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link> - | 1909 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink> - |
1907 | The architecture of the built package or packages. | 1910 | The architecture of the built package or packages. |
1908 | </para></listitem> | 1911 | </para></listitem> |
1909 | <listitem><para><link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link> - | 1912 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_OS'><filename>TARGET_OS</filename></ulink> - |
1910 | The operating system of the target device. | 1913 | The operating system of the target device. |
1911 | </para></listitem> | 1914 | </para></listitem> |
1912 | <listitem><para><link linkend='var-PN'><filename>PN</filename></link> - | 1915 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink> - |
1913 | The name of the built package. | 1916 | The name of the built package. |
1914 | </para></listitem> | 1917 | </para></listitem> |
1915 | <listitem><para><link linkend='var-PV'><filename>PV</filename></link> - | 1918 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink> - |
1916 | The version of the recipe used to build the package. | 1919 | The version of the recipe used to build the package. |
1917 | </para></listitem> | 1920 | </para></listitem> |
1918 | <listitem><para><link linkend='var-PR'><filename>PR</filename></link> - | 1921 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink> - |
1919 | The revision of the recipe used to build the package. | 1922 | The revision of the recipe used to build the package. |
1920 | </para></listitem> | 1923 | </para></listitem> |
1921 | <listitem><para><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> - | 1924 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink> - |
1922 | The location within <filename>TMPDIR</filename> where | 1925 | The location within <filename>TMPDIR</filename> where |
1923 | a specific package is built. | 1926 | a specific package is built. |
1924 | </para></listitem> | 1927 | </para></listitem> |
1925 | <listitem><para><link linkend='var-S'><filename>S</filename></link> - | 1928 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> - |
1926 | Contains the unpacked source files for a given recipe. | 1929 | Contains the unpacked source files for a given recipe. |
1927 | </para></listitem> | 1930 | </para></listitem> |
1928 | </itemizedlist> | 1931 | </itemizedlist> |
@@ -1940,10 +1943,10 @@ | |||
1940 | 1943 | ||
1941 | <para> | 1944 | <para> |
1942 | The | 1945 | The |
1943 | <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> | 1946 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink> |
1944 | task processes recipes by | 1947 | task processes recipes by |
1945 | using the | 1948 | using the |
1946 | <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> | 1949 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> |
1947 | variable to locate applicable patch files, which by default | 1950 | variable to locate applicable patch files, which by default |
1948 | are <filename>*.patch</filename> or | 1951 | are <filename>*.patch</filename> or |
1949 | <filename>*.diff</filename> files, or any file if | 1952 | <filename>*.diff</filename> files, or any file if |
@@ -1955,7 +1958,8 @@ | |||
1955 | BitBake finds and applies multiple patches for a single recipe | 1958 | BitBake finds and applies multiple patches for a single recipe |
1956 | in the order in which it finds the patches. | 1959 | in the order in which it finds the patches. |
1957 | Patches are applied to the recipe's source files located in the | 1960 | Patches are applied to the recipe's source files located in the |
1958 | <link linkend='var-S'><filename>S</filename></link> directory. | 1961 | <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> |
1962 | directory. | ||
1959 | </para> | 1963 | </para> |
1960 | 1964 | ||
1961 | <para> | 1965 | <para> |
@@ -1979,13 +1983,13 @@ | |||
1979 | This step in the build process consists of three tasks: | 1983 | This step in the build process consists of three tasks: |
1980 | <itemizedlist> | 1984 | <itemizedlist> |
1981 | <listitem><para> | 1985 | <listitem><para> |
1982 | <emphasis><link linkend='ref-tasks-prepare_recipe_sysroot'><filename>do_prepare_recipe_sysroot</filename></link>:</emphasis> | 1986 | <emphasis><ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-prepare_recipe_sysroot'><filename>do_prepare_recipe_sysroot</filename></ulink>:</emphasis> |
1983 | This task sets up the two sysroots in | 1987 | This task sets up the two sysroots in |
1984 | <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}</filename> | 1988 | <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename> |
1985 | (i.e. <filename>recipe-sysroot</filename> and | 1989 | (i.e. <filename>recipe-sysroot</filename> and |
1986 | <filename>recipe-sysroot-native</filename>) so that | 1990 | <filename>recipe-sysroot-native</filename>) so that |
1987 | the sysroots contain the contents of the | 1991 | the sysroots contain the contents of the |
1988 | <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> | 1992 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></ulink> |
1989 | tasks of the recipes on which the recipe | 1993 | tasks of the recipes on which the recipe |
1990 | containing the tasks depends. | 1994 | containing the tasks depends. |
1991 | A sysroot exists for both the target and for the native | 1995 | A sysroot exists for both the target and for the native |
@@ -2002,18 +2006,19 @@ | |||
2002 | </para> | 2006 | </para> |
2003 | 2007 | ||
2004 | <para>The configurations handled by the | 2008 | <para>The configurations handled by the |
2005 | <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> | 2009 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-configure'><filename>do_configure</filename></ulink> |
2006 | task are specific | 2010 | task are specific |
2007 | to source code configuration for the source code | 2011 | to source code configuration for the source code |
2008 | being built by the recipe.</para> | 2012 | being built by the recipe.</para> |
2009 | 2013 | ||
2010 | <para>If you are using the | 2014 | <para>If you are using the |
2011 | <link linkend='ref-classes-autotools'><filename>autotools</filename></link> | 2015 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-autotools'><filename>autotools</filename></ulink> |
2012 | class, | 2016 | class, |
2013 | you can add additional configuration options by using | 2017 | you can add additional configuration options by using |
2014 | the <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link> | 2018 | the |
2019 | <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></ulink> | ||
2015 | or | 2020 | or |
2016 | <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link> | 2021 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></ulink> |
2017 | variables. | 2022 | variables. |
2018 | For information on how this variable works within | 2023 | For information on how this variable works within |
2019 | that class, see the | 2024 | that class, see the |
@@ -2022,23 +2027,23 @@ | |||
2022 | <listitem><para><emphasis><filename>do_compile</filename>:</emphasis> | 2027 | <listitem><para><emphasis><filename>do_compile</filename>:</emphasis> |
2023 | Once a configuration task has been satisfied, BitBake | 2028 | Once a configuration task has been satisfied, BitBake |
2024 | compiles the source using the | 2029 | compiles the source using the |
2025 | <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> | 2030 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-compile'><filename>do_compile</filename></ulink> |
2026 | task. | 2031 | task. |
2027 | Compilation occurs in the directory pointed to by the | 2032 | Compilation occurs in the directory pointed to by the |
2028 | <link linkend='var-B'><filename>B</filename></link> | 2033 | <ulink url='&YOCTO_DOCS_REF_URL;#var-B'><filename>B</filename></ulink> |
2029 | variable. | 2034 | variable. |
2030 | Realize that the <filename>B</filename> directory is, by | 2035 | Realize that the <filename>B</filename> directory is, by |
2031 | default, the same as the | 2036 | default, the same as the |
2032 | <link linkend='var-S'><filename>S</filename></link> | 2037 | <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> |
2033 | directory.</para></listitem> | 2038 | directory.</para></listitem> |
2034 | <listitem><para><emphasis><filename>do_install</filename>:</emphasis> | 2039 | <listitem><para><emphasis><filename>do_install</filename>:</emphasis> |
2035 | Once compilation is done, BitBake executes the | 2040 | Once compilation is done, BitBake executes the |
2036 | <link linkend='ref-tasks-install'><filename>do_install</filename></link> | 2041 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink> |
2037 | task. | 2042 | task. |
2038 | This task copies files from the <filename>B</filename> | 2043 | This task copies files from the <filename>B</filename> |
2039 | directory and places them in a holding area pointed to | 2044 | directory and places them in a holding area pointed to |
2040 | by the | 2045 | by the |
2041 | <link linkend='var-D'><filename>D</filename></link> | 2046 | <ulink url='&YOCTO_DOCS_REF_URL;#var-D'><filename>D</filename></ulink> |
2042 | variable.</para></listitem> | 2047 | variable.</para></listitem> |
2043 | </itemizedlist> | 2048 | </itemizedlist> |
2044 | </para> | 2049 | </para> |
@@ -2056,12 +2061,12 @@ | |||
2056 | 2061 | ||
2057 | <para> | 2062 | <para> |
2058 | The | 2063 | The |
2059 | <link linkend='ref-tasks-package'><filename>do_package</filename></link> | 2064 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package'><filename>do_package</filename></ulink> |
2060 | and | 2065 | and |
2061 | <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link> | 2066 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-packagedata'><filename>do_packagedata</filename></ulink> |
2062 | tasks combine to analyze | 2067 | tasks combine to analyze |
2063 | the files found in the | 2068 | the files found in the |
2064 | <link linkend='var-D'><filename>D</filename></link> directory | 2069 | <ulink url='&YOCTO_DOCS_REF_URL;#var-D'><filename>D</filename></ulink> directory |
2065 | and split them into subsets based on available packages and | 2070 | and split them into subsets based on available packages and |
2066 | files. | 2071 | files. |
2067 | The analyzing process involves the following as well as other | 2072 | The analyzing process involves the following as well as other |
@@ -2074,29 +2079,29 @@ | |||
2074 | Working, staged, and intermediate results of the analysis | 2079 | Working, staged, and intermediate results of the analysis |
2075 | and package splitting process use these areas: | 2080 | and package splitting process use these areas: |
2076 | <itemizedlist> | 2081 | <itemizedlist> |
2077 | <listitem><para><link linkend='var-PKGD'><filename>PKGD</filename></link> - | 2082 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PKGD'><filename>PKGD</filename></ulink> - |
2078 | The destination directory for packages before they are | 2083 | The destination directory for packages before they are |
2079 | split. | 2084 | split. |
2080 | </para></listitem> | 2085 | </para></listitem> |
2081 | <listitem><para><link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> - | 2086 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></ulink> - |
2082 | A shared, global-state directory that holds data | 2087 | A shared, global-state directory that holds data |
2083 | generated during the packaging process. | 2088 | generated during the packaging process. |
2084 | </para></listitem> | 2089 | </para></listitem> |
2085 | <listitem><para><link linkend='var-PKGDESTWORK'><filename>PKGDESTWORK</filename></link> - | 2090 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PKGDESTWORK'><filename>PKGDESTWORK</filename></ulink> - |
2086 | A temporary work area used by the | 2091 | A temporary work area used by the |
2087 | <filename>do_package</filename> task. | 2092 | <filename>do_package</filename> task. |
2088 | </para></listitem> | 2093 | </para></listitem> |
2089 | <listitem><para><link linkend='var-PKGDEST'><filename>PKGDEST</filename></link> - | 2094 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PKGDEST'><filename>PKGDEST</filename></ulink> - |
2090 | The parent directory for packages after they have | 2095 | The parent directory for packages after they have |
2091 | been split. | 2096 | been split. |
2092 | </para></listitem> | 2097 | </para></listitem> |
2093 | </itemizedlist> | 2098 | </itemizedlist> |
2094 | The <link linkend='var-FILES'><filename>FILES</filename></link> | 2099 | The <ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'><filename>FILES</filename></ulink> |
2095 | variable defines the files that go into each package in | 2100 | variable defines the files that go into each package in |
2096 | <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>. | 2101 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'><filename>PACKAGES</filename></ulink>. |
2097 | If you want details on how this is accomplished, you can | 2102 | If you want details on how this is accomplished, you can |
2098 | look at the | 2103 | look at the |
2099 | <link linkend='ref-classes-package'><filename>package</filename></link> | 2104 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'><filename>package</filename></ulink> |
2100 | class. | 2105 | class. |
2101 | </para> | 2106 | </para> |
2102 | 2107 | ||
@@ -2136,31 +2141,31 @@ | |||
2136 | The image generation process consists of several stages and | 2141 | The image generation process consists of several stages and |
2137 | depends on several tasks and variables. | 2142 | depends on several tasks and variables. |
2138 | The | 2143 | The |
2139 | <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> | 2144 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-rootfs'><filename>do_rootfs</filename></ulink> |
2140 | task creates the root filesystem (file and directory structure) | 2145 | task creates the root filesystem (file and directory structure) |
2141 | for an image. | 2146 | for an image. |
2142 | This task uses several key variables to help create the list | 2147 | This task uses several key variables to help create the list |
2143 | of packages to actually install: | 2148 | of packages to actually install: |
2144 | <itemizedlist> | 2149 | <itemizedlist> |
2145 | <listitem><para><link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>: | 2150 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>: |
2146 | Lists out the base set of packages to install from | 2151 | Lists out the base set of packages to install from |
2147 | the Package Feeds area.</para></listitem> | 2152 | the Package Feeds area.</para></listitem> |
2148 | <listitem><para><link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>: | 2153 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></ulink>: |
2149 | Specifies packages that should not be installed. | 2154 | Specifies packages that should not be installed. |
2150 | </para></listitem> | 2155 | </para></listitem> |
2151 | <listitem><para><link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>: | 2156 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>: |
2152 | Specifies features to include in the image. | 2157 | Specifies features to include in the image. |
2153 | Most of these features map to additional packages for | 2158 | Most of these features map to additional packages for |
2154 | installation.</para></listitem> | 2159 | installation.</para></listitem> |
2155 | <listitem><para><link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>: | 2160 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>: |
2156 | Specifies the package backend to use and consequently | 2161 | Specifies the package backend to use and consequently |
2157 | helps determine where to locate packages within the | 2162 | helps determine where to locate packages within the |
2158 | Package Feeds area.</para></listitem> | 2163 | Package Feeds area.</para></listitem> |
2159 | <listitem><para><link linkend='var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></link>: | 2164 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></ulink>: |
2160 | Determines the language(s) for which additional | 2165 | Determines the language(s) for which additional |
2161 | language support packages are installed. | 2166 | language support packages are installed. |
2162 | </para></listitem> | 2167 | </para></listitem> |
2163 | <listitem><para><link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>: | 2168 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></ulink>: |
2164 | The final list of packages passed to the package manager | 2169 | The final list of packages passed to the package manager |
2165 | for installation into the image. | 2170 | for installation into the image. |
2166 | </para></listitem> | 2171 | </para></listitem> |
@@ -2169,7 +2174,7 @@ | |||
2169 | 2174 | ||
2170 | <para> | 2175 | <para> |
2171 | With | 2176 | With |
2172 | <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> | 2177 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></ulink> |
2173 | pointing to the location of the filesystem under construction and | 2178 | pointing to the location of the filesystem under construction and |
2174 | the <filename>PACKAGE_INSTALL</filename> variable providing the | 2179 | the <filename>PACKAGE_INSTALL</filename> variable providing the |
2175 | final list of packages to install, the root file system is | 2180 | final list of packages to install, the root file system is |
@@ -2207,11 +2212,11 @@ | |||
2207 | in the same directory as the root filesystem image. | 2212 | in the same directory as the root filesystem image. |
2208 | This file lists out, line-by-line, the installed packages. | 2213 | This file lists out, line-by-line, the installed packages. |
2209 | The manifest file is useful for the | 2214 | The manifest file is useful for the |
2210 | <link linkend='ref-classes-testimage*'><filename>testimage</filename></link> | 2215 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-testimage*'><filename>testimage</filename></ulink> |
2211 | class, for example, to determine whether or not to run | 2216 | class, for example, to determine whether or not to run |
2212 | specific tests. | 2217 | specific tests. |
2213 | See the | 2218 | See the |
2214 | <link linkend='var-IMAGE_MANIFEST'><filename>IMAGE_MANIFEST</filename></link> | 2219 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_MANIFEST'><filename>IMAGE_MANIFEST</filename></ulink> |
2215 | variable for additional information. | 2220 | variable for additional information. |
2216 | </para> | 2221 | </para> |
2217 | 2222 | ||
@@ -2219,7 +2224,7 @@ | |||
2219 | Optimizing processes run across the image include | 2224 | Optimizing processes run across the image include |
2220 | <filename>mklibs</filename>, <filename>prelink</filename>, | 2225 | <filename>mklibs</filename>, <filename>prelink</filename>, |
2221 | and any other post-processing commands as defined by the | 2226 | and any other post-processing commands as defined by the |
2222 | <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></link> | 2227 | <ulink url='&YOCTO_DOCS_REF_URL;#var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></ulink> |
2223 | variable. | 2228 | variable. |
2224 | The <filename>mklibs</filename> process optimizes the size | 2229 | The <filename>mklibs</filename> process optimizes the size |
2225 | of the libraries, while the | 2230 | of the libraries, while the |
@@ -2231,11 +2236,11 @@ | |||
2231 | <para> | 2236 | <para> |
2232 | After the root filesystem is built, processing begins on | 2237 | After the root filesystem is built, processing begins on |
2233 | the image through the | 2238 | the image through the |
2234 | <link linkend='ref-tasks-image'><filename>do_image</filename></link> | 2239 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-image'><filename>do_image</filename></ulink> |
2235 | task. | 2240 | task. |
2236 | The build system runs any pre-processing commands as defined | 2241 | The build system runs any pre-processing commands as defined |
2237 | by the | 2242 | by the |
2238 | <link linkend='var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></link> | 2243 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></ulink> |
2239 | variable. | 2244 | variable. |
2240 | This variable specifies a list of functions to call before | 2245 | This variable specifies a list of functions to call before |
2241 | the OpenEmbedded build system creates the final image output | 2246 | the OpenEmbedded build system creates the final image output |
@@ -2246,7 +2251,7 @@ | |||
2246 | The OpenEmbedded build system dynamically creates | 2251 | The OpenEmbedded build system dynamically creates |
2247 | <filename>do_image_*</filename> tasks as needed, based | 2252 | <filename>do_image_*</filename> tasks as needed, based |
2248 | on the image types specified in the | 2253 | on the image types specified in the |
2249 | <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> | 2254 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></ulink> |
2250 | variable. | 2255 | variable. |
2251 | The process turns everything into an image file or a set of | 2256 | The process turns everything into an image file or a set of |
2252 | image files and compresses the root filesystem image to reduce | 2257 | image files and compresses the root filesystem image to reduce |
@@ -2273,11 +2278,11 @@ | |||
2273 | 2278 | ||
2274 | <para> | 2279 | <para> |
2275 | The final task involved in image creation is the | 2280 | The final task involved in image creation is the |
2276 | <link linkend='ref-tasks-image-complete'><filename>do_image_complete</filename></link> | 2281 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-image-complete'><filename>do_image_complete</filename></ulink> |
2277 | task. | 2282 | task. |
2278 | This task completes the image by applying any image | 2283 | This task completes the image by applying any image |
2279 | post processing as defined through the | 2284 | post processing as defined through the |
2280 | <link linkend='var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></link> | 2285 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></ulink> |
2281 | variable. | 2286 | variable. |
2282 | The variable specifies a list of functions to call once the | 2287 | The variable specifies a list of functions to call once the |
2283 | OpenEmbedded build system has created the final image output | 2288 | OpenEmbedded build system has created the final image output |
@@ -2304,11 +2309,11 @@ | |||
2304 | <note> | 2309 | <note> |
2305 | For more information on the cross-development toolchain | 2310 | For more information on the cross-development toolchain |
2306 | generation, see the | 2311 | generation, see the |
2307 | "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" | 2312 | "<ulink url='&YOCTO_DOCS_REF_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" |
2308 | section. | 2313 | section in the Yocto Project Reference Manual. |
2309 | For information on advantages gained when building a | 2314 | For information on advantages gained when building a |
2310 | cross-development toolchain using the | 2315 | cross-development toolchain using the |
2311 | <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link> | 2316 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></ulink> |
2312 | task, see the | 2317 | task, see the |
2313 | "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" | 2318 | "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" |
2314 | section in the Yocto Project Application Development and the | 2319 | section in the Yocto Project Application Development and the |
@@ -2334,7 +2339,7 @@ | |||
2334 | The target part is the part built for the target hardware and | 2339 | The target part is the part built for the target hardware and |
2335 | includes libraries and headers. | 2340 | includes libraries and headers. |
2336 | The host part is the part of the SDK that runs on the | 2341 | The host part is the part of the SDK that runs on the |
2337 | <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>. | 2342 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink>. |
2338 | </para> | 2343 | </para> |
2339 | 2344 | ||
2340 | <para> | 2345 | <para> |
@@ -2362,10 +2367,10 @@ | |||
2362 | <para> | 2367 | <para> |
2363 | For each task that completes successfully, BitBake writes a | 2368 | For each task that completes successfully, BitBake writes a |
2364 | stamp file into the | 2369 | stamp file into the |
2365 | <link linkend='var-STAMPS_DIR'><filename>STAMPS_DIR</filename></link> | 2370 | <ulink url='&YOCTO_DOCS_REF_URL;#var-STAMPS_DIR'><filename>STAMPS_DIR</filename></ulink> |
2366 | directory. | 2371 | directory. |
2367 | The beginning of the stamp file's filename is determined by the | 2372 | The beginning of the stamp file's filename is determined by the |
2368 | <link linkend='var-STAMP'><filename>STAMP</filename></link> | 2373 | <ulink url='&YOCTO_DOCS_REF_URL;#var-STAMP'><filename>STAMP</filename></ulink> |
2369 | variable, and the end of the name consists of the task's name | 2374 | variable, and the end of the name consists of the task's name |
2370 | and current | 2375 | and current |
2371 | <ulink url='&YOCTO_DOCS_BB_URL;#checksums'>input checksum</ulink>. | 2376 | <ulink url='&YOCTO_DOCS_BB_URL;#checksums'>input checksum</ulink>. |
@@ -2392,9 +2397,9 @@ | |||
2392 | serve as a marker that some work has been done and that | 2397 | serve as a marker that some work has been done and that |
2393 | these files do not record task output. | 2398 | these files do not record task output. |
2394 | The actual task output would usually be somewhere in | 2399 | The actual task output would usually be somewhere in |
2395 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> | 2400 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink> |
2396 | (e.g. in some recipe's | 2401 | (e.g. in some recipe's |
2397 | <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>.) | 2402 | <ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>.) |
2398 | What the sstate cache mechanism adds is a way to cache task | 2403 | What the sstate cache mechanism adds is a way to cache task |
2399 | output that can then be shared between build machines. | 2404 | output that can then be shared between build machines. |
2400 | </para> | 2405 | </para> |
@@ -2419,8 +2424,8 @@ | |||
2419 | <para> | 2424 | <para> |
2420 | For details on how to view information about a task's | 2425 | For details on how to view information about a task's |
2421 | signature, see the | 2426 | signature, see the |
2422 | "<link linkend='usingpoky-viewing-task-variable-dependencies'>Viewing Task Variable Dependencies</link>" | 2427 | "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-viewing-task-variable-dependencies'>Viewing Task Variable Dependencies</ulink>" |
2423 | section. | 2428 | section in the Yocto Project Reference Manual. |
2424 | </para> | 2429 | </para> |
2425 | </section> | 2430 | </section> |
2426 | 2431 | ||
@@ -2436,9 +2441,9 @@ | |||
2436 | shared state (sstate) cache. | 2441 | shared state (sstate) cache. |
2437 | <note> | 2442 | <note> |
2438 | For information on variables affecting sstate, see the | 2443 | For information on variables affecting sstate, see the |
2439 | <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link> | 2444 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink> |
2440 | and | 2445 | and |
2441 | <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> | 2446 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></ulink> |
2442 | variables. | 2447 | variables. |
2443 | </note> | 2448 | </note> |
2444 | </para> | 2449 | </para> |
@@ -2454,21 +2459,22 @@ | |||
2454 | (e.g. generating package files in the | 2459 | (e.g. generating package files in the |
2455 | <filename>do_package_write_*</filename> task). | 2460 | <filename>do_package_write_*</filename> task). |
2456 | In other cases, it does not make sense, (e.g. a | 2461 | In other cases, it does not make sense, (e.g. a |
2457 | <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> | 2462 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink> |
2458 | task or | 2463 | task or |
2459 | <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link> | 2464 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-unpack'><filename>do_unpack</filename></ulink> |
2460 | task) since the work involved would be equal to or greater than | 2465 | task) since the work involved would be equal to or greater than |
2461 | the underlying task. | 2466 | the underlying task. |
2462 | </para> | 2467 | </para> |
2463 | 2468 | ||
2464 | <para> | 2469 | <para> |
2465 | In the OpenEmbedded build system, the common tasks that have | 2470 | In the OpenEmbedded build system, the common tasks that have |
2466 | setscene variants are <link linkend='ref-tasks-package'><filename>do_package</filename></link>, | 2471 | setscene variants are |
2472 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-package'><filename>do_package</filename></ulink>, | ||
2467 | <filename>do_package_write_*</filename>, | 2473 | <filename>do_package_write_*</filename>, |
2468 | <link linkend='ref-tasks-deploy'><filename>do_deploy</filename></link>, | 2474 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-deploy'><filename>do_deploy</filename></ulink>, |
2469 | <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link>, | 2475 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-packagedata'><filename>do_packagedata</filename></ulink>, |
2470 | and | 2476 | and |
2471 | <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link>. | 2477 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></ulink>. |
2472 | Notice that these are most of the tasks whose output is an | 2478 | Notice that these are most of the tasks whose output is an |
2473 | end result. | 2479 | end result. |
2474 | </para> | 2480 | </para> |
@@ -2556,27 +2562,30 @@ | |||
2556 | <para> | 2562 | <para> |
2557 | For a list of example images that the Yocto Project provides, | 2563 | For a list of example images that the Yocto Project provides, |
2558 | see the | 2564 | see the |
2559 | "<link linkend='ref-images'>Images</link>" chapter. | 2565 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" |
2566 | chapter in the Yocto Project Reference Manual. | ||
2560 | </para> | 2567 | </para> |
2561 | 2568 | ||
2562 | <para> | 2569 | <para> |
2563 | Images are written out to the | 2570 | Images are written out to the |
2564 | <link linkend='build-directory'>Build Directory</link> | 2571 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
2565 | inside the <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename> | 2572 | inside the |
2573 | <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename> | ||
2566 | folder as shown in the figure. | 2574 | folder as shown in the figure. |
2567 | This folder contains any files expected to be loaded on the | 2575 | This folder contains any files expected to be loaded on the |
2568 | target device. | 2576 | target device. |
2569 | The | 2577 | The |
2570 | <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link> | 2578 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></ulink> |
2571 | variable points to the <filename>deploy</filename> directory, | 2579 | variable points to the <filename>deploy</filename> directory, |
2572 | while the | 2580 | while the |
2573 | <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> | 2581 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></ulink> |
2574 | variable points to the appropriate directory containing images for | 2582 | variable points to the appropriate directory containing images for |
2575 | the current configuration. | 2583 | the current configuration. |
2576 | <itemizedlist> | 2584 | <itemizedlist> |
2577 | <listitem><para><filename><replaceable>kernel-image</replaceable></filename>: | 2585 | <listitem><para><filename><replaceable>kernel-image</replaceable></filename>: |
2578 | A kernel binary file. | 2586 | A kernel binary file. |
2579 | The <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link> | 2587 | The |
2588 | <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></ulink> | ||
2580 | variable setting determines the naming scheme for the | 2589 | variable setting determines the naming scheme for the |
2581 | kernel image file. | 2590 | kernel image file. |
2582 | Depending on that variable, the file could begin with | 2591 | Depending on that variable, the file could begin with |
@@ -2588,7 +2597,8 @@ | |||
2588 | Root filesystems for the target device (e.g. | 2597 | Root filesystems for the target device (e.g. |
2589 | <filename>*.ext3</filename> or <filename>*.bz2</filename> | 2598 | <filename>*.ext3</filename> or <filename>*.bz2</filename> |
2590 | files). | 2599 | files). |
2591 | The <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> | 2600 | The |
2601 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></ulink> | ||
2592 | variable setting determines the root filesystem image | 2602 | variable setting determines the root filesystem image |
2593 | type. | 2603 | type. |
2594 | The <filename>deploy/images/<replaceable>machine</replaceable></filename> | 2604 | The <filename>deploy/images/<replaceable>machine</replaceable></filename> |
@@ -2598,7 +2608,7 @@ | |||
2598 | Tarballs that contain all the modules built for the kernel. | 2608 | Tarballs that contain all the modules built for the kernel. |
2599 | Kernel module tarballs exist for legacy purposes and | 2609 | Kernel module tarballs exist for legacy purposes and |
2600 | can be suppressed by setting the | 2610 | can be suppressed by setting the |
2601 | <link linkend='var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></link> | 2611 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></ulink> |
2602 | variable to "0". | 2612 | variable to "0". |
2603 | The <filename>deploy/images/<replaceable>machine</replaceable></filename> | 2613 | The <filename>deploy/images/<replaceable>machine</replaceable></filename> |
2604 | directory can contain multiple kernel module tarballs | 2614 | directory can contain multiple kernel module tarballs |
@@ -2654,49 +2664,52 @@ | |||
2654 | the environment before using the tools. | 2664 | the environment before using the tools. |
2655 | </para> | 2665 | </para> |
2656 | 2666 | ||
2657 | <note> | 2667 | <note><title>Notes</title> |
2658 | <para> | 2668 | <itemizedlist> |
2659 | The Yocto Project supports several methods by which you can | 2669 | <listitem><para> |
2660 | set up this cross-development environment. | 2670 | The Yocto Project supports several methods by which you can |
2661 | These methods include downloading pre-built SDK installers | 2671 | set up this cross-development environment. |
2662 | or building and installing your own SDK installer. | 2672 | These methods include downloading pre-built SDK installers |
2663 | </para> | 2673 | or building and installing your own SDK installer. |
2664 | 2674 | </para></listitem> | |
2665 | <para> | 2675 | <listitem><para> |
2666 | For background information on cross-development toolchains | 2676 | For background information on cross-development toolchains |
2667 | in the Yocto Project development environment, see the | 2677 | in the Yocto Project development environment, see the |
2668 | "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" | 2678 | "<ulink url='&YOCTO_DOCS_REF_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" |
2669 | section. | 2679 | section in the Yocto Project Reference Manual. |
2670 | For information on setting up a cross-development | 2680 | </para></listitem> |
2671 | environment, see the | 2681 | <listitem><para> |
2672 | <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> | 2682 | For information on setting up a cross-development |
2673 | manual. | 2683 | environment, see the |
2674 | </para> | 2684 | <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> |
2685 | manual. | ||
2686 | </para></listitem> | ||
2687 | </itemizedlist> | ||
2675 | </note> | 2688 | </note> |
2676 | 2689 | ||
2677 | <para> | 2690 | <para> |
2678 | Once built, the SDK installers are written out to the | 2691 | Once built, the SDK installers are written out to the |
2679 | <filename>deploy/sdk</filename> folder inside the | 2692 | <filename>deploy/sdk</filename> folder inside the |
2680 | <link linkend='build-directory'>Build Directory</link> | 2693 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
2681 | as shown in the figure at the beginning of this section. | 2694 | as shown in the figure at the beginning of this section. |
2682 | Depending on the type of SDK, several variables exist that help | 2695 | Depending on the type of SDK, several variables exist that help |
2683 | configure these files. | 2696 | configure these files. |
2684 | The following list shows the variables associated with a standard | 2697 | The following list shows the variables associated with a standard |
2685 | SDK: | 2698 | SDK: |
2686 | <itemizedlist> | 2699 | <itemizedlist> |
2687 | <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: | 2700 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></ulink>: |
2688 | Points to the <filename>deploy</filename> | 2701 | Points to the <filename>deploy</filename> |
2689 | directory.</para></listitem> | 2702 | directory.</para></listitem> |
2690 | <listitem><para><link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>: | 2703 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink>: |
2691 | Specifies the architecture of the machine | 2704 | Specifies the architecture of the machine |
2692 | on which the cross-development tools are run to | 2705 | on which the cross-development tools are run to |
2693 | create packages for the target hardware. | 2706 | create packages for the target hardware. |
2694 | </para></listitem> | 2707 | </para></listitem> |
2695 | <listitem><para><link linkend='var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></link>: | 2708 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></ulink>: |
2696 | Lists the features to include in the "target" part | 2709 | Lists the features to include in the "target" part |
2697 | of the SDK. | 2710 | of the SDK. |
2698 | </para></listitem> | 2711 | </para></listitem> |
2699 | <listitem><para><link linkend='var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></link>: | 2712 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></ulink>: |
2700 | Lists packages that make up the host | 2713 | Lists packages that make up the host |
2701 | part of the SDK (i.e. the part that runs on | 2714 | part of the SDK (i.e. the part that runs on |
2702 | the <filename>SDKMACHINE</filename>). | 2715 | the <filename>SDKMACHINE</filename>). |
@@ -2706,12 +2719,12 @@ | |||
2706 | apply. | 2719 | apply. |
2707 | This variable allows you to add more packages. | 2720 | This variable allows you to add more packages. |
2708 | </para></listitem> | 2721 | </para></listitem> |
2709 | <listitem><para><link linkend='var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></link>: | 2722 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink>: |
2710 | Lists packages that make up the target part | 2723 | Lists packages that make up the target part |
2711 | of the SDK (i.e. the part built for the | 2724 | of the SDK (i.e. the part built for the |
2712 | target hardware). | 2725 | target hardware). |
2713 | </para></listitem> | 2726 | </para></listitem> |
2714 | <listitem><para><link linkend='var-SDKPATH'><filename>SDKPATH</filename></link>: | 2727 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDKPATH'><filename>SDKPATH</filename></ulink>: |
2715 | Defines the default SDK installation path offered by the | 2728 | Defines the default SDK installation path offered by the |
2716 | installation script. | 2729 | installation script. |
2717 | </para></listitem> | 2730 | </para></listitem> |
@@ -2719,34 +2732,34 @@ | |||
2719 | This next list, shows the variables associated with an extensible | 2732 | This next list, shows the variables associated with an extensible |
2720 | SDK: | 2733 | SDK: |
2721 | <itemizedlist> | 2734 | <itemizedlist> |
2722 | <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: | 2735 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></ulink>: |
2723 | Points to the <filename>deploy</filename> directory. | 2736 | Points to the <filename>deploy</filename> directory. |
2724 | </para></listitem> | 2737 | </para></listitem> |
2725 | <listitem><para><link linkend='var-SDK_EXT_TYPE'><filename>SDK_EXT_TYPE</filename></link>: | 2738 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_EXT_TYPE'><filename>SDK_EXT_TYPE</filename></ulink>: |
2726 | Controls whether or not shared state artifacts are copied | 2739 | Controls whether or not shared state artifacts are copied |
2727 | into the extensible SDK. | 2740 | into the extensible SDK. |
2728 | By default, all required shared state artifacts are copied | 2741 | By default, all required shared state artifacts are copied |
2729 | into the SDK. | 2742 | into the SDK. |
2730 | </para></listitem> | 2743 | </para></listitem> |
2731 | <listitem><para><link linkend='var-SDK_INCLUDE_PKGDATA'><filename>SDK_INCLUDE_PKGDATA</filename></link>: | 2744 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_PKGDATA'><filename>SDK_INCLUDE_PKGDATA</filename></ulink>: |
2732 | Specifies whether or not packagedata will be included in | 2745 | Specifies whether or not packagedata will be included in |
2733 | the extensible SDK for all recipes in the "world" target. | 2746 | the extensible SDK for all recipes in the "world" target. |
2734 | </para></listitem> | 2747 | </para></listitem> |
2735 | <listitem><para><link linkend='var-SDK_INCLUDE_TOOLCHAIN'><filename>SDK_INCLUDE_TOOLCHAIN</filename></link>: | 2748 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN'><filename>SDK_INCLUDE_TOOLCHAIN</filename></ulink>: |
2736 | Specifies whether or not the toolchain will be included | 2749 | Specifies whether or not the toolchain will be included |
2737 | when building the extensible SDK. | 2750 | when building the extensible SDK. |
2738 | </para></listitem> | 2751 | </para></listitem> |
2739 | <listitem><para><link linkend='var-SDK_LOCAL_CONF_WHITELIST'><filename>SDK_LOCAL_CONF_WHITELIST</filename></link>: | 2752 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_LOCAL_CONF_WHITELIST'><filename>SDK_LOCAL_CONF_WHITELIST</filename></ulink>: |
2740 | A list of variables allowed through from the build system | 2753 | A list of variables allowed through from the build system |
2741 | configuration into the extensible SDK configuration. | 2754 | configuration into the extensible SDK configuration. |
2742 | </para></listitem> | 2755 | </para></listitem> |
2743 | <listitem><para><link linkend='var-SDK_LOCAL_CONF_BLACKLIST'><filename>SDK_LOCAL_CONF_BLACKLIST</filename></link>: | 2756 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_LOCAL_CONF_BLACKLIST'><filename>SDK_LOCAL_CONF_BLACKLIST</filename></ulink>: |
2744 | A list of variables not allowed through from the build | 2757 | A list of variables not allowed through from the build |
2745 | system configuration into the extensible SDK configuration. | 2758 | system configuration into the extensible SDK configuration. |
2746 | </para></listitem> | 2759 | </para></listitem> |
2747 | <listitem><para><link linkend='var-SDK_INHERIT_BLACKLIST'><filename>SDK_INHERIT_BLACKLIST</filename></link>: | 2760 | <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INHERIT_BLACKLIST'><filename>SDK_INHERIT_BLACKLIST</filename></ulink>: |
2748 | A list of classes to remove from the | 2761 | A list of classes to remove from the |
2749 | <link linkend='var-INHERIT'><filename>INHERIT</filename></link> | 2762 | <ulink url='&YOCTO_DOCS_REF_URL;#var-INHERIT'><filename>INHERIT</filename></ulink> |
2750 | value globally within the extensible SDK configuration. | 2763 | value globally within the extensible SDK configuration. |
2751 | </para></listitem> | 2764 | </para></listitem> |
2752 | </itemizedlist> | 2765 | </itemizedlist> |
diff --git a/documentation/overview-manual/overview-manual.xml b/documentation/overview-manual/overview-manual.xml index 9eda19a8f7..9af914a924 100644 --- a/documentation/overview-manual/overview-manual.xml +++ b/documentation/overview-manual/overview-manual.xml | |||
@@ -84,6 +84,8 @@ | |||
84 | 84 | ||
85 | <xi:include href="overview-manual-intro.xml"/> | 85 | <xi:include href="overview-manual-intro.xml"/> |
86 | 86 | ||
87 | <xi:include href="overview-development-environment.xml"/> | ||
88 | |||
87 | </book> | 89 | </book> |
88 | <!-- | 90 | <!-- |
89 | vim: expandtab tw=80 ts=4 | 91 | vim: expandtab tw=80 ts=4 |
diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml index 11dfc5b13e..ddb5078454 100644 --- a/documentation/ref-manual/faq.xml +++ b/documentation/ref-manual/faq.xml | |||
@@ -417,10 +417,10 @@ | |||
417 | 417 | ||
418 | <para> | 418 | <para> |
419 | You can find more information on licensing in the | 419 | You can find more information on licensing in the |
420 | "<link linkend='licensing'>Licensing</link>" section and in the | 420 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#licensing'>Licensing</ulink>" |
421 | section in the Yocto Project Overview Manual and also in the | ||
421 | "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" | 422 | "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" |
422 | section, which is in the Yocto Project Development Tasks | 423 | section in the Yocto Project Development Tasks Manual. |
423 | Manual. | ||
424 | </para> | 424 | </para> |
425 | </answer> | 425 | </answer> |
426 | </qandaentry> | 426 | </qandaentry> |
diff --git a/documentation/ref-manual/figures/source-repos.png b/documentation/ref-manual/figures/source-repos.png deleted file mode 100644 index e9cff16cc8..0000000000 --- a/documentation/ref-manual/figures/source-repos.png +++ /dev/null | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index 3f55e73100..588d392f8e 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml | |||
@@ -1015,8 +1015,8 @@ | |||
1015 | 1015 | ||
1016 | <para>For more information on concepts related to Git | 1016 | <para>For more information on concepts related to Git |
1017 | repositories, branches, and tags, see the | 1017 | repositories, branches, and tags, see the |
1018 | "<link linkend='repositories-tags-and-branches'>Repositories, Tags, and Branches</link>" | 1018 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#repositories-tags-and-branches'>Repositories, Tags, and Branches</ulink>" |
1019 | section. | 1019 | section in the Yocto Project Overview Manual. |
1020 | </para></listitem> | 1020 | </para></listitem> |
1021 | <listitem><para><emphasis>Task:</emphasis> | 1021 | <listitem><para><emphasis>Task:</emphasis> |
1022 | A unit of execution for BitBake (e.g. | 1022 | A unit of execution for BitBake (e.g. |
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 5dea5ad960..8a6b8a18fc 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml | |||
@@ -293,7 +293,7 @@ | |||
293 | For the remainder, you can now find them in the | 293 | For the remainder, you can now find them in the |
294 | <filename>meta-extras</filename> repository, which is in the | 294 | <filename>meta-extras</filename> repository, which is in the |
295 | Yocto Project | 295 | Yocto Project |
296 | <link linkend='source-repositories'>Source Repositories</link>. | 296 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink>. |
297 | </para> | 297 | </para> |
298 | </section> | 298 | </section> |
299 | </section> | 299 | </section> |
@@ -1748,8 +1748,8 @@ | |||
1748 | 1748 | ||
1749 | <para> | 1749 | <para> |
1750 | The minimum | 1750 | The minimum |
1751 | <link linkend='git'>Git</link> version required | 1751 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> version |
1752 | on the build host is now 1.7.8 because the | 1752 | required on the build host is now 1.7.8 because the |
1753 | <filename>--list</filename> option is now required by | 1753 | <filename>--list</filename> option is now required by |
1754 | BitBake's Git fetcher. | 1754 | BitBake's Git fetcher. |
1755 | As always, if your host distribution does not provide a version of | 1755 | As always, if your host distribution does not provide a version of |
@@ -4038,7 +4038,7 @@ $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64. | |||
4038 | <para>For an example, see the | 4038 | <para>For an example, see the |
4039 | <filename>pixbufcache</filename> class in | 4039 | <filename>pixbufcache</filename> class in |
4040 | <filename>meta/classes/</filename> in the Yocto Project | 4040 | <filename>meta/classes/</filename> in the Yocto Project |
4041 | <link linkend='source-repositories'>Source Repositories</link>. | 4041 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink>. |
4042 | <note> | 4042 | <note> |
4043 | The <filename>SSTATEPOSTINSTFUNCS</filename> variable | 4043 | The <filename>SSTATEPOSTINSTFUNCS</filename> variable |
4044 | itself is now deprecated in favor of the | 4044 | itself is now deprecated in favor of the |
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 0fc88c43a7..f27f33f292 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -1249,8 +1249,8 @@ | |||
1249 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage'>Customizing Images</ulink>" | 1249 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage'>Customizing Images</ulink>" |
1250 | section in the Yocto Project Development Tasks Manual. | 1250 | section in the Yocto Project Development Tasks Manual. |
1251 | For information on how images are created, see the | 1251 | For information on how images are created, see the |
1252 | "<link linkend='images-dev-environment'>Images</link>" section elsewhere | 1252 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" |
1253 | in this manual. | 1253 | section in the Yocto Project Overview Manual. |
1254 | </para> | 1254 | </para> |
1255 | </section> | 1255 | </section> |
1256 | 1256 | ||
@@ -3018,8 +3018,8 @@ This check was removed for YP 2.3 release | |||
3018 | 3018 | ||
3019 | <para> | 3019 | <para> |
3020 | For information on how root filesystem images are created, see the | 3020 | For information on how root filesystem images are created, see the |
3021 | "<link linkend='image-generation-dev-environment'>Image Generation</link>" | 3021 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
3022 | section. | 3022 | section in the Yocto Project Overview Manual. |
3023 | </para> | 3023 | </para> |
3024 | </section> | 3024 | </section> |
3025 | 3025 | ||
diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml index e2aed1fd38..a24a9e310d 100644 --- a/documentation/ref-manual/ref-manual.xml +++ b/documentation/ref-manual/ref-manual.xml | |||
@@ -170,8 +170,6 @@ | |||
170 | 170 | ||
171 | <xi:include href="usingpoky.xml"/> | 171 | <xi:include href="usingpoky.xml"/> |
172 | 172 | ||
173 | <xi:include href="ref-development-environment.xml"/> | ||
174 | |||
175 | <xi:include href="technical-details.xml"/> | 173 | <xi:include href="technical-details.xml"/> |
176 | 174 | ||
177 | <xi:include href="ref-release-process.xml"/> | 175 | <xi:include href="ref-release-process.xml"/> |
diff --git a/documentation/ref-manual/ref-release-process.xml b/documentation/ref-manual/ref-release-process.xml index e2902eb38b..1b36932e21 100644 --- a/documentation/ref-manual/ref-release-process.xml +++ b/documentation/ref-manual/ref-release-process.xml | |||
@@ -61,7 +61,7 @@ | |||
61 | <para> | 61 | <para> |
62 | Each major release receives a codename that identifies the release in | 62 | Each major release receives a codename that identifies the release in |
63 | the | 63 | the |
64 | <link linkend='yocto-project-repositories'>Yocto Project Source Repositories</link>. | 64 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>. |
65 | The concept is that branches of | 65 | The concept is that branches of |
66 | <link linkend='metadata'>Metadata</link> | 66 | <link linkend='metadata'>Metadata</link> |
67 | with the same codename are likely to be compatible and thus | 67 | with the same codename are likely to be compatible and thus |
@@ -217,7 +217,7 @@ | |||
217 | in the <filename>poky</filename> repository. | 217 | in the <filename>poky</filename> repository. |
218 | <note> | 218 | <note> |
219 | You can find all these branches in the Yocto Project | 219 | You can find all these branches in the Yocto Project |
220 | <link linkend='source-repositories'>Source Repositories</link>. | 220 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink>. |
221 | </note> | 221 | </note> |
222 | Testing within these public branches ensures in a publicly visible way | 222 | Testing within these public branches ensures in a publicly visible way |
223 | that all of the main supposed architectures and recipes in OE-Core | 223 | that all of the main supposed architectures and recipes in OE-Core |
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 4bddc59965..ad8f24efd7 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml | |||
@@ -520,9 +520,10 @@ | |||
520 | variable points to this directory. | 520 | variable points to this directory. |
521 | For more detail on the contents of the <filename>deploy</filename> | 521 | For more detail on the contents of the <filename>deploy</filename> |
522 | directory, see the | 522 | directory, see the |
523 | "<link linkend='images-dev-environment'>Images</link>" and | 523 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" |
524 | "<link linkend='sdk-dev-environment'>Application Development SDK</link>" | 524 | and |
525 | sections. | 525 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-dev-environment'>Application Development SDK</ulink>" |
526 | sections in the Yocto Project Overview Manual. | ||
526 | </para> | 527 | </para> |
527 | </section> | 528 | </section> |
528 | 529 | ||
@@ -695,8 +696,8 @@ | |||
695 | <para> | 696 | <para> |
696 | For information on how BitBake uses stamp files to determine if | 697 | For information on how BitBake uses stamp files to determine if |
697 | a task should be rerun, see the | 698 | a task should be rerun, see the |
698 | "<link linkend='stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</link>" | 699 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" |
699 | section. | 700 | section in the Yocto Project Overview Manual. |
700 | </para> | 701 | </para> |
701 | </section> | 702 | </section> |
702 | 703 | ||
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index c726cb904b..62a677a430 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml | |||
@@ -220,8 +220,8 @@ | |||
220 | 220 | ||
221 | <para> | 221 | <para> |
222 | For more information on image creation, see the | 222 | For more information on image creation, see the |
223 | "<link linkend='image-generation-dev-environment'>Image Generation</link>" | 223 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
224 | section. | 224 | section in the Yocto Project Overview Manual. |
225 | </para> | 225 | </para> |
226 | </section> | 226 | </section> |
227 | 227 | ||
@@ -246,8 +246,8 @@ | |||
246 | 246 | ||
247 | <para> | 247 | <para> |
248 | For more information on image creation, see the | 248 | For more information on image creation, see the |
249 | "<link linkend='image-generation-dev-environment'>Image Generation</link>" | 249 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
250 | section. | 250 | section in the Yocto Project Overview Manual. |
251 | </para> | 251 | </para> |
252 | </section> | 252 | </section> |
253 | 253 | ||
@@ -367,8 +367,8 @@ | |||
367 | <filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename> | 367 | <filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename> |
368 | directory in the package feeds area. | 368 | directory in the package feeds area. |
369 | For more information, see the | 369 | For more information, see the |
370 | "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" | 370 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
371 | section. | 371 | section in the Yocto Project Overview Manual. |
372 | </para> | 372 | </para> |
373 | </section> | 373 | </section> |
374 | 374 | ||
@@ -381,8 +381,8 @@ | |||
381 | <filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename> | 381 | <filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename> |
382 | directory in the package feeds area. | 382 | directory in the package feeds area. |
383 | For more information, see the | 383 | For more information, see the |
384 | "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" | 384 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
385 | section. | 385 | section in the Yocto Project Overview Manual. |
386 | </para> | 386 | </para> |
387 | </section> | 387 | </section> |
388 | 388 | ||
@@ -395,8 +395,8 @@ | |||
395 | <filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename> | 395 | <filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename> |
396 | directory in the package feeds area. | 396 | directory in the package feeds area. |
397 | For more information, see the | 397 | For more information, see the |
398 | "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" | 398 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
399 | section. | 399 | section in the Yocto Project Overview Manual. |
400 | </para> | 400 | </para> |
401 | </section> | 401 | </section> |
402 | 402 | ||
@@ -408,8 +408,8 @@ | |||
408 | <filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename> | 408 | <filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename> |
409 | directory in the package feeds area. | 409 | directory in the package feeds area. |
410 | For more information, see the | 410 | For more information, see the |
411 | "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" | 411 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
412 | section. | 412 | section Yocto Project Overview Manual. |
413 | </para> | 413 | </para> |
414 | </section> | 414 | </section> |
415 | 415 | ||
@@ -431,8 +431,8 @@ | |||
431 | <para> | 431 | <para> |
432 | Locates patch files and applies them to the source code. | 432 | Locates patch files and applies them to the source code. |
433 | See the | 433 | See the |
434 | "<link linkend='patching-dev-environment'>Patching</link>" | 434 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#patching-dev-environment'>Patching</ulink>" |
435 | section for more information. | 435 | section in the Yocto Project Overview Manual for more information. |
436 | </para> | 436 | </para> |
437 | </section> | 437 | </section> |
438 | 438 | ||
@@ -451,8 +451,8 @@ | |||
451 | <para> | 451 | <para> |
452 | Creates the file and directory structure for an installable SDK. | 452 | Creates the file and directory structure for an installable SDK. |
453 | See the | 453 | See the |
454 | "<link linkend='sdk-generation-dev-environment'>SDK Generation</link>" | 454 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-generation-dev-environment'>SDK Generation</ulink>" |
455 | section for more information. | 455 | section in the Yocto Project Overview Manual for more information. |
456 | </para> | 456 | </para> |
457 | </section> | 457 | </section> |
458 | 458 | ||
@@ -538,8 +538,9 @@ | |||
538 | <link linkend='var-S'><filename>S</filename></link> variable also | 538 | <link linkend='var-S'><filename>S</filename></link> variable also |
539 | plays a role in where unpacked source files ultimately reside. | 539 | plays a role in where unpacked source files ultimately reside. |
540 | For more information on how source files are unpacked, see the | 540 | For more information on how source files are unpacked, see the |
541 | "<link linkend='source-fetching-dev-environment'>Source Fetching</link>" | 541 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-fetching-dev-environment'>Source Fetching</ulink>" |
542 | section and the <filename>WORKDIR</filename> and | 542 | section in the Yocto Project Overview Manual and also see the |
543 | <filename>WORKDIR</filename> and | ||
543 | <filename>S</filename> variable descriptions. | 544 | <filename>S</filename> variable descriptions. |
544 | </para> | 545 | </para> |
545 | </section> | 546 | </section> |
@@ -757,7 +758,7 @@ | |||
757 | 758 | ||
758 | <para> | 759 | <para> |
759 | Creates or updates the index in the | 760 | Creates or updates the index in the |
760 | <link linkend='package-feeds-dev-environment'>Package Feeds</link> | 761 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink> |
761 | area. | 762 | area. |
762 | <note> | 763 | <note> |
763 | This task is not triggered with the | 764 | This task is not triggered with the |
@@ -809,8 +810,9 @@ | |||
809 | Creates the root filesystem (file and directory structure) for an | 810 | Creates the root filesystem (file and directory structure) for an |
810 | image. | 811 | image. |
811 | See the | 812 | See the |
812 | "<link linkend='image-generation-dev-environment'>Image Generation</link>" | 813 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
813 | section for more information on how the root filesystem is created. | 814 | section in the Yocto Project Overview Manual for more information |
815 | on how the root filesystem is created. | ||
814 | </para> | 816 | </para> |
815 | </section> | 817 | </section> |
816 | 818 | ||
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 521eaeaed2..d621b3293f 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -3327,11 +3327,12 @@ | |||
3327 | section. | 3327 | section. |
3328 | For more detail on the contents of the | 3328 | For more detail on the contents of the |
3329 | <filename>deploy</filename> directory, see the | 3329 | <filename>deploy</filename> directory, see the |
3330 | "<link linkend='images-dev-environment'>Images</link>", | 3330 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" |
3331 | "<link linkend='package-feeds-dev-environment'>Package Feeds</link>", | 3331 | section, the |
3332 | and | 3332 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
3333 | "<link linkend='sdk-dev-environment'>Application Development SDK</link>" | 3333 | section, and the |
3334 | sections. | 3334 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-dev-environment'>Application Development SDK</ulink>" |
3335 | sections all in the Yocto Project Overview Manual. | ||
3335 | </para> | 3336 | </para> |
3336 | </glossdef> | 3337 | </glossdef> |
3337 | </glossentry> | 3338 | </glossentry> |
@@ -3370,8 +3371,8 @@ | |||
3370 | <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link> | 3371 | <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link> |
3371 | task writes Debian packages into the appropriate folder. | 3372 | task writes Debian packages into the appropriate folder. |
3372 | For more information on how packaging works, see the | 3373 | For more information on how packaging works, see the |
3373 | "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" | 3374 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
3374 | section. | 3375 | section in the Yocto Project Overview Manual. |
3375 | </para> | 3376 | </para> |
3376 | </glossdef> | 3377 | </glossdef> |
3377 | </glossentry> | 3378 | </glossentry> |
@@ -3400,9 +3401,10 @@ | |||
3400 | section. | 3401 | section. |
3401 | For more detail on the contents of the | 3402 | For more detail on the contents of the |
3402 | <filename>deploy</filename> directory, see the | 3403 | <filename>deploy</filename> directory, see the |
3403 | "<link linkend='images-dev-environment'>Images</link>" and | 3404 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#images-dev-environment'>Images</ulink>" |
3404 | "<link linkend='sdk-dev-environment'>Application Development SDK</link>" | 3405 | and |
3405 | sections. | 3406 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#sdk-dev-environment'>Application Development SDK</ulink>" |
3407 | sections both in the Yocto Project Overview Manual. | ||
3406 | </para> | 3408 | </para> |
3407 | </glossdef> | 3409 | </glossdef> |
3408 | </glossentry> | 3410 | </glossentry> |
@@ -3440,8 +3442,8 @@ | |||
3440 | <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link> | 3442 | <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link> |
3441 | task writes IPK packages into the appropriate folder. | 3443 | task writes IPK packages into the appropriate folder. |
3442 | For more information on how packaging works, see the | 3444 | For more information on how packaging works, see the |
3443 | "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" | 3445 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
3444 | section. | 3446 | section in the Yocto Project Overview Manual. |
3445 | </para> | 3447 | </para> |
3446 | </glossdef> | 3448 | </glossdef> |
3447 | </glossentry> | 3449 | </glossentry> |
@@ -3479,7 +3481,7 @@ | |||
3479 | <link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link> | 3481 | <link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link> |
3480 | task writes RPM packages into the appropriate folder. | 3482 | task writes RPM packages into the appropriate folder. |
3481 | For more information on how packaging works, see the | 3483 | For more information on how packaging works, see the |
3482 | "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" | 3484 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
3483 | section. | 3485 | section. |
3484 | </para> | 3486 | </para> |
3485 | </glossdef> | 3487 | </glossdef> |
@@ -3518,8 +3520,8 @@ | |||
3518 | <link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link> | 3520 | <link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link> |
3519 | task writes TAR packages into the appropriate folder. | 3521 | task writes TAR packages into the appropriate folder. |
3520 | For more information on how packaging works, see the | 3522 | For more information on how packaging works, see the |
3521 | "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" | 3523 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" |
3522 | section. | 3524 | section in the Yocto Project Overview Manual. |
3523 | </para> | 3525 | </para> |
3524 | </glossdef> | 3526 | </glossdef> |
3525 | </glossentry> | 3527 | </glossentry> |
@@ -4860,7 +4862,7 @@ | |||
4860 | The previous statement appears in the | 4862 | The previous statement appears in the |
4861 | <filename>linux-yocto-dev.bbappend</filename> file, which | 4863 | <filename>linux-yocto-dev.bbappend</filename> file, which |
4862 | is found in the Yocto Project | 4864 | is found in the Yocto Project |
4863 | <link linkend='source-repositories'>Source Repositories</link> | 4865 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#source-repositories'>Source Repositories</ulink> |
4864 | in | 4866 | in |
4865 | <filename>meta-intel/common/recipes-kernel/linux</filename>. | 4867 | <filename>meta-intel/common/recipes-kernel/linux</filename>. |
4866 | Here, the machine override is a special | 4868 | Here, the machine override is a special |
@@ -6078,8 +6080,8 @@ | |||
6078 | variables. | 6080 | variables. |
6079 | You can find information on how the image | 6081 | You can find information on how the image |
6080 | is created in the | 6082 | is created in the |
6081 | "<link linkend='image-generation-dev-environment'>Image Generation</link>" | 6083 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#image-generation-dev-environment'>Image Generation</ulink>" |
6082 | section. | 6084 | section in the Yocto Project Overview Manual. |
6083 | </para> | 6085 | </para> |
6084 | </glossdef> | 6086 | </glossdef> |
6085 | </glossentry> | 6087 | </glossentry> |
@@ -13687,8 +13689,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
13687 | <para> | 13689 | <para> |
13688 | For information on how BitBake uses stamp files to determine | 13690 | For information on how BitBake uses stamp files to determine |
13689 | if a task should be rerun, see the | 13691 | if a task should be rerun, see the |
13690 | "<link linkend='stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</link>" | 13692 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" |
13691 | section. | 13693 | section in the Yocto Project Overview Manual. |
13692 | </para> | 13694 | </para> |
13693 | 13695 | ||
13694 | <para> | 13696 | <para> |
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index e9e76e46d7..2619a19e63 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml | |||
@@ -56,8 +56,8 @@ | |||
56 | Following are some brief details on these core components. | 56 | Following are some brief details on these core components. |
57 | For additional information on how these components interact during | 57 | For additional information on how these components interact during |
58 | a build, see the | 58 | a build, see the |
59 | "<link linkend='development-concepts'>Development Concepts</link>" | 59 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#development-concepts'>Development Concepts</ulink>" |
60 | section. | 60 | section in the Yocto Project Overview Manual. |
61 | </para> | 61 | </para> |
62 | 62 | ||
63 | <section id='usingpoky-components-bitbake'> | 63 | <section id='usingpoky-components-bitbake'> |
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 9b0e7dd019..b1d599d225 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml | |||
@@ -640,8 +640,9 @@ | |||
640 | <filename>-c</filename>, BitBake will only run the task if it | 640 | <filename>-c</filename>, BitBake will only run the task if it |
641 | considers it "out of date". | 641 | considers it "out of date". |
642 | See the | 642 | See the |
643 | "<link linkend='stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</link>" | 643 | "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" |
644 | section for how BitBake determines whether a task is "out of date". | 644 | section in the Yocto Project Overview Manual for how BitBake |
645 | determines whether a task is "out of date". | ||
645 | </para> | 646 | </para> |
646 | 647 | ||
647 | <para> | 648 | <para> |
@@ -1481,7 +1482,7 @@ qemux86" or "qemux86-64". | |||
1481 | Enabling build history as previously described causes the | 1482 | Enabling build history as previously described causes the |
1482 | OpenEmbedded build system to collect build output information and | 1483 | OpenEmbedded build system to collect build output information and |
1483 | commit it as a single commit to a local | 1484 | commit it as a single commit to a local |
1484 | <link linkend='git'>Git</link> repository. | 1485 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> repository. |
1485 | <note> | 1486 | <note> |
1486 | Enabling build history increases your build times slightly, | 1487 | Enabling build history increases your build times slightly, |
1487 | particularly for images, and increases the amount of disk | 1488 | particularly for images, and increases the amount of disk |
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.xml b/documentation/sdk-manual/sdk-appendix-obtain.xml index ab9055e628..d2da5924c2 100644 --- a/documentation/sdk-manual/sdk-appendix-obtain.xml +++ b/documentation/sdk-manual/sdk-appendix-obtain.xml | |||
@@ -327,7 +327,7 @@ | |||
327 | <para>Following is an example command that extracts the root | 327 | <para>Following is an example command that extracts the root |
328 | filesystem from a previously built root filesystem image that | 328 | filesystem from a previously built root filesystem image that |
329 | was downloaded from the | 329 | was downloaded from the |
330 | <ulink url='&YOCTO_DOCS_REF_URL;#index-downloads'>Index of Releases</ulink>. | 330 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#index-downloads'>Index of Releases</ulink>. |
331 | This command extracts the root filesystem into the | 331 | This command extracts the root filesystem into the |
332 | <filename>core2-64-sato</filename> directory: | 332 | <filename>core2-64-sato</filename> directory: |
333 | <literallayout class='monospaced'> | 333 | <literallayout class='monospaced'> |
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml index 444d816a71..ac6fa367ba 100644 --- a/documentation/sdk-manual/sdk-extensible.xml +++ b/documentation/sdk-manual/sdk-extensible.xml | |||
@@ -247,8 +247,8 @@ | |||
247 | <para> | 247 | <para> |
248 | The <filename>devtool</filename> command line is organized | 248 | The <filename>devtool</filename> command line is organized |
249 | similarly to | 249 | similarly to |
250 | <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink> in that it has a | 250 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> in that it |
251 | number of sub-commands for each function. | 251 | has a number of sub-commands for each function. |
252 | You can run <filename>devtool --help</filename> to see all the | 252 | You can run <filename>devtool --help</filename> to see all the |
253 | commands. | 253 | commands. |
254 | <note> | 254 | <note> |
diff --git a/documentation/yocto-project-qs/qs.xml b/documentation/yocto-project-qs/qs.xml index 71354ed685..69ed96f41f 100644 --- a/documentation/yocto-project-qs/qs.xml +++ b/documentation/yocto-project-qs/qs.xml | |||
@@ -316,9 +316,10 @@ | |||
316 | (CROPS), you need to get a copy of the Yocto Project. | 316 | (CROPS), you need to get a copy of the Yocto Project. |
317 | It is recommended that you get the latest Yocto Project release | 317 | It is recommended that you get the latest Yocto Project release |
318 | by setting up (cloning in | 318 | by setting up (cloning in |
319 | <ulink url='&YOCTO_DOCS_REF_URL;#git'>Git</ulink> terms) a | 319 | <ulink url='&YOCTO_DOCS_OVERVIEW_URL;#git'>Git</ulink> |
320 | local copy of the <filename>poky</filename> Git repository on | 320 | terms) a local copy of the <filename>poky</filename> Git |
321 | your build host and then checking out the latest release. | 321 | repository on your build host and then checking out the |
322 | latest release. | ||
322 | Doing so allows you to easily update to newer Yocto Project | 323 | Doing so allows you to easily update to newer Yocto Project |
323 | releases as well as contribute back to the Yocto Project. | 324 | releases as well as contribute back to the Yocto Project. |
324 | </para> | 325 | </para> |