diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml
index d3e503b3f7..48e39212a5 100644
--- a/documentation/ref-manual/ref-structure.xml
+++ b/documentation/ref-manual/ref-structure.xml
@@ -317,21 +317,42 @@
$ source oe-init-build-env-memres port_number build_dir
- The script uses other scripts within the
- scripts directory to do the bulk of the work.
-
-
-
- If you do not provide a port number with the script, the
- BitBake server starts at a randomly selected port.
+ Following are some considerations when sourcing this script:
+
+
+ The script uses other scripts within the
+ scripts directory to do the bulk of
+ the work.
+
+
+ If you do not provide a port number with the script, the
+ BitBake server starts at a randomly selected port.
+
+
+ The script's parameters are positionally dependent.
+ Consequently, you cannot run the script and provide a
+ Build Directory
+ name without also providing a port number.
+ In other words, the following syntax is illegal:
+
+ $ source oe-initbuild-env-memres build_dir
+
+
+ The previous restriction might be resolved in the
+ future.
+ See
+ Bug 7555
+ for more information.
+
+
+
When you run this script, your Yocto Project environment is set
- up, a
- Build Directory
- is created, your working directory becomes the Build Directory,
- and you are presented with a list of common BitBake targets.
+ up, a Build Directory is created, your working directory becomes
+ the Build Directory, and you are presented with a list of common
+ BitBake targets.
Here is an example:
$ source oe-init-build-env-memres
@@ -349,6 +370,7 @@
meta-ide-support
You can also run generated qemu images with a command like 'runqemu qemux86'
+ Bitbake server address: 127.0.0.1, server port: 53995
Bitbake server started on demand as needed, use bitbake -m to shut it down
The script gets its default list of common targets from the
@@ -369,16 +391,24 @@
Build Directory
argument creates a build directory named
build.
- If you provide a Build Directory argument when you
+ If you provide a Build Directory argument and port number when you
source the script, the Build Directory is
created using that name.
For example, the following command starts the BitBake server using
- a randomly selected port and creates a Build Directory named
+ port 53995 and creates a Build Directory named
mybuilds that is outside of the
Source Directory:
- $ source oe-init-build-env-memres ~/mybuilds
+ $ source oe-init-build-env-memres 53995 ~/mybuilds
+ The oe-init-build-env-memres script starts a
+ memory resident BitBake server.
+ This BitBake instance uses the
+ bitbake-cookerdaemon.log file, which is
+ located in the Build Directory.
+
+
+
The OpenEmbedded build system uses the template configuration
files, which are found by default in the
meta-yocto/conf directory in the