diff options
-rw-r--r-- | documentation/adt-manual/adt-prepare.xml | 12 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 2 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 4 | ||||
-rw-r--r-- | documentation/mega-manual/figures/user-configuration.png | bin | 23190 -> 23687 bytes | |||
-rw-r--r-- | documentation/ref-manual/closer-look.xml | 13 | ||||
-rw-r--r-- | documentation/ref-manual/faq.xml | 6 | ||||
-rw-r--r-- | documentation/ref-manual/figures/user-configuration.png | bin | 23190 -> 23687 bytes | |||
-rw-r--r-- | documentation/ref-manual/ref-structure.xml | 107 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 33 | ||||
-rw-r--r-- | documentation/ref-manual/usingpoky.xml | 9 | ||||
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 7 |
11 files changed, 168 insertions, 25 deletions
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml index 6900b0cd8c..38963cc099 100644 --- a/documentation/adt-manual/adt-prepare.xml +++ b/documentation/adt-manual/adt-prepare.xml | |||
@@ -91,7 +91,9 @@ | |||
91 | <para> | 91 | <para> |
92 | If you use BitBake to generate the ADT Installer tarball, you must | 92 | If you use BitBake to generate the ADT Installer tarball, you must |
93 | <filename>source</filename> the environment setup script | 93 | <filename>source</filename> the environment setup script |
94 | (<ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>) | 94 | (<ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> |
95 | or | ||
96 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>) | ||
95 | located in the Source Directory before running the | 97 | located in the Source Directory before running the |
96 | BitBake command that creates the tarball. | 98 | BitBake command that creates the tarball. |
97 | </para> | 99 | </para> |
@@ -549,8 +551,12 @@ | |||
549 | 551 | ||
550 | <para> | 552 | <para> |
551 | Remember, before using any <filename>bitbake</filename> command, you | 553 | Remember, before using any <filename>bitbake</filename> command, you |
552 | must source the <filename>&OE_INIT_PATH;</filename> script located in | 554 | must source the build environment setup script |
553 | the Source Directory and you must make sure your | 555 | (i.e. |
556 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> | ||
557 | or | ||
558 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>) | ||
559 | located in the Source Directory and you must make sure your | ||
554 | <filename>conf/local.conf</filename> variables are correct. | 560 | <filename>conf/local.conf</filename> variables are correct. |
555 | In particular, you need to be sure the | 561 | In particular, you need to be sure the |
556 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> | 562 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> |
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 7fa9149d07..ccaf983cfc 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -1812,6 +1812,8 @@ | |||
1812 | environment, you must build the tool using BitBake. | 1812 | environment, you must build the tool using BitBake. |
1813 | Thus, the environment must be set up using the | 1813 | Thus, the environment must be set up using the |
1814 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> | 1814 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> |
1815 | or | ||
1816 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink> | ||
1815 | script found in the | 1817 | script found in the |
1816 | <link linkend='build-directory'>Build Directory</link>. | 1818 | <link linkend='build-directory'>Build Directory</link>. |
1817 | The following commands build and invoke <filename>menuconfig</filename> assuming the | 1819 | The following commands build and invoke <filename>menuconfig</filename> assuming the |
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 3a70398984..85fa3e98ff 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -509,7 +509,9 @@ | |||
509 | This term refers to the area used by the OpenEmbedded build system for builds. | 509 | This term refers to the area used by the OpenEmbedded build system for builds. |
510 | The area is created when you <filename>source</filename> the setup | 510 | The area is created when you <filename>source</filename> the setup |
511 | environment script that is found in the Source Directory | 511 | environment script that is found in the Source Directory |
512 | (i.e. <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>). | 512 | (i.e. <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> |
513 | or | ||
514 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>). | ||
513 | The <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink> | 515 | The <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink> |
514 | variable points to the Build Directory.</para> | 516 | variable points to the Build Directory.</para> |
515 | 517 | ||
diff --git a/documentation/mega-manual/figures/user-configuration.png b/documentation/mega-manual/figures/user-configuration.png index 5bdff034de..f2b3f8e7fe 100644 --- a/documentation/mega-manual/figures/user-configuration.png +++ b/documentation/mega-manual/figures/user-configuration.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index 8c3ceb7210..7e8d528897 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml | |||
@@ -106,7 +106,11 @@ | |||
106 | configuration files. | 106 | configuration files. |
107 | These example files are used as a basis for creating actual | 107 | These example files are used as a basis for creating actual |
108 | configuration files when you source the build environment | 108 | configuration files when you source the build environment |
109 | script <filename>oe-init-build-env</filename>. | 109 | script |
110 | (i.e. | ||
111 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> | ||
112 | or | ||
113 | <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). | ||
110 | </para> | 114 | </para> |
111 | 115 | ||
112 | <para> | 116 | <para> |
@@ -119,14 +123,15 @@ | |||
119 | and <filename>bblayers.conf</filename> configuration files. | 123 | and <filename>bblayers.conf</filename> configuration files. |
120 | These default configuration files are created only if versions | 124 | These default configuration files are created only if versions |
121 | do not already exist in the Build Directory at the time you | 125 | do not already exist in the Build Directory at the time you |
122 | source the <filename>oe-init-build-env</filename> script. | 126 | source the build environment setup script. |
123 | </para> | 127 | </para> |
124 | 128 | ||
125 | <para> | 129 | <para> |
126 | Because the Poky repository is fundamentally an aggregation of | 130 | Because the Poky repository is fundamentally an aggregation of |
127 | existing repositories, some users might be familiar with running | 131 | existing repositories, some users might be familiar with running |
128 | the <filename>oe-init-build-env</filename> script in the context of | 132 | the <filename>&OE_INIT_FILE;</filename> or |
129 | separate OpenEmbedded-Core and BitBake repositories rather than a | 133 | <filename>oe-init-build-env-memres</filename> script in the context |
134 | of separate OpenEmbedded-Core and BitBake repositories rather than a | ||
130 | single Poky repository. | 135 | single Poky repository. |
131 | This discussion assumes the script is executed from within a cloned | 136 | This discussion assumes the script is executed from within a cloned |
132 | or unpacked version of Poky. | 137 | or unpacked version of Poky. |
diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml index 71fb03aedb..69b679bbf7 100644 --- a/documentation/ref-manual/faq.xml +++ b/documentation/ref-manual/faq.xml | |||
@@ -682,9 +682,11 @@ | |||
682 | <para> | 682 | <para> |
683 | Yes - you can easily do this. | 683 | Yes - you can easily do this. |
684 | When you use BitBake to build an image, all the build output | 684 | When you use BitBake to build an image, all the build output |
685 | goes into the directory created when you source the | 685 | goes into the directory created when you run the |
686 | build environment setup script (i.e. | ||
686 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> | 687 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> |
687 | setup script. | 688 | or |
689 | <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). | ||
688 | By default, this <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 690 | By default, this <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
689 | is named <filename>build</filename> but can be named | 691 | is named <filename>build</filename> but can be named |
690 | anything you want. | 692 | anything you want. |
diff --git a/documentation/ref-manual/figures/user-configuration.png b/documentation/ref-manual/figures/user-configuration.png index 5bdff034de..f2b3f8e7fe 100644 --- a/documentation/ref-manual/figures/user-configuration.png +++ b/documentation/ref-manual/figures/user-configuration.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 6ddecd994d..3133e8dc6d 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml | |||
@@ -74,7 +74,11 @@ | |||
74 | the source tree is combined with the output. | 74 | the source tree is combined with the output. |
75 | The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 75 | The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
76 | is created initially when you <filename>source</filename> | 76 | is created initially when you <filename>source</filename> |
77 | the OpenEmbedded build environment setup script <filename>&OE_INIT_FILE;</filename>. | 77 | the OpenEmbedded build environment setup script |
78 | (i.e. | ||
79 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> | ||
80 | or | ||
81 | <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). | ||
78 | </para> | 82 | </para> |
79 | 83 | ||
80 | <para> | 84 | <para> |
@@ -85,8 +89,10 @@ | |||
85 | the setup script. | 89 | the setup script. |
86 | For information on separating output from your local | 90 | For information on separating output from your local |
87 | Source Directory files, see the | 91 | Source Directory files, see the |
88 | "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>" | 92 | "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> |
89 | section. | 93 | and |
94 | "<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>" | ||
95 | sections. | ||
90 | </para> | 96 | </para> |
91 | </section> | 97 | </section> |
92 | 98 | ||
@@ -143,7 +149,7 @@ | |||
143 | which is a Yocto Project build user interface. | 149 | which is a Yocto Project build user interface. |
144 | For more information on the Hob, see the | 150 | For more information on the Hob, see the |
145 | <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob Project</ulink> | 151 | <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob Project</ulink> |
146 | webpage. | 152 | web page. |
147 | </para> | 153 | </para> |
148 | </section> | 154 | </section> |
149 | 155 | ||
@@ -162,7 +168,9 @@ | |||
162 | This directory contains various integration scripts that implement | 168 | This directory contains various integration scripts that implement |
163 | extra functionality in the Yocto Project environment (e.g. QEMU scripts). | 169 | extra functionality in the Yocto Project environment (e.g. QEMU scripts). |
164 | The <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link> | 170 | The <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link> |
165 | script appends this directory to the shell's | 171 | and |
172 | <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> | ||
173 | scripts append this directory to the shell's | ||
166 | <filename>PATH</filename> environment variable. | 174 | <filename>PATH</filename> environment variable. |
167 | </para> | 175 | </para> |
168 | 176 | ||
@@ -177,11 +185,19 @@ | |||
177 | <title><filename>&OE_INIT_FILE;</filename></title> | 185 | <title><filename>&OE_INIT_FILE;</filename></title> |
178 | 186 | ||
179 | <para> | 187 | <para> |
180 | This script sets up the OpenEmbedded build environment. | 188 | This script is one of two scripts that set up the OpenEmbedded build |
189 | environment. | ||
190 | For information on the other script, see the | ||
191 | "<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>" | ||
192 | section. | ||
193 | </para> | ||
194 | |||
195 | <para> | ||
181 | Running this script with the <filename>source</filename> command in | 196 | Running this script with the <filename>source</filename> command in |
182 | a shell makes changes to <filename>PATH</filename> and sets other | 197 | a shell makes changes to <filename>PATH</filename> and sets other |
183 | core BitBake variables based on the current working directory. | 198 | core BitBake variables based on the current working directory. |
184 | You need to run this script before running BitBake commands. | 199 | You need to run an environment setup script before running BitBake |
200 | commands. | ||
185 | The script uses other scripts within the | 201 | The script uses other scripts within the |
186 | <filename>scripts</filename> directory to do the bulk of the work. | 202 | <filename>scripts</filename> directory to do the bulk of the work. |
187 | </para> | 203 | </para> |
@@ -191,7 +207,7 @@ | |||
191 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 207 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
192 | argument creates the <filename>build</filename> directory. | 208 | argument creates the <filename>build</filename> directory. |
193 | If you provide a Build Directory argument when you | 209 | If you provide a Build Directory argument when you |
194 | <filename>source</filename> the script, you direct OpenEmbedded | 210 | <filename>source</filename> the script, you direct the OpenEmbedded |
195 | build system to create a Build Directory of your choice. | 211 | build system to create a Build Directory of your choice. |
196 | For example, the following command creates a Build Directory named | 212 | For example, the following command creates a Build Directory named |
197 | <filename>mybuilds</filename> that is outside of the | 213 | <filename>mybuilds</filename> that is outside of the |
@@ -211,6 +227,81 @@ | |||
211 | </para> | 227 | </para> |
212 | </section> | 228 | </section> |
213 | 229 | ||
230 | <section id='structure-memres-core-script'> | ||
231 | <title><filename>oe-init-build-env-memres</filename></title> | ||
232 | |||
233 | <para> | ||
234 | This script is one of two scripts that set up the OpenEmbedded build | ||
235 | environment. | ||
236 | Setting up the environment with this script uses a | ||
237 | memory-resident BitBake. | ||
238 | For information on the other setup script, see the | ||
239 | "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>" | ||
240 | section. | ||
241 | </para> | ||
242 | |||
243 | <para> | ||
244 | Memory-resident BitBake resides in memory until you specifically | ||
245 | remove it using the following BitBake command: | ||
246 | <literallayout class='monospaced'> | ||
247 | $ bitbake -m | ||
248 | </literallayout> | ||
249 | </para> | ||
250 | |||
251 | <para> | ||
252 | Running this script with the <filename>source</filename> command in | ||
253 | a shell makes changes to <filename>PATH</filename> and sets other | ||
254 | core BitBake variables based on the current working directory. | ||
255 | One of these variables is the | ||
256 | <link linkend='var-BBSERVER'><filename>BBSERVER</filename></link> | ||
257 | variable, which allows the OpenEmbedded build system to locate | ||
258 | the server that is running BitBake. | ||
259 | </para> | ||
260 | |||
261 | <para> | ||
262 | You need to run an environment setup script before running BitBake | ||
263 | commands. | ||
264 | Following is the script syntax: | ||
265 | <literallayout class='monospaced'> | ||
266 | $ source oe-init-build-env-memres <port_number> <build_dir> | ||
267 | </literallayout> | ||
268 | The script uses other scripts within the | ||
269 | <filename>scripts</filename> directory to do the bulk of the work. | ||
270 | </para> | ||
271 | |||
272 | <para> | ||
273 | If you do not provide a port number with the script, the default | ||
274 | port "12345" is used. | ||
275 | </para> | ||
276 | |||
277 | <para> | ||
278 | By default, running this script without a | ||
279 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | ||
280 | argument creates the <filename>build</filename> directory. | ||
281 | If you provide a Build Directory argument when you | ||
282 | <filename>source</filename> the script, you direct the OpenEmbedded | ||
283 | build system to create a Build Directory of your choice. | ||
284 | For example, the following command uses the default port number | ||
285 | "12345" and creates a Build Directory named | ||
286 | <filename>mybuilds</filename> that is outside of the | ||
287 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: | ||
288 | <literallayout class='monospaced'> | ||
289 | $ source oe-init-build-env-memres ~/mybuilds | ||
290 | </literallayout> | ||
291 | <note> | ||
292 | The OpenEmbedded build system does not support file or | ||
293 | directory names that contain spaces. | ||
294 | If you attempt to run the | ||
295 | <filename>oe-init-build-env-memres</filename> script | ||
296 | from a Source Directory that contains spaces in either the | ||
297 | filenames or directory names, the script returns an error | ||
298 | indicating no such file or directory. | ||
299 | Be sure to use a Source Directory free of names containing | ||
300 | spaces. | ||
301 | </note> | ||
302 | </para> | ||
303 | </section> | ||
304 | |||
214 | <section id='structure-basic-top-level'> | 305 | <section id='structure-basic-top-level'> |
215 | <title><filename>LICENSE, README, and README.hardware</filename></title> | 306 | <title><filename>LICENSE, README, and README.hardware</filename></title> |
216 | 307 | ||
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 2414d3b036..cb1a2913fc 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -710,6 +710,28 @@ Core layer for images cannot be removed | |||
710 | </glossdef> | 710 | </glossdef> |
711 | </glossentry> | 711 | </glossentry> |
712 | 712 | ||
713 | <glossentry id='var-BBSERVER'><glossterm>BBSERVER</glossterm> | ||
714 | <glossdef> | ||
715 | <para> | ||
716 | Points to the server that runs memory-resident BitBake. | ||
717 | This variable is set by the | ||
718 | <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> | ||
719 | setup script and should not be hand-edited. | ||
720 | The variable is only used when you employ memory-resident | ||
721 | BitBake. | ||
722 | The setup script exports the value as follows: | ||
723 | <literallayout class='monospaced'> | ||
724 | export BBSERVER=localhost:$port | ||
725 | </literallayout> | ||
726 | For more information on how the | ||
727 | <filename>BBSERVER</filename> is used, see the | ||
728 | <filename>oe-init-build-env-memres</filename> script, which | ||
729 | is located in the | ||
730 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | ||
731 | </para> | ||
732 | </glossdef> | ||
733 | </glossentry> | ||
734 | |||
713 | <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm> | 735 | <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm> |
714 | <glossdef> | 736 | <glossdef> |
715 | <para> | 737 | <para> |
@@ -762,13 +784,16 @@ Core layer for images cannot be removed | |||
762 | 784 | ||
763 | <glossentry id='var-BUILDDIR'><glossterm>BUILDDIR</glossterm> | 785 | <glossentry id='var-BUILDDIR'><glossterm>BUILDDIR</glossterm> |
764 | <glossdef> | 786 | <glossdef> |
765 | <para>Points to the location of the | 787 | <para> |
788 | Points to the location of the | ||
766 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 789 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
767 | You can define this directory indirectly through the | 790 | You can define this directory indirectly through the |
768 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> | 791 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> |
769 | script by passing in a Build Directory path when you run the | 792 | and |
770 | script. | 793 | <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> |
771 | If you run the script and do not provide a Build Directory | 794 | scripts by passing in a Build Directory path when you run |
795 | the scripts. | ||
796 | If you run the scripts and do not provide a Build Directory | ||
772 | path, the <filename>BUILDDIR</filename> defaults to | 797 | path, the <filename>BUILDDIR</filename> defaults to |
773 | <filename>build</filename> in the current directory. | 798 | <filename>build</filename> in the current directory. |
774 | </para> | 799 | </para> |
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 76291f4cd3..40413766a2 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml | |||
@@ -27,8 +27,13 @@ | |||
27 | <title>Build Overview</title> | 27 | <title>Build Overview</title> |
28 | 28 | ||
29 | <para> | 29 | <para> |
30 | The first thing you need to do is set up the OpenEmbedded build environment by sourcing | 30 | The first thing you need to do is set up the OpenEmbedded build |
31 | the <link linkend='structure-core-script'>environment setup script</link> as follows: | 31 | environment by sourcing an environment setup script |
32 | (i.e. | ||
33 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> | ||
34 | or | ||
35 | <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). | ||
36 | Here is an example: | ||
32 | <literallayout class='monospaced'> | 37 | <literallayout class='monospaced'> |
33 | $ source &OE_INIT_FILE; [<build_dir>] | 38 | $ source &OE_INIT_FILE; [<build_dir>] |
34 | </literallayout> | 39 | </literallayout> |
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index a7532c082c..2ae217416b 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
@@ -464,7 +464,12 @@ | |||
464 | to the Build Directory. | 464 | to the Build Directory. |
465 | Later, when the build completes, the Build Directory contains all the files | 465 | Later, when the build completes, the Build Directory contains all the files |
466 | created during the build. | 466 | created during the build. |
467 | </para></listitem> | 467 | <note> |
468 | For information on running a memory-resident BitBake, see | ||
469 | the | ||
470 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink> | ||
471 | setup script. | ||
472 | </note></para></listitem> | ||
468 | </itemizedlist> | 473 | </itemizedlist> |
469 | <para> | 474 | <para> |
470 | Take some time to examine your <filename>local.conf</filename> file | 475 | Take some time to examine your <filename>local.conf</filename> file |