README

wr-template
===========

This layer provides template processing support for OpenEmbedded.  Wind River
templates are a mechanism that permit various configurations to be enabled
with a simple setting.


What is a template?
-------------------
A template lives in the 'templates' directory of a given layer.  The templates
directory contains a series of directories to organize the templates.  The name
of the directory is used to enable the template.  The 'default' directory will
cause that template to be included by default even if the user has not
specified it.

A template directory may contain:
   README - a template README file
   require - a list of other templates required for this one
   template.conf - a template configuration fragment
   image.inc - an image fragment
   bsp-pkgs.conf - a BSP specific configuration fragment
   bsp-pkgs.inc - a BSP specific image fragment

The README is a plain text file that will be copied to a generated
README_templates file in the user's TOPDIR.  This allows a user to see
all README information for each template they have selected.

The require file may include comments, starting with a '#' or template names
to include.

The template.conf file contains various configuration variables that would
normally be placed in local.conf (or another similar '.conf' file) by the user.

The image.inc file contains various image recipe specific variables.  The
variables here are typically added to a recipe (.bb) or bbappend file.

The bsp-pkgs.conf and bsp-pkgs.inc files are only loaded if the user is
compiling a BSP that is defined in that layer.  The bsp-pkgs.conf is equivalent
to the template.conf file, while the bsp-pkgs.inc is equivalent to the
image.inc file.

In addition, the layer allows the templates to set various banner messages.

    CONFIG_BANNER[path_to_template] = "..."
    BANNER[path_to_template] = "..."

A configuration banner is only displayed if bitbake has to reparse the
configuration.  A runtime banner will always be displayed when a 
build is run.


Dependencies
------------
This layer depends on oe-core.


Maintenance
-----------
This layer is maintained by Wind River Systems, Inc.
Contact <support@windriver.com> or your support representative for more
information on submitting changes.


Building the wr-template layer
-----------------------------------
This layer should be added to the bblayers.conf file.


License
-------
Copyright (C) 2016 Wind River Systems, Inc.

Source code included in the tree for individual recipes is under the LICENSE
stated in the associated recipe (.bb file) unless otherwise stated.

The metadata is under the following license unless otherwise stated.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.