aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-02 15:22:28 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-06-18 10:30:43 +0100
commit84ee8c653a45ffbda1fd3773f5fbb67d20d1bfc3 (patch)
tree1d1a761a861ee95f583666ff8382fd7dda7dcdd1 /documentation/ref-manual
parentfae1d7d56779ecf662ff04541abe431ca669940e (diff)
downloadopenembedded-core-contrib-84ee8c653a45ffbda1fd3773f5fbb67d20d1bfc3.tar.gz
ref-manual, dev-manual: Updates for custom template configuration directory.
Fixes [YOCTO #5895] I created a new section in the dev-manual titles "Creating a Custom Template Configuration Directory" that describes how the build system uses the template local.conf and bblayers.conf and conf-notes.txt files as a basis when creating the real deals in the build directory's conf folder. The context of this is so that the user can create their own directory with their own template files for repeated configurations and to create a custom conf-notes.txt file should they want the setup scripts to display some custom list of targets. I also modified the two script references in the ref-manual for oe-init-build-env and oe-init-build-env-memres. I needed to link to the "how-to" section and added a bit in there about how the scripts go about forming the conf files in the build directory. (From yocto-docs rev: c07fb7082fe08387bbc546b2a23620dedc7127b8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-structure.xml28
1 files changed, 24 insertions, 4 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml
index 1549d90357..c849dbda33 100644
--- a/documentation/ref-manual/ref-structure.xml
+++ b/documentation/ref-manual/ref-structure.xml
@@ -240,8 +240,10 @@
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.
+ See the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>"
+ section in the Yocto Project Development Manual for more
+ information.
</para>
<para>
@@ -258,6 +260,14 @@
<literallayout class='monospaced'>
$ source &OE_INIT_FILE; ~/mybuilds
</literallayout>
+ The OpenEmbedded build system uses the template configuration
+ files, which are found by default in the
+ <filename>meta-yocto/conf</filename> directory in the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
+ See the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>"
+ section in the Yocto Project Development Manual for more
+ information.
<note>
The OpenEmbedded build system does not support file or directory names that
contain spaces.
@@ -349,8 +359,10 @@
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.
+ See the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>"
+ section in the Yocto Project Development Manual for more
+ information.
</para>
<para>
@@ -368,6 +380,14 @@
<literallayout class='monospaced'>
$ source oe-init-build-env-memres ~/mybuilds
</literallayout>
+ The OpenEmbedded build system uses the template configuration
+ files, which are found by default in the
+ <filename>meta-yocto/conf</filename> directory in the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
+ See the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>"
+ section in the Yocto Project Development Manual for more
+ information.
<note>
The OpenEmbedded build system does not support file or
directory names that contain spaces.