diff options
Diffstat (limited to 'documentation/poky-ref-manual/ref-structure.xml')
-rw-r--r-- | documentation/poky-ref-manual/ref-structure.xml | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index ece4894528..be2773b624 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml | |||
@@ -7,14 +7,14 @@ | |||
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 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> consists of several components. |
11 | Understanding them and knowing where they are located is key to using the Yocto Project well. | 11 | Understanding them and knowing where they are located is key to using the Yocto Project well. |
12 | This chapter describes the source directory and gives information about the various | 12 | This chapter describes the Source Directory and gives information about the various |
13 | files and directories. | 13 | files and directories. |
14 | </para> | 14 | </para> |
15 | 15 | ||
16 | <para> | 16 | <para> |
17 | For information on how to establish a local source directory on your development system, see the | 17 | For information on how to establish a local Source Directory on your development system, see the |
18 | "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>" | 18 | "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>" |
19 | section in the Yocto Project Development Manual. | 19 | section in the Yocto Project Development Manual. |
20 | </para> | 20 | </para> |
@@ -26,7 +26,7 @@ | |||
26 | <title><filename>bitbake/</filename></title> | 26 | <title><filename>bitbake/</filename></title> |
27 | 27 | ||
28 | <para> | 28 | <para> |
29 | The <ulink url='source-directory'>source directory</ulink> | 29 | The <ulink url='source-directory'>Source Directory</ulink> |
30 | includes a copy of BitBake for ease of use. | 30 | includes a copy of BitBake for ease of use. |
31 | The copy usually matches the current stable BitBake release from the BitBake project. | 31 | The copy usually matches the current stable BitBake release from the BitBake project. |
32 | BitBake, a metadata interpreter, reads the Yocto Project metadata and runs the tasks | 32 | BitBake, a metadata interpreter, reads the Yocto Project metadata and runs the tasks |
@@ -39,7 +39,7 @@ | |||
39 | When you run the <filename>bitbake</filename> command, the wrapper script in | 39 | When you run the <filename>bitbake</filename> command, the wrapper script in |
40 | <filename>scripts/</filename> is executed to run the main BitBake executable, | 40 | <filename>scripts/</filename> is executed to run the main BitBake executable, |
41 | which resides in the <filename>bitbake/bin/</filename> directory. | 41 | which resides in the <filename>bitbake/bin/</filename> directory. |
42 | Sourcing the <link linkend="structure-core-script">oe-init-build-env</link> | 42 | Sourcing the <link linkend="structure-core-script">&OE_INIT_FILE;</link> |
43 | script places the <filename>scripts</filename> and <filename>bitbake/bin</filename> | 43 | script places the <filename>scripts</filename> and <filename>bitbake/bin</filename> |
44 | directories (in that order) into the shell's <filename>PATH</filename> environment | 44 | directories (in that order) into the shell's <filename>PATH</filename> environment |
45 | variable. | 45 | variable. |
@@ -59,19 +59,19 @@ | |||
59 | This directory contains user configuration files and the output | 59 | This directory contains user configuration files and the output |
60 | generated by the OpenEmbedded build system in its standard configuration where | 60 | generated by the OpenEmbedded build system in its standard configuration where |
61 | the source tree is combined with the output. | 61 | the source tree is combined with the output. |
62 | The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> | 62 | The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
63 | is created initially when you <filename>source</filename> | 63 | is created initially when you <filename>source</filename> |
64 | the OpenEmbedded build environment setup script <filename>oe-init-build-env</filename>. | 64 | the OpenEmbedded build environment setup script <filename>&OE_INIT_FILE;</filename>. |
65 | </para> | 65 | </para> |
66 | 66 | ||
67 | <para> | 67 | <para> |
68 | It is also possible to place output and configuration | 68 | It is also possible to place output and configuration |
69 | files in a directory separate from the | 69 | files in a directory separate from the |
70 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> | 70 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> |
71 | by providing a directory name when you <filename>source</filename> | 71 | by providing a directory name when you <filename>source</filename> |
72 | the setup script. | 72 | the setup script. |
73 | For information on separating output from your local source directory files, see <link | 73 | For information on separating output from your local Source Directory files, see <link |
74 | linkend='structure-core-script'>oe-init-build-env</link>. | 74 | linkend='structure-core-script'>&OE_INIT_FILE;</link>. |
75 | </para> | 75 | </para> |
76 | </section> | 76 | </section> |
77 | 77 | ||
@@ -141,7 +141,7 @@ | |||
141 | <para> | 141 | <para> |
142 | This directory contains various integration scripts that implement | 142 | This directory contains various integration scripts that implement |
143 | extra functionality in the Yocto Project environment (e.g. QEMU scripts). | 143 | extra functionality in the Yocto Project environment (e.g. QEMU scripts). |
144 | The <link linkend="structure-core-script">oe-init-build-env</link> script appends this | 144 | The <link linkend="structure-core-script">&OE_INIT_FILE;</link> script appends this |
145 | directory to the shell's <filename>PATH</filename> environment variable. | 145 | directory to the shell's <filename>PATH</filename> environment variable. |
146 | </para> | 146 | </para> |
147 | 147 | ||
@@ -153,7 +153,7 @@ | |||
153 | </section> | 153 | </section> |
154 | 154 | ||
155 | <section id='structure-core-script'> | 155 | <section id='structure-core-script'> |
156 | <title><filename>oe-init-build-env</filename></title> | 156 | <title><filename>&OE_INIT_FILE;</filename></title> |
157 | 157 | ||
158 | <para> | 158 | <para> |
159 | This script sets up the OpenEmbedded build environment. | 159 | This script sets up the OpenEmbedded build environment. |
@@ -166,16 +166,16 @@ | |||
166 | </para> | 166 | </para> |
167 | 167 | ||
168 | <para> | 168 | <para> |
169 | By default, running this script without a build directory argument creates the | 169 | By default, running this script without a Build Directory argument creates the |
170 | <filename>build</filename> directory. | 170 | <filename>build</filename> directory. |
171 | If you provide a build directory argument when you <filename>source</filename> | 171 | If you provide a Build Directory argument when you <filename>source</filename> |
172 | the script, you direct OpenEmbedded build system to create a | 172 | the script, you direct OpenEmbedded build system to create a |
173 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> of your choice. | 173 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> of your choice. |
174 | For example, the following command creates a build directory named | 174 | For example, the following command creates a Build Directory named |
175 | <filename>mybuilds</filename> that is outside of the | 175 | <filename>mybuilds</filename> that is outside of the |
176 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>: | 176 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: |
177 | <literallayout class='monospaced'> | 177 | <literallayout class='monospaced'> |
178 | $ source oe-init-build-env ~/mybuilds | 178 | $ source &OE_INIT_FILE; ~/mybuilds |
179 | </literallayout> | 179 | </literallayout> |
180 | </para> | 180 | </para> |
181 | </section> | 181 | </section> |
@@ -387,7 +387,7 @@ | |||
387 | data. | 387 | data. |
388 | Packages that need to share output with other packages do so within this directory. | 388 | Packages that need to share output with other packages do so within this directory. |
389 | The directory is subdivided by architecture so multiple builds can run within | 389 | The directory is subdivided by architecture so multiple builds can run within |
390 | the one build directory. | 390 | the one Build Directory. |
391 | </para> | 391 | </para> |
392 | </section> | 392 | </section> |
393 | 393 | ||