sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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 <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-05-19 10:44:59 +03:00 committed by Richard Purdie
parent c2852ea835
commit ba2221f716
1 changed files with 70 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
documentation/ref-manual/ref-structure.xml
View File

@ -210,6 +210,40 @@
<filename>scripts</filename> directory to do the bulk of the work.
</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>
@ -283,6 +317,42 @@
BitBake server at port "12345" is started.
</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>