From ba2221f71667e36037f85e113281de8133c1efc4 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 19 May 2014 10:44:59 +0300 Subject: [PATCH] ref-manual: Updated reference sections for environment setup scripts. Fixes [YOCTO #5895] Both section for the environment setup scripts (oe-init-build-env and oe-init-build-env-memres) were updated to provide some usage information on the conf-notes.txt file. This file is where the default list of images appears that the scripts display upon completion. (From yocto-docs rev: 77bd0cd6eeb77036fb7e1584c469f98c2524b750) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-structure.xml | 70 ++++++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 93cd45d456..1549d90357 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml @@ -210,6 +210,40 @@ scripts directory to do the bulk of the work. + + 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. + Here is an example: + + $ source oe-init-build-env + + ### Shell environment set up for builds. ### + + You can now run 'bitbake <target>' + + Common targets are: + core-image-minimal + core-image-sato + meta-toolchain + adt-installer + meta-ide-support + + You can also run generated qemu images with a command like 'runqemu qemux86' + + The script gets its default list of common targets from the + conf-notes.txt file, which is found in the + meta-yocto directory within the + Source Directory. + Should you have custom distributions, it is very easy to modify + this configuration file to include your targets for your + distribution. + Simply edit the list within the file and when you run the + environment setup script you see your customized list of targets. + + By default, running this script without a Build Directory @@ -283,6 +317,42 @@ BitBake server at port "12345" is started. + + 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. + Here is an example: + + $ source oe-init-build-env-memres + No port specified, using dynamically selected port + + ### Shell environment set up for builds. ### + + You can now run 'bitbake <target>' + + Common targets are: + core-image-minimal + core-image-sato + meta-toolchain + adt-installer + meta-ide-support + + You can also run generated qemu images with a command like 'runqemu qemux86' + 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 + conf-notes.txt file, which is found in the + meta-yocto directory within the + Source Directory. + Should you have custom distributions, it is very easy to modify + this configuration file to include your targets for your + distribution. + Simply edit the list within the file and when you run the + environment setup script you see your customized list of targets. + + By default, running this script without a Build Directory