summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-11-07 08:41:03 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-03 12:53:05 +0000
commit0290219099de15fb43f18f4ead2a575b35246019 (patch)
tree9395e1fc5415ca45f25a329859fb51fe4c7c0fd2 /documentation/ref-manual
parent437bf60876e53d4f56598f5e51301a8b437c5c5d (diff)
downloadpoky-0290219099de15fb43f18f4ead2a575b35246019.tar.gz
ref-manual: Updated the description for oe-init-build-env-memres
Added more wording to clearly state what is going on when you run this script. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 2b23966d80b2787f7eddcbf6c635220d58d7a494) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-structure.xml25
1 files changed, 13 insertions, 12 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml
index 087246171b..3c5f0363c9 100644
--- a/documentation/ref-manual/ref-structure.xml
+++ b/documentation/ref-manual/ref-structure.xml
@@ -235,10 +235,10 @@
235 <title><filename>oe-init-build-env-memres</filename></title> 235 <title><filename>oe-init-build-env-memres</filename></title>
236 236
237 <para> 237 <para>
238 This script is one of two scripts that set up the OpenEmbedded build 238 This script is one of two scripts that set up the OpenEmbedded
239 environment. 239 build environment.
240 Setting up the environment with this script uses a 240 Aside from setting up the environment, this script starts a
241 memory-resident BitBake. 241 memory-resident BitBake server.
242 For information on the other setup script, see the 242 For information on the other setup script, see the
243 "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>" 243 "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>"
244 section. 244 section.
@@ -263,7 +263,7 @@
263 </para> 263 </para>
264 264
265 <para> 265 <para>
266 You need to run an environment setup script before running BitBake 266 You need to run an environment setup script before using BitBake
267 commands. 267 commands.
268 Following is the script syntax: 268 Following is the script syntax:
269 <literallayout class='monospaced'> 269 <literallayout class='monospaced'>
@@ -274,19 +274,20 @@
274 </para> 274 </para>
275 275
276 <para> 276 <para>
277 If you do not provide a port number with the script, the default 277 If you do not provide a port number with the script, the
278 port "12345" is used. 278 BitBake server at port "12345" is started.
279 </para> 279 </para>
280 280
281 <para> 281 <para>
282 By default, running this script without a 282 By default, running this script without a
283 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 283 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
284 argument creates the <filename>build</filename> directory. 284 argument creates a build directory named
285 <filename>build</filename>.
285 If you provide a Build Directory argument when you 286 If you provide a Build Directory argument when you
286 <filename>source</filename> the script, you direct the OpenEmbedded 287 <filename>source</filename> the script, the Build Directory is
287 build system to create a Build Directory of your choice. 288 created using that name.
288 For example, the following command uses the default port number 289 For example, the following command starts the BitBake server using
289 "12345" and creates a Build Directory named 290 the default port "12345" and creates a Build Directory named
290 <filename>mybuilds</filename> that is outside of the 291 <filename>mybuilds</filename> that is outside of the
291 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: 292 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
292 <literallayout class='monospaced'> 293 <literallayout class='monospaced'>