From 3c68b660b4a468468cd8e8663500791e46385ab5 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 7 Nov 2013 08:41:03 -0800 Subject: [PATCH] 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 (From yocto-docs rev: 7aa93cadb4758aba239ffd472ea5e1026125d371) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-structure.xml | 25 +++++++++++----------- 1 file 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 @@ <filename>oe-init-build-env-memres</filename> - 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 "&OE_INIT_FILE;" section. @@ -263,7 +263,7 @@ - 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: @@ -274,19 +274,20 @@ - 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. By default, running this script without a Build Directory - argument creates the build directory. + argument creates a build directory named + build. If you provide a Build Directory argument when you - source 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 + source 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 mybuilds that is outside of the Source Directory: