summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-structure.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-structure.xml')
-rw-r--r--documentation/ref-manual/ref-structure.xml70
1 files changed, 70 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml
index 93cd45d..1549d90 100644
--- a/documentation/ref-manual/ref-structure.xml
+++ b/documentation/ref-manual/ref-structure.xml
@@ -211,6 +211,40 @@
</para>
<para>
+ When you run this script, your Yocto Project environment is set
+ up, a
+ <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
+ is created, your working directory becomes the Build Directory,
+ and you are presented with a list of common BitBake targets.
+ Here is an example:
+ <literallayout class='monospaced'>
+ $ source oe-init-build-env
+
+ ### Shell environment set up for builds. ###
+
+ You can now run 'bitbake &lt;target&gt;'
+
+ 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'
+ </literallayout>
+ The script gets its default list of common targets from the
+ <filename>conf-notes.txt</filename> file, which is found in the
+ <filename>meta-yocto</filename> directory within the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
+ 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.
+ </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
@@ -284,6 +318,42 @@
</para>
<para>
+ When you run this script, your Yocto Project environment is set
+ up, a
+ <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
+ is created, your working directory becomes the Build Directory,
+ and you are presented with a list of common BitBake targets.
+ Here is an example:
+ <literallayout class='monospaced'>
+ $ source oe-init-build-env-memres
+ No port specified, using dynamically selected port
+
+ ### Shell environment set up for builds. ###
+
+ You can now run 'bitbake &lt;target&gt;'
+
+ 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
+ </literallayout>
+ The script gets its default list of common targets from the
+ <filename>conf-notes.txt</filename> file, which is found in the
+ <filename>meta-yocto</filename> directory within the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
+ 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.
+ </para>
+
+ <para>
By default, running this script without a
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
argument creates a build directory named
OpenPOWER on IntegriCloud