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: 7aa93cadb4758aba239ffd472ea5e1026125d371)

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 802e09b0ab
commit 3c68b660b4
1 changed files with 13 additions and 12 deletions

View File

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