diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-11-07 08:41:03 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-03 12:53:05 +0000 |
commit | 0290219099de15fb43f18f4ead2a575b35246019 (patch) | |
tree | 9395e1fc5415ca45f25a329859fb51fe4c7c0fd2 /documentation/ref-manual/ref-structure.xml | |
parent | 437bf60876e53d4f56598f5e51301a8b437c5c5d (diff) | |
download | openembedded-core-contrib-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/ref-structure.xml')
-rw-r--r-- | documentation/ref-manual/ref-structure.xml | 25 |
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 @@ <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'> |