summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-09-21 09:36:46 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-09-22 17:53:44 +0100
commitb103ff6ba7a91d5bc83816f300b95361de8e700f (patch)
tree20047d3acda9800311b3a22e2ddf0adeb7ef008a /documentation
parent2efe56a06f6c116325f5c5d3dfcc3165db290f1b (diff)
downloadpoky-b103ff6ba7a91d5bc83816f300b95361de8e700f.tar.gz
documentation: Purged "oe-init-build-env-memres" from docs
Fixes [YOCTO #11968] Purged all occurrences of the "oe-init-build-env-memres" script from the YP documentation set. Occurrences in a lot of places. The BBSERVER variable was also impacted and had to have the definition updated. (From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/bsp-guide/bsp.xml18
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml30
-rw-r--r--documentation/dev-manual/dev-manual-qemu.xml4
-rw-r--r--documentation/dev-manual/dev-manual-start.xml6
-rw-r--r--documentation/kernel-dev/kernel-dev-common.xml4
-rw-r--r--documentation/ref-manual/faq.xml4
-rw-r--r--documentation/ref-manual/introduction.xml8
-rw-r--r--documentation/ref-manual/ref-development-environment.xml7
-rw-r--r--documentation/ref-manual/ref-structure.xml194
-rw-r--r--documentation/ref-manual/ref-variables.xml56
-rw-r--r--documentation/ref-manual/usingpoky.xml6
-rw-r--r--documentation/sdk-manual/sdk-appendix-customizing.xml4
-rw-r--r--documentation/sdk-manual/sdk-appendix-obtain.xml7
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml7
14 files changed, 61 insertions, 294 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index b4e1e3e9f2..5db2837963 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -99,11 +99,9 @@
99 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> 99 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink>
100 variable in the <filename>conf/bblayers.conf</filename> file found in the 100 variable in the <filename>conf/bblayers.conf</filename> file found in the
101 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, 101 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
102 which is established after you run one of the OpenEmbedded build environment 102 which is established after you run the OpenEmbedded build environment
103 setup scripts (i.e. 103 setup script (i.e.
104 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 104 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>).
105 and
106 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>).
107 Adding the root allows the OpenEmbedded build system to recognize the BSP 105 Adding the root allows the OpenEmbedded build system to recognize the BSP
108 definition and from it build an image. 106 definition and from it build an image.
109 Here is an example: 107 Here is an example:
@@ -282,13 +280,6 @@
282 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. 280 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
283 After the script runs, your current working directory 281 After the script runs, your current working directory
284 is set to the <filename>build</filename> directory. 282 is set to the <filename>build</filename> directory.
285 <note>
286 For information on running a memory-resident
287 <ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>,
288 see the
289 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
290 setup script.
291 </note>
292 </para></listitem> 283 </para></listitem>
293 </orderedlist> 284 </orderedlist>
294 </para> 285 </para>
@@ -1018,8 +1009,7 @@
1018 your image. 1009 your image.
1019 You need to get the build environment ready by 1010 You need to get the build environment ready by
1020 sourcing an environment setup script 1011 sourcing an environment setup script
1021 (i.e. <filename>oe-init-build-env</filename> or 1012 (i.e. <filename>oe-init-build-env</filename>)
1022 <filename>oe-init-build-env-memres</filename>)
1023 and you need to be sure two key configuration 1013 and you need to be sure two key configuration
1024 files are configured appropriately: the 1014 files are configured appropriately: the
1025 <filename>conf/local.conf</filename> and the 1015 <filename>conf/local.conf</filename> and the
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 64af8d700a..0c2e60f006 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1535,9 +1535,7 @@
1535 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> 1535 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
1536 and have sourced the build environment setup script 1536 and have sourced the build environment setup script
1537 (i.e. 1537 (i.e.
1538 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>oe-init-build-env</filename></ulink> 1538 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>oe-init-build-env</filename></ulink>).
1539 or
1540 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>).
1541 Here is the basic <filename>recipetool</filename> syntax: 1539 Here is the basic <filename>recipetool</filename> syntax:
1542 <note> 1540 <note>
1543 Running <filename>recipetool -h</filename> or 1541 Running <filename>recipetool -h</filename> or
@@ -1718,10 +1716,8 @@
1718 </para> 1716 </para>
1719 1717
1720 <para> 1718 <para>
1721 Assuming you have sourced a build environment setup script (i.e. 1719 Assuming you have sourced the build environment setup script (i.e.
1722 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 1720 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>)
1723 or
1724 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>)
1725 and you are in the 1721 and you are in the
1726 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, 1722 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
1727 use BitBake to process your recipe. 1723 use BitBake to process your recipe.
@@ -4959,11 +4955,9 @@
4959 </literallayout> 4955 </literallayout>
4960 </para></listitem> 4956 </para></listitem>
4961 <listitem><para> 4957 <listitem><para>
4962 You must have sourced one of the build environment 4958 You must have sourced the build environment
4963 setup scripts (i.e. 4959 setup script (i.e.
4964 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 4960 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>)
4965 or
4966 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>)
4967 found in the 4961 found in the
4968 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. 4962 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
4969 </para></listitem> 4963 </para></listitem>
@@ -5052,8 +5046,6 @@
5052 artifacts ready and available. 5046 artifacts ready and available.
5053 Additionally, the environment must be set up using the 5047 Additionally, the environment must be set up using the
5054 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 5048 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
5055 or
5056 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
5057 script found in the 5049 script found in the
5058 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. 5050 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
5059 </para> 5051 </para>
@@ -6195,8 +6187,6 @@ Some notes from Cal:
6195 environment, you must launch it using BitBake. 6187 environment, you must launch it using BitBake.
6196 Thus, the environment must be set up using the 6188 Thus, the environment must be set up using the
6197 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 6189 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
6198 or
6199 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
6200 script found in the 6190 script found in the
6201 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. 6191 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
6202 You must also be sure of the state of your build in the 6192 You must also be sure of the state of your build in the
@@ -7062,12 +7052,10 @@ Some notes from Cal:
7062 Aside from the <filename>*.sample</filename> configuration files, 7052 Aside from the <filename>*.sample</filename> configuration files,
7063 the <filename>conf-notes.txt</filename> also resides in the 7053 the <filename>conf-notes.txt</filename> also resides in the
7064 default <filename>meta-poky/conf</filename> directory. 7054 default <filename>meta-poky/conf</filename> directory.
7065 The scripts that set up the build environment 7055 The script that sets up the build environment
7066 (i.e. 7056 (i.e.
7067 <ulink url="&YOCTO_DOCS_REF_URL;#structure-core-script"><filename>&OE_INIT_FILE;</filename></ulink> 7057 <ulink url="&YOCTO_DOCS_REF_URL;#structure-core-script"><filename>&OE_INIT_FILE;</filename></ulink>)
7068 and 7058 uses this file to display BitBake targets as part of the script
7069 <ulink url="&YOCTO_DOCS_REF_URL;#structure-memres-core-script"><filename>oe-init-build-env-memres</filename></ulink>)
7070 use this file to display BitBake targets as part of the script
7071 output. 7059 output.
7072 Customizing this <filename>conf-notes.txt</filename> file is a 7060 Customizing this <filename>conf-notes.txt</filename> file is a
7073 good way to make sure your list of custom targets appears 7061 good way to make sure your list of custom targets appears
diff --git a/documentation/dev-manual/dev-manual-qemu.xml b/documentation/dev-manual/dev-manual-qemu.xml
index ed4040ca60..d127c4f510 100644
--- a/documentation/dev-manual/dev-manual-qemu.xml
+++ b/documentation/dev-manual/dev-manual-qemu.xml
@@ -43,9 +43,7 @@
43 repository or you downloaded and unpacked a 43 repository or you downloaded and unpacked a
44 Yocto Project release tarball, you can source 44 Yocto Project release tarball, you can source
45 the build environment script (i.e. 45 the build environment script (i.e.
46 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 46 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>):
47 or
48 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>):
49 <literallayout class='monospaced'> 47 <literallayout class='monospaced'>
50 $ cd ~/poky 48 $ cd ~/poky
51 $ source oe-init-build-env 49 $ source oe-init-build-env
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index bcb49fbf03..a62825122f 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -707,11 +707,9 @@
707 </para></listitem> 707 </para></listitem>
708 <listitem><para> 708 <listitem><para>
709 <emphasis>Initialize the Build Environment:</emphasis> 709 <emphasis>Initialize the Build Environment:</emphasis>
710 Initialize the build environment by sourcing a build 710 Initialize the build environment by sourcing the build
711 environment script (i.e. 711 environment script (i.e.
712 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 712 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>).
713 or
714 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>).
715 </para></listitem> 713 </para></listitem>
716 <listitem><para> 714 <listitem><para>
717 <emphasis>Make Sure Your <filename>local.conf</filename> 715 <emphasis>Make Sure Your <filename>local.conf</filename>
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index 9ef1138589..0f5e09cd47 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -72,9 +72,7 @@
72 Before building an extensible SDK, you need to 72 Before building an extensible SDK, you need to
73 initialize the BitBake build environment by sourcing a 73 initialize the BitBake build environment by sourcing a
74 build environment script 74 build environment script
75 (i.e. <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>oe-init-build-env</filename></ulink> 75 (i.e. <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>oe-init-build-env</filename></ulink>):
76 or
77 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>):
78 <literallayout class='monospaced'> 76 <literallayout class='monospaced'>
79 $ cd ~/poky 77 $ cd ~/poky
80 $ source oe-init-build-env 78 $ source oe-init-build-env
diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml
index 55a6a89ad7..62754a9711 100644
--- a/documentation/ref-manual/faq.xml
+++ b/documentation/ref-manual/faq.xml
@@ -699,9 +699,7 @@
699 When you use BitBake to build an image, all the build output 699 When you use BitBake to build an image, all the build output
700 goes into the directory created when you run the 700 goes into the directory created when you run the
701 build environment setup script (i.e. 701 build environment setup script (i.e.
702 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 702 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>).
703 or
704 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
705 By default, this 703 By default, this
706 <link linkend='build-directory'>Build Directory</link> 704 <link linkend='build-directory'>Build Directory</link>
707 is named <filename>build</filename> but can be named 705 is named <filename>build</filename> but can be named
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml
index 893a50fc3c..14d5c80029 100644
--- a/documentation/ref-manual/introduction.xml
+++ b/documentation/ref-manual/introduction.xml
@@ -546,9 +546,7 @@
546 On the machine that is able to run BitBake, 546 On the machine that is able to run BitBake,
547 be sure you have set up your build environment with 547 be sure you have set up your build environment with
548 the setup script 548 the setup script
549 (<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 549 (<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>).
550 or
551 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
552 </para></listitem> 550 </para></listitem>
553 <listitem><para> 551 <listitem><para>
554 Run the BitBake command to build the tarball: 552 Run the BitBake command to build the tarball:
@@ -711,9 +709,7 @@
711 system for builds. 709 system for builds.
712 The area is created when you <filename>source</filename> the 710 The area is created when you <filename>source</filename> the
713 setup environment script that is found in the Source Directory 711 setup environment script that is found in the Source Directory
714 (i.e. <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 712 (i.e. <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>).
715 or
716 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
717 The 713 The
718 <link linkend='var-TOPDIR'><filename>TOPDIR</filename></link> 714 <link linkend='var-TOPDIR'><filename>TOPDIR</filename></link>
719 variable points to the Build Directory.</para> 715 variable points to the Build Directory.</para>
diff --git a/documentation/ref-manual/ref-development-environment.xml b/documentation/ref-manual/ref-development-environment.xml
index 36de2d0a72..112e7f9ea8 100644
--- a/documentation/ref-manual/ref-development-environment.xml
+++ b/documentation/ref-manual/ref-development-environment.xml
@@ -1221,9 +1221,7 @@
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 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>).
1225 or
1226 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
1227 </para> 1225 </para>
1228 1226
1229 <para> 1227 <para>
@@ -1242,8 +1240,7 @@
1242 <para> 1240 <para>
1243 Because the Poky repository is fundamentally an aggregation of 1241 Because the Poky repository is fundamentally an aggregation of
1244 existing repositories, some users might be familiar with running 1242 existing repositories, some users might be familiar with running
1245 the <filename>&OE_INIT_FILE;</filename> or 1243 the <filename>&OE_INIT_FILE;</filename> script in the context
1246 <filename>oe-init-build-env-memres</filename> script in the context
1247 of separate OpenEmbedded-Core and BitBake repositories rather than a 1244 of separate OpenEmbedded-Core and BitBake repositories rather than a
1248 single Poky repository. 1245 single Poky repository.
1249 This discussion assumes the script is executed from within a cloned 1246 This discussion assumes the script is executed from within a cloned
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml
index 3948c64377..e1c6ee0a8b 100644
--- a/documentation/ref-manual/ref-structure.xml
+++ b/documentation/ref-manual/ref-structure.xml
@@ -54,10 +54,8 @@
54 When you run the <filename>bitbake</filename> command, the 54 When you run the <filename>bitbake</filename> command, the
55 main BitBake executable, which resides in the 55 main BitBake executable, which resides in the
56 <filename>bitbake/bin/</filename> directory, starts. 56 <filename>bitbake/bin/</filename> directory, starts.
57 Sourcing an environment setup script (e.g. 57 Sourcing the environment setup script (i.e.
58 <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link> 58 <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link>)
59 or
60 <link linkend="structure-memres-core-script"><filename>oe-init-build-env-memres</filename></link>)
61 places the <filename>scripts</filename> and 59 places the <filename>scripts</filename> and
62 <filename>bitbake/bin</filename> directories (in that order) into 60 <filename>bitbake/bin</filename> directories (in that order) into
63 the shell's <filename>PATH</filename> environment variable. 61 the shell's <filename>PATH</filename> environment variable.
@@ -81,9 +79,7 @@
81 is created initially when you <filename>source</filename> 79 is created initially when you <filename>source</filename>
82 the OpenEmbedded build environment setup script 80 the OpenEmbedded build environment setup script
83 (i.e. 81 (i.e.
84 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 82 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>).
85 or
86 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
87 </para> 83 </para>
88 84
89 <para> 85 <para>
@@ -94,10 +90,8 @@
94 the setup script. 90 the setup script.
95 For information on separating output from your local 91 For information on separating output from your local
96 Source Directory files, see the 92 Source Directory files, see the
97 "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 93 "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>"
98 and 94 section.
99 "<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>"
100 sections.
101 </para> 95 </para>
102 </section> 96 </section>
103 97
@@ -177,9 +171,7 @@
177 This directory contains various integration scripts that implement 171 This directory contains various integration scripts that implement
178 extra functionality in the Yocto Project environment (e.g. QEMU scripts). 172 extra functionality in the Yocto Project environment (e.g. QEMU scripts).
179 The <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link> 173 The <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link>
180 and 174 script appends this directory to the shell's
181 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>
182 scripts append this directory to the shell's
183 <filename>PATH</filename> environment variable. 175 <filename>PATH</filename> environment variable.
184 </para> 176 </para>
185 177
@@ -194,14 +186,7 @@
194 <title><filename>&OE_INIT_FILE;</filename></title> 186 <title><filename>&OE_INIT_FILE;</filename></title>
195 187
196 <para> 188 <para>
197 This script is one of two scripts that set up the OpenEmbedded build 189 This script sets up the OpenEmbedded build environment.
198 environment.
199 For information on the other script, see the
200 "<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>"
201 section.
202 </para>
203
204 <para>
205 Running this script with the <filename>source</filename> command in 190 Running this script with the <filename>source</filename> command in
206 a shell makes changes to <filename>PATH</filename> and sets other 191 a shell makes changes to <filename>PATH</filename> and sets other
207 core BitBake variables based on the current working directory. 192 core BitBake variables based on the current working directory.
@@ -280,157 +265,6 @@
280 </para> 265 </para>
281 </section> 266 </section>
282 267
283 <section id='structure-memres-core-script'>
284 <title><filename>oe-init-build-env-memres</filename></title>
285
286 <para>
287 This script is one of two scripts that set up the OpenEmbedded
288 build environment.
289 Aside from setting up the environment, this script starts a
290 memory-resident BitBake server.
291 For information on the other setup script, see the
292 "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>"
293 section.
294 </para>
295
296 <para>
297 Memory-resident BitBake resides in memory until you specifically
298 remove it using the following BitBake command:
299 <literallayout class='monospaced'>
300 $ bitbake -m
301 </literallayout>
302 </para>
303
304 <para>
305 Running this script with the <filename>source</filename> command in
306 a shell makes changes to <filename>PATH</filename> and sets other
307 core BitBake variables based on the current working directory.
308 One of these variables is the
309 <link linkend='var-BBSERVER'><filename>BBSERVER</filename></link>
310 variable, which allows the OpenEmbedded build system to locate
311 the server that is running BitBake.
312 </para>
313
314 <para>
315 You need to run an environment setup script before using BitBake
316 commands.
317 Following is the script syntax:
318 <literallayout class='monospaced'>
319 $ source oe-init-build-env-memres <replaceable>port_number</replaceable> <replaceable>build_dir</replaceable>
320 </literallayout>
321 Following are some considerations when sourcing this script:
322 <itemizedlist>
323 <listitem><para>
324 The script uses other scripts within the
325 <filename>scripts</filename> directory to do the bulk of
326 the work.
327 </para></listitem>
328 <listitem><para>
329 If you do not provide a port number with the script, the
330 BitBake server starts at a randomly selected port.
331 </para></listitem>
332 <listitem><para>
333 The script's parameters are positionally dependent.
334 Consequently, you cannot run the script and provide a
335 <link linkend='build-directory'>Build Directory</link>
336 name without also providing a port number.
337 In other words, the following syntax is illegal:
338 <literallayout class='monospaced'>
339 $ source oe-initbuild-env-memres <replaceable>build_dir</replaceable>
340 </literallayout>
341 <note>
342 The previous restriction might be resolved in the
343 future.
344 See
345 <ulink url='https://bugzilla.yoctoproject.org/show_bug.cgi?id=7555'>Bug 7555</ulink>
346 for more information.
347 </note>
348 </para></listitem>
349 </itemizedlist>
350 </para>
351
352 <para>
353 When you run this script, your Yocto Project environment is set
354 up, a Build Directory is created, your working directory becomes
355 the Build Directory, and you are presented with a list of common
356 BitBake targets.
357 Here is an example:
358 <literallayout class='monospaced'>
359 $ source oe-init-build-env-memres
360 No port specified, using dynamically selected port
361
362 ### Shell environment set up for builds. ###
363
364 You can now run 'bitbake &lt;target&gt;'
365
366 Common targets are:
367 core-image-minimal
368 core-image-sato
369 meta-toolchain
370 meta-ide-support
371
372 You can also run generated qemu images with a command like 'runqemu qemux86'
373 Bitbake server address: 127.0.0.1, server port: 53995
374 Bitbake server started on demand as needed, use bitbake -m to shut it down
375 </literallayout>
376 The script gets its default list of common targets from the
377 <filename>conf-notes.txt</filename> file, which is found in the
378 <filename>meta-poky</filename> directory within the
379 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
380 Should you have custom distributions, it is very easy to modify
381 this configuration file to include your targets for your
382 distribution.
383 See the
384 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>"
385 section in the Yocto Project Development Manual for more
386 information.
387 </para>
388
389 <para>
390 By default, running this script without a
391 <link linkend='build-directory'>Build Directory</link>
392 argument creates a build directory named
393 <filename>build</filename>.
394 If you provide a Build Directory argument and port number when you
395 <filename>source</filename> the script, the Build Directory is
396 created using that name.
397 For example, the following command starts the BitBake server using
398 port 53995 and creates a Build Directory named
399 <filename>mybuilds</filename> that is outside of the
400 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
401 <literallayout class='monospaced'>
402 $ source oe-init-build-env-memres 53995 ~/mybuilds
403 </literallayout>
404 The <filename>oe-init-build-env-memres</filename> script starts a
405 memory resident BitBake server.
406 This BitBake instance uses the
407 <filename>bitbake-cookerdaemon.log</filename> file, which is
408 located in the Build Directory.
409 </para>
410
411 <para>
412 The OpenEmbedded build system uses the template configuration
413 files, which are found by default in the
414 <filename>meta-poky/conf</filename> directory in the
415 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
416 See the
417 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>"
418 section in the Yocto Project Development Manual for more
419 information.
420 <note>
421 The OpenEmbedded build system does not support file or
422 directory names that contain spaces.
423 If you attempt to run the
424 <filename>oe-init-build-env-memres</filename> script
425 from a Source Directory that contains spaces in either the
426 filenames or directory names, the script returns an error
427 indicating no such file or directory.
428 Be sure to use a Source Directory free of names containing
429 spaces.
430 </note>
431 </para>
432 </section>
433
434 <section id='structure-basic-top-level'> 268 <section id='structure-basic-top-level'>
435 <title><filename>LICENSE, README, and README.hardware</filename></title> 269 <title><filename>LICENSE, README, and README.hardware</filename></title>
436 270
@@ -446,10 +280,8 @@
446 <para> 280 <para>
447 The OpenEmbedded build system creates the 281 The OpenEmbedded build system creates the
448 <link linkend='build-directory'>Build Directory</link> 282 <link linkend='build-directory'>Build Directory</link>
449 when you run one of the build environment setup scripts (i.e. 283 when you run the build environment setup scripts (i.e.
450 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 284 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>).
451 or
452 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
453 </para> 285 </para>
454 286
455 <para> 287 <para>
@@ -507,9 +339,7 @@
507 <filename>local.conf.sample</filename> when 339 <filename>local.conf.sample</filename> when
508 you <filename>source</filename> the top-level build environment 340 you <filename>source</filename> the top-level build environment
509 setup script (i.e. 341 setup script (i.e.
510 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 342 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>).
511 or
512 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
513 </para> 343 </para>
514 344
515 <para> 345 <para>
@@ -561,9 +391,7 @@
561 <filename>bblayers.conf.sample</filename> when 391 <filename>bblayers.conf.sample</filename> when
562 you <filename>source</filename> the top-level build environment 392 you <filename>source</filename> the top-level build environment
563 setup script (i.e. 393 setup script (i.e.
564 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 394 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>).
565 or
566 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
567 </para> 395 </para>
568 396
569 <para> 397 <para>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index e34cfbcffb..8b1ca83938 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1299,29 +1299,29 @@
1299 1299
1300 <glossentry id='var-BBSERVER'><glossterm>BBSERVER</glossterm> 1300 <glossentry id='var-BBSERVER'><glossterm>BBSERVER</glossterm>
1301 <info> 1301 <info>
1302 BBSERVER[doc] = "Points to the server that runs memory-resident BitBake." 1302 BBSERVER[doc] = "Points to the BitBake remote server."
1303 </info> 1303 </info>
1304 <glossdef> 1304 <glossdef>
1305 <para role="glossdeffirst"> 1305 <para role="glossdeffirst">
1306<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 1306<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
1307 Points to the server that runs memory-resident BitBake. 1307 If defined in the BitBake environment,
1308 This variable is set by the 1308 <filename>BBSERVER</filename> points to the BitBake
1309 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> 1309 remote server.
1310 setup script and should not be hand-edited. 1310 </para>
1311 The variable is only used when you employ memory-resident 1311
1312 BitBake. 1312 <para>
1313 The setup script exports the value as follows: 1313 Use the following format to export the variable to the
1314 BitBake environment:
1314 <literallayout class='monospaced'> 1315 <literallayout class='monospaced'>
1315 export BBSERVER=localhost:$port 1316 export BBSERVER=localhost:$port"
1316 </literallayout> 1317 </literallayout>
1317 </para> 1318 </para>
1318 1319
1319 <para> 1320 <para>
1320 For more information on how the 1321 By default, <filename>BBSERVER</filename> also appears in
1321 <filename>BBSERVER</filename> is used, see the 1322 <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_HASHBASE_WHITELIST'><filename>BB_HASHBASE_WHITELIST</filename></ulink>.
1322 <filename>oe-init-build-env-memres</filename> script, which 1323 Consequently, <filename>BBSERVER</filename> is excluded
1323 is located in the 1324 from checksum and dependency data.
1324 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
1325 </para> 1325 </para>
1326 </glossdef> 1326 </glossdef>
1327 </glossentry> 1327 </glossentry>
@@ -1736,11 +1736,9 @@
1736 <link linkend='build-directory'>Build Directory</link>. 1736 <link linkend='build-directory'>Build Directory</link>.
1737 You can define this directory indirectly through the 1737 You can define this directory indirectly through the
1738 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 1738 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
1739 and 1739 script by passing in a Build Directory path when you run
1740 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> 1740 the script.
1741 scripts by passing in a Build Directory path when you run 1741 If you run the script and do not provide a Build Directory
1742 the scripts.
1743 If you run the scripts and do not provide a Build Directory
1744 path, the <filename>BUILDDIR</filename> defaults to 1742 path, the <filename>BUILDDIR</filename> defaults to
1745 <filename>build</filename> in the current directory. 1743 <filename>build</filename> in the current directory.
1746 </para> 1744 </para>
@@ -6626,7 +6624,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6626 recipe in the 6624 recipe in the
6627 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> 6625 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
6628 for an example initramfs recipe. 6626 for an example initramfs recipe.
6629 To select this sample recipe as the one bulit 6627 To select this sample recipe as the one built
6630 to provide the initramfs image, 6628 to provide the initramfs image,
6631 set <filename>INITRAMFS_IMAGE</filename> to 6629 set <filename>INITRAMFS_IMAGE</filename> to
6632 "core-image-minimal-initramfs". 6630 "core-image-minimal-initramfs".
@@ -9026,19 +9024,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9026<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 9024<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
9027 The directory from which the top-level build environment 9025 The directory from which the top-level build environment
9028 setup script is sourced. 9026 setup script is sourced.
9029 The Yocto Project makes two top-level build environment 9027 The Yocto Project provides a top-level build environment
9030 setup scripts available: 9028 setup script:
9031 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 9029 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>.
9032 and 9030 When you run this script, the
9033 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>.
9034 When you run one of these scripts, the
9035 <filename>OEROOT</filename> variable resolves to the 9031 <filename>OEROOT</filename> variable resolves to the
9036 directory that contains the script. 9032 directory that contains the script.
9037 </para> 9033 </para>
9038 9034
9039 <para> 9035 <para>
9040 For additional information on how this variable is used, 9036 For additional information on how this variable is used,
9041 see the initialization scripts. 9037 see the initialization script.
9042 </para> 9038 </para>
9043 </glossdef> 9039 </glossdef>
9044 </glossentry> 9040 </glossentry>
@@ -15089,10 +15085,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
15089 The top-level 15085 The top-level
15090 <link linkend='build-directory'>Build Directory</link>. 15086 <link linkend='build-directory'>Build Directory</link>.
15091 BitBake automatically sets this variable when you 15087 BitBake automatically sets this variable when you
15092 initialize your build environment using either 15088 initialize your build environment using
15093 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 15089 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>.
15094 or
15095 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>.
15096 </para> 15090 </para>
15097 </glossdef> 15091 </glossdef>
15098 </glossentry> 15092 </glossentry>
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index c323d38318..a963268347 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -42,11 +42,9 @@
42 42
43 <para> 43 <para>
44 The first thing you need to do is set up the OpenEmbedded build 44 The first thing you need to do is set up the OpenEmbedded build
45 environment by sourcing an environment setup script 45 environment by sourcing the environment setup script
46 (i.e. 46 (i.e.
47 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> 47 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>).
48 or
49 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
50 Here is an example: 48 Here is an example:
51 <literallayout class='monospaced'> 49 <literallayout class='monospaced'>
52 $ source &OE_INIT_FILE; [<replaceable>build_dir</replaceable>] 50 $ source &OE_INIT_FILE; [<replaceable>build_dir</replaceable>]
diff --git a/documentation/sdk-manual/sdk-appendix-customizing.xml b/documentation/sdk-manual/sdk-appendix-customizing.xml
index 1317a79ea8..587526f65f 100644
--- a/documentation/sdk-manual/sdk-appendix-customizing.xml
+++ b/documentation/sdk-manual/sdk-appendix-customizing.xml
@@ -148,9 +148,7 @@
148 <listitem><para> 148 <listitem><para>
149 If your OpenEmbedded build system setup uses a different 149 If your OpenEmbedded build system setup uses a different
150 environment setup script other than 150 environment setup script other than
151 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 151 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>,
152 or
153 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>,
154 then you must set 152 then you must set
155 <ulink url='&YOCTO_DOCS_REF_URL;#var-OE_INIT_ENV_SCRIPT'><filename>OE_INIT_ENV_SCRIPT</filename></ulink> 153 <ulink url='&YOCTO_DOCS_REF_URL;#var-OE_INIT_ENV_SCRIPT'><filename>OE_INIT_ENV_SCRIPT</filename></ulink>
156 to point to the environment setup script you use. 154 to point to the environment setup script you use.
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.xml b/documentation/sdk-manual/sdk-appendix-obtain.xml
index eb57938a42..6fbd7fd1cd 100644
--- a/documentation/sdk-manual/sdk-appendix-obtain.xml
+++ b/documentation/sdk-manual/sdk-appendix-obtain.xml
@@ -142,13 +142,6 @@
142 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. 142 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
143 After the script runs, your current working directory 143 After the script runs, your current working directory
144 is set to the <filename>build</filename> directory. 144 is set to the <filename>build</filename> directory.
145 <note>
146 For information on running a memory-resident
147 <ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>,
148 see the
149 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
150 setup script.
151 </note>
152 </para></listitem> 145 </para></listitem>
153 <listitem><para> 146 <listitem><para>
154 <emphasis>Make Sure You Are Building an Installer for the Correct Machine:</emphasis> 147 <emphasis>Make Sure You Are Building an Installer for the Correct Machine:</emphasis>
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index a2c183341a..151e8f07d0 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -602,13 +602,6 @@
602 is set to the Build Directory. 602 is set to the Build Directory.
603 Later, when the build completes, the Build Directory 603 Later, when the build completes, the Build Directory
604 contains all the files created during the build. 604 contains all the files created during the build.
605 <note>
606 For information on running a memory-resident
607 <ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>,
608 see the
609 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
610 setup script.
611 </note>
612 </para></listitem> 605 </para></listitem>
613 <listitem><para> 606 <listitem><para>
614 <emphasis>Examine Your Local Configuration File:</emphasis> 607 <emphasis>Examine Your Local Configuration File:</emphasis>