documentation/dev-manual/dev-manual-common-tasks.xml: note on readme

Added a note in the "Creating Layers" section noting that to be
Yocto Project compliant, a layer must contain a README file.  This
change was prompted by a discussion over the fact between Robert
P. J. Day and Mark Hatle.

(From yocto-docs rev: 2e073763a81125699a2d962031ca29ca64c81595)

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 2012-09-04 10:48:47 -07:00 committed by Richard Purdie
parent b3ba9eb7e2
commit 3fa4a6a146
1 changed files with 4 additions and 1 deletions

View File

@ -146,7 +146,10 @@
If the layer adds distro policy, add the distro configuration in a
<filename>conf/distro/</filename> file with the layer.
If the layer introduces new recipes, put the recipes you need in
<filename>recipes-*</filename> subdirectories within the layer.</para></listitem>
<filename>recipes-*</filename> subdirectories within the layer.
<note>In order to be compliant with the Yocto Project, a layer must contain
a <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-readme'>README file.</ulink>
</note></para></listitem>
</orderedlist>
</para>