From 59b50ea598538cb9ad9933ba28f9514052258d00 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 2 Jun 2014 18:57:39 +0300 Subject: dev-manual: Edits to "Creating a Custom Template Configuration Directory" Fixes [YOCTO #5895] I applied some review comments from Paul to tighten up this section. (From yocto-docs rev: 9f17ad00e9e707fcd6f2419762b4281d64f4ed0f) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 224 ++++++++++----------- 1 file changed, 111 insertions(+), 113 deletions(-) (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml') diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 8b2613aa12..2968b4d3c0 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -888,119 +888,6 @@ -
- Creating a Custom Template Configuration Directory - - - You might find yourself repeating the same configurations for - a particular build or group of builds. - If so, rather than repeatedly editing your - local.conf and possibly your - bblayers.conf, you can set up a - custom directory that has your configurations, and then - point the OpenEmbedded build system to that directory to find - the configurations. - - - - The OpenEmbedded build system uses the environment variable - TEMPLATECONF to point to the directory - from which it gathers configuration information that ultimately - ends up in the - Build Directory's - conf directory. - By default, TEMPLATECONF points here: - - TEMPLATECONF=${TEMPLATECONF:-meta-yocto/conf} - - This is the directory that the build system finds templates - with which to build some key configuration files. - If you look at this directory, you will see the - bblayers.conf.sample, - local.conf.sample, and - site.conf.sample configuration files. - The build system uses these files to form the respective - bblayers.conf, - local.conf, and the - site.conf configuration files it places in - the conf directory with the - Build Directory. - - - - To override these default configuration files with - configurations you want used with every build, simply point the - TEMPLATECONF to your directory. - The TEMPLATECONF variable is set in the - .templateconf file, which is in the - top-level - Source Directory - folder (e.g. poky). - Edit the .templateconf so that it points - to your directory. - Best practices dictate that you should keep your - template configuration directory in your custom distribution layer. - For example, suppose you have a layer named - meta-mylayer located in your home directory - and you want your template configuration directory named - myconf. - Changing the .templateconf as follows - causes the OpenEmbedded build system to look in your directory - and base its configuration files on the - *.sample configuration files it finds. - The final configuration files (i.e. - local.conf and - bblayers.conf ultimately still end up in - your Build Directory, but they are based on your - *.sample files. - - TEMPLATECONF=${TEMPLATECONF:-meta-mylayer/myconf} - - - - - Aside from the *.sample configuration files, - the conf-notes.txt also resides in the - default meta-yocto/conf directory. - The scripts that set up the build environment - (i.e. - &OE_INIT_FILE; - and - oe-init-build-env-memres) - use this file to display BitBake targets as part of the script - output. - Customizing this conf-notes.txt file is a - good way to make sure your list of custom targets appears - as part of the script's output. - - - - Here is output from either of the setup scripts by default: - - $ 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 - - - - - Changing the listed common targets is as easy as editing your - version of conf-notes.txt in your - custom template configuration directory and making sure you - have TEMPLATECONF pointing to it. - -
-
Customizing Images @@ -4349,6 +4236,117 @@ Gateways via their Web Interfaces"
+
+ Creating a Custom Template Configuration Directory + + + If you're producing your own customized version + of the build system for use by other users, you might + want to customize the message shown by the setup script or + you might want to change the template configuration files (i.e. + (local.conf and + bblayers.conf) that are created in + a new build directory. + + + + The OpenEmbedded build system uses the environment variable + TEMPLATECONF locate the directory + from which it gathers configuration information that ultimately + ends up in the + Build Directory's + conf directory. + By default, TEMPLATECONF is set as + follows in the poky repository: + + TEMPLATECONF=${TEMPLATECONF:-meta-yocto/conf} + + This is the directory that the build system finds templates + with which to build some key configuration files. + If you look at this directory, you will see the + bblayers.conf.sample, + local.conf.sample, and + conf-notes.txt files. + The build system uses these files to form the respective + bblayers.conf file, + local.conf file, and display the list of + BitBake targets when running the setup script. + + + + To override these default configuration files with + configurations you want used within every new + Build Directory, simply set the + TEMPLATECONF variable to your directory. + The TEMPLATECONF variable is set in the + .templateconf file, which is in the + top-level + Source Directory + folder (e.g. poky). + Edit the .templateconf so that it can locate + your directory. + + + + Best practices dictate that you should keep your + template configuration directory in your custom distribution layer. + For example, suppose you have a layer named + meta-mylayer located in your home directory + and you want your template configuration directory named + myconf. + Changing the .templateconf as follows + causes the OpenEmbedded build system to look in your directory + and base its configuration files on the + *.sample configuration files it finds. + The final configuration files (i.e. + local.conf and + bblayers.conf ultimately still end up in + your Build Directory, but they are based on your + *.sample files. + + TEMPLATECONF=${TEMPLATECONF:-meta-mylayer/myconf} + + + + + Aside from the *.sample configuration files, + the conf-notes.txt also resides in the + default meta-yocto/conf directory. + The scripts that set up the build environment + (i.e. + &OE_INIT_FILE; + and + oe-init-build-env-memres) + use this file to display BitBake targets as part of the script + output. + Customizing this conf-notes.txt file is a + good way to make sure your list of custom targets appears + as part of the script's output. + + + + Here is the default list of targets displayed as a result of + running either of the setup scripts: + + You can now run 'bitbake <target>' + + Common targets are: + core-image-minimal + core-image-sato + meta-toolchain + adt-installer + meta-ide-support + + + + + Changing the listed common targets is as easy as editing your + version of conf-notes.txt in your + custom template configuration directory and making sure you + have TEMPLATECONF set to your directory. + +
+
Building a Tiny System -- cgit v1.2.3-54-g00ecf