summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-02-22 14:54:58 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 12:08:01 -0800
commit17647137632cfb865ac6f5f280b71f75d4211659 (patch)
tree0be883c9ba59c1558ecc365e3ed5d62dae05218f
parent011738ac7ae422882e704e47ab6295d5a046547e (diff)
downloadpoky-17647137632cfb865ac6f5f280b71f75d4211659.tar.gz
documentation/bsp-guide/bsp.xml: New "README.sources File" section added.
(From yocto-docs rev: 2f398b278904b26e4cd6ab237c0c9dce7e8d6009) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/bsp-guide/bsp.xml27
1 files changed, 25 insertions, 2 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 696e4ee7e2..a39a611b38 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -220,7 +220,7 @@
220 <section id="bsp-filelayout-readme"> 220 <section id="bsp-filelayout-readme">
221 <title>README File</title> 221 <title>README File</title>
222 <para> 222 <para>
223 You can find these files in the BSP Layer at: 223 You can find this file in the BSP Layer at:
224 <literallayout class='monospaced'> 224 <literallayout class='monospaced'>
225 meta-&lt;bsp_name&gt;/README 225 meta-&lt;bsp_name&gt;/README
226 </literallayout> 226 </literallayout>
@@ -234,7 +234,30 @@
234 </para> 234 </para>
235 235
236 <para> 236 <para>
237 Technically speaking a <filename>README</filename> is optional but it is highly 237 Technically speaking a <filename>README</filename> file is optional but it is highly
238 recommended that every BSP has one.
239 </para>
240 </section>
241
242 <section id="bsp-filelayout-readme-sources">
243 <title>README.sources File</title>
244 <para>
245 You can find this file in the BSP Layer at:
246 <literallayout class='monospaced'>
247 meta-&lt;bsp_name&gt;/README.sources
248 </literallayout>
249 </para>
250
251 <para>
252 This file provides information on where to locate the BSP source files.
253 For example, information provides where to find the sources that comprise
254 the images shipped with the BSP.
255 Information is also included to help you find the metadata used to generate the images
256 that ship with the BSP.
257 </para>
258
259 <para>
260 Technically speaking a <filename>README.sources</filename> file is optional but it is highly
238 recommended that every BSP has one. 261 recommended that every BSP has one.
239 </para> 262 </para>
240 </section> 263 </section>