diff options
Diffstat (limited to 'documentation/ref-manual/ref-structure.xml')
-rw-r--r-- | documentation/ref-manual/ref-structure.xml | 39 |
1 files changed, 21 insertions, 18 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index e1c6ee0a8b..72834fd17c 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml | |||
@@ -7,17 +7,19 @@ | |||
7 | <title>Source Directory Structure</title> | 7 | <title>Source Directory Structure</title> |
8 | 8 | ||
9 | <para> | 9 | <para> |
10 | The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> consists of several components. | 10 | The <link linkend='source-directory'>Source Directory</link> |
11 | Understanding them and knowing where they are located is key to using the Yocto Project well. | 11 | consists of several components. |
12 | This chapter describes the Source Directory and gives information about the various | 12 | Understanding them and knowing where they are located is key to using the |
13 | files and directories. | 13 | Yocto Project well. |
14 | This chapter describes the Source Directory and gives information about | ||
15 | the various files and directories. | ||
14 | </para> | 16 | </para> |
15 | 17 | ||
16 | <para> | 18 | <para> |
17 | For information on how to establish a local Source Directory on your | 19 | For information on how to establish a local Source Directory on your |
18 | development system, see the | 20 | development system, see the |
19 | "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-yocto-project-source-files'>Working With Yocto Project Source Files</ulink>" | 21 | "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-yocto-project-source-files'>Working With Yocto Project Source Files</ulink>" |
20 | section in the Yocto Project Development Manual. | 22 | section in the Yocto Project Development Tasks Manual. |
21 | </para> | 23 | </para> |
22 | 24 | ||
23 | <note> | 25 | <note> |
@@ -32,7 +34,7 @@ | |||
32 | 34 | ||
33 | <para> | 35 | <para> |
34 | This section describes the top-level components of the | 36 | This section describes the top-level components of the |
35 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 37 | <link linkend='source-directory'>Source Directory</link>. |
36 | </para> | 38 | </para> |
37 | 39 | ||
38 | <section id='structure-core-bitbake'> | 40 | <section id='structure-core-bitbake'> |
@@ -43,7 +45,7 @@ | |||
43 | The copy usually matches the current stable BitBake release from | 45 | The copy usually matches the current stable BitBake release from |
44 | the BitBake project. | 46 | the BitBake project. |
45 | BitBake, a | 47 | BitBake, a |
46 | <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink> | 48 | <link linkend='metadata'>Metadata</link> |
47 | interpreter, reads the Yocto Project Metadata and runs the tasks | 49 | interpreter, reads the Yocto Project Metadata and runs the tasks |
48 | defined by that data. | 50 | defined by that data. |
49 | Failures are usually from the Metadata and not from BitBake itself. | 51 | Failures are usually from the Metadata and not from BitBake itself. |
@@ -85,7 +87,7 @@ | |||
85 | <para> | 87 | <para> |
86 | It is also possible to place output and configuration | 88 | It is also possible to place output and configuration |
87 | files in a directory separate from the | 89 | files in a directory separate from the |
88 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | 90 | <link linkend='source-directory'>Source Directory</link> |
89 | by providing a directory name when you <filename>source</filename> | 91 | by providing a directory name when you <filename>source</filename> |
90 | the setup script. | 92 | the setup script. |
91 | For information on separating output from your local | 93 | For information on separating output from your local |
@@ -221,13 +223,13 @@ | |||
221 | The script gets its default list of common targets from the | 223 | The script gets its default list of common targets from the |
222 | <filename>conf-notes.txt</filename> file, which is found in the | 224 | <filename>conf-notes.txt</filename> file, which is found in the |
223 | <filename>meta-poky</filename> directory within the | 225 | <filename>meta-poky</filename> directory within the |
224 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 226 | <link linkend='source-directory'>Source Directory</link>. |
225 | Should you have custom distributions, it is very easy to modify | 227 | Should you have custom distributions, it is very easy to modify |
226 | this configuration file to include your targets for your | 228 | this configuration file to include your targets for your |
227 | distribution. | 229 | distribution. |
228 | See the | 230 | See the |
229 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" | 231 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" |
230 | section in the Yocto Project Development Manual for more | 232 | section in the Yocto Project Development Tasks Manual for more |
231 | information. | 233 | information. |
232 | </para> | 234 | </para> |
233 | 235 | ||
@@ -241,17 +243,17 @@ | |||
241 | build system to create a Build Directory of your choice. | 243 | build system to create a Build Directory of your choice. |
242 | For example, the following command creates a Build Directory named | 244 | For example, the following command creates a Build Directory named |
243 | <filename>mybuilds</filename> that is outside of the | 245 | <filename>mybuilds</filename> that is outside of the |
244 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: | 246 | <link linkend='source-directory'>Source Directory</link>: |
245 | <literallayout class='monospaced'> | 247 | <literallayout class='monospaced'> |
246 | $ source &OE_INIT_FILE; ~/mybuilds | 248 | $ source &OE_INIT_FILE; ~/mybuilds |
247 | </literallayout> | 249 | </literallayout> |
248 | The OpenEmbedded build system uses the template configuration | 250 | The OpenEmbedded build system uses the template configuration |
249 | files, which are found by default in the | 251 | files, which are found by default in the |
250 | <filename>meta-poky/conf</filename> directory in the | 252 | <filename>meta-poky/conf</filename> directory in the |
251 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 253 | Source Directory. |
252 | See the | 254 | See the |
253 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" | 255 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" |
254 | section in the Yocto Project Development Manual for more | 256 | section in the Yocto Project Development Tasks Manual for more |
255 | information. | 257 | information. |
256 | <note> | 258 | <note> |
257 | The OpenEmbedded build system does not support file or directory names that | 259 | The OpenEmbedded build system does not support file or directory names that |
@@ -365,7 +367,7 @@ | |||
365 | You can see how the <filename>TEMPLATECONF</filename> variable | 367 | You can see how the <filename>TEMPLATECONF</filename> variable |
366 | is used by looking at the | 368 | is used by looking at the |
367 | <filename>scripts/oe-setup-builddir</filename> script in the | 369 | <filename>scripts/oe-setup-builddir</filename> script in the |
368 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 370 | <link linkend='source-directory'>Source Directory</link>. |
369 | You can find the Yocto Project version of the | 371 | You can find the Yocto Project version of the |
370 | <filename>local.conf.sample</filename> file in the | 372 | <filename>local.conf.sample</filename> file in the |
371 | <filename>meta-poky/conf</filename> directory. | 373 | <filename>meta-poky/conf</filename> directory. |
@@ -415,7 +417,7 @@ | |||
415 | <note> | 417 | <note> |
416 | You can see how the <filename>TEMPLATECONF</filename> variable | 418 | You can see how the <filename>TEMPLATECONF</filename> variable |
417 | <filename>scripts/oe-setup-builddir</filename> script in the | 419 | <filename>scripts/oe-setup-builddir</filename> script in the |
418 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 420 | <link linkend='source-directory'>Source Directory</link>. |
419 | You can find the Yocto Project version of the | 421 | You can find the Yocto Project version of the |
420 | <filename>bblayers.conf.sample</filename> file in the | 422 | <filename>bblayers.conf.sample</filename> file in the |
421 | <filename>meta-poky/conf</filename> directory. | 423 | <filename>meta-poky/conf</filename> directory. |
@@ -563,7 +565,7 @@ | |||
563 | contain appropriate <filename>COPYING</filename> license files with other licensing information. | 565 | contain appropriate <filename>COPYING</filename> license files with other licensing information. |
564 | For information on licensing, see the | 566 | For information on licensing, see the |
565 | "<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>" | 567 | "<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>" |
566 | section. | 568 | section in the Yocto Project Development Tasks Manual. |
567 | </para> | 569 | </para> |
568 | </section> | 570 | </section> |
569 | 571 | ||
@@ -738,7 +740,8 @@ | |||
738 | <filename>linux-qemux86-standard-build</filename> and then patched by Quilt. | 740 | <filename>linux-qemux86-standard-build</filename> and then patched by Quilt. |
739 | (See the | 741 | (See the |
740 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Using Quilt in Your Workflow</ulink>" | 742 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Using Quilt in Your Workflow</ulink>" |
741 | section in the Yocto Project Development Manual for more information.) | 743 | section in the Yocto Project Development Tasks Manual for more |
744 | information.) | ||
742 | Within the <filename>linux-qemux86-standard-build</filename> directory, | 745 | Within the <filename>linux-qemux86-standard-build</filename> directory, |
743 | standard Quilt directories <filename>linux-3.0/patches</filename> | 746 | standard Quilt directories <filename>linux-3.0/patches</filename> |
744 | and <filename>linux-3.0/.pc</filename> are created, | 747 | and <filename>linux-3.0/.pc</filename> are created, |
@@ -872,7 +875,7 @@ | |||
872 | 875 | ||
873 | <para> | 876 | <para> |
874 | As mentioned previously, | 877 | As mentioned previously, |
875 | <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink> is the core | 878 | <link linkend='metadata'>Metadata</link> is the core |
876 | of the Yocto Project. | 879 | of the Yocto Project. |
877 | Metadata has several important subdivisions: | 880 | Metadata has several important subdivisions: |
878 | </para> | 881 | </para> |