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>
This commit is contained in:
Scott Rifenbark 2013-11-07 08:41:03 -08:00 committed by Richard Purdie
parent 437bf60876
commit 0290219099
1 changed files with 13 additions and 12 deletions

View File

@ -235,10 +235,10 @@
<title><filename>oe-init-build-env-memres</filename></title> <title><filename>oe-init-build-env-memres</filename></title>
<para> <para>
This script is one of two scripts that set up the OpenEmbedded build This script is one of two scripts that set up the OpenEmbedded
environment. build environment.
Setting up the environment with this script uses a Aside from setting up the environment, this script starts a
memory-resident BitBake. memory-resident BitBake server.
For information on the other setup script, see the For information on the other setup script, see the
"<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>" "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>"
section. section.
@ -263,7 +263,7 @@
</para> </para>
<para> <para>
You need to run an environment setup script before running BitBake You need to run an environment setup script before using BitBake
commands. commands.
Following is the script syntax: Following is the script syntax:
<literallayout class='monospaced'> <literallayout class='monospaced'>
@ -274,19 +274,20 @@
</para> </para>
<para> <para>
If you do not provide a port number with the script, the default If you do not provide a port number with the script, the
port "12345" is used. BitBake server at port "12345" is started.
</para> </para>
<para> <para>
By default, running this script without a By default, running this script without a
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
argument creates the <filename>build</filename> directory. argument creates a build directory named
<filename>build</filename>.
If you provide a Build Directory argument when you If you provide a Build Directory argument when you
<filename>source</filename> the script, you direct the OpenEmbedded <filename>source</filename> the script, the Build Directory is
build system to create a Build Directory of your choice. created using that name.
For example, the following command uses the default port number For example, the following command starts the BitBake server using
"12345" and creates a Build Directory named the default port "12345" and creates a Build Directory named
<filename>mybuilds</filename> that is outside of the <filename>mybuilds</filename> that is outside of the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
<literallayout class='monospaced'> <literallayout class='monospaced'>