aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/bsp-guide
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-01-14 16:04:01 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-02-17 15:16:48 +0000
commita0e84189ee77955af14b4e695688ea204ad46572 (patch)
tree22aa6dc584ce992a2a763b9c98df70f06daf2a05 /documentation/bsp-guide
parent73588fa725f5292cdc50f8ec522d70cd48e45458 (diff)
downloadopenembedded-core-contrib-a0e84189ee77955af14b4e695688ea204ad46572.tar.gz
bsp-guide: Added a clarifying not about meta- in BSP layer names.
This note provides a bit of a warning or tip regarding naming BSP layers. The letter of the law dictates that you don't need to prepend a BSP layer name with the string "meta-". However, scripts exist in OE where the naming convention is assumed. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 0375349fdd3cd5ff8a54db8124d5cdc02133ff12) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/bsp-guide')
-rw-r--r--documentation/bsp-guide/bsp.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index a3a4508f74..3d4e82ea83 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -41,6 +41,14 @@
</literallayout>
The string "meta-" is prepended to the machine or platform name, which is
<replaceable>bsp_name</replaceable> in the above form.
+ <note><title>Tip</title>
+ Because the BSP layer naming convention is well-established,
+ it is advisable to follow it when creating layers.
+ Technically speaking, a BSP layer name does not need to
+ start with <filename>meta-</filename>.
+ However, you might run into situations where obscure
+ scripts assume this convention.
+ </note>
</para>
<para>