summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorKevin Strasser <kevin.strasser@linux.intel.com>2013-04-15 14:06:09 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-17 22:34:13 +0100
commit82269903d3a20b12a61aaccdb20559ba8ff92624 (patch)
tree14368e939f3579c76f38c5fbc2a3500a0dc21fe0 /documentation/ref-manual
parent6720a6e3c55bcb40a05ba1fa10876fe8ee81c274 (diff)
downloadpoky-82269903d3a20b12a61aaccdb20559ba8ff92624.tar.gz
ref-manual: New class added for archive*.bbclass.
Patch from Kevin that adds a new class. Note that the patch removed the existing src_distribute_local.bbclass class. (From yocto-docs rev: 4ce602093bc9ddfcbcd9392bcc8fd6187885bdf1) Signed-off-by: Kevin Strasser <kevin.strasser@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-classes.xml40
1 files changed, 15 insertions, 25 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 69ca78c380..51418b90f2 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -193,36 +193,26 @@
193 </para> 193 </para>
194</section> 194</section>
195 195
196<section id='ref-classes-src-distribute'> 196<section id='ref-classes-archiver'>
197 <title>Distribution of Sources - <filename>src_distribute_local.bbclass</filename></title> 197 <title>Archiving Sources - <filename>archive*.bbclass</filename></title>
198 198
199 <para> 199 <para>
200 Many software licenses require that source files be provided along with the binaries. 200 Many software licenses require that source code and/or other materials be
201 To simplify this process, two classes were created: 201 released with the binaries. To help with that task the following classes
202 <filename>src_distribute.bbclass</filename> and 202 are provided:
203 <filename>src_distribute_local.bbclass</filename>. 203 <itemizedlist>
204 </para> 204 <listitem><filename>archive-original-sources.bbclass</filename></listitem>
205 205 <listitem><filename>archive-patched-sources.bbclass</filename></listitem>
206 <para> 206 <listitem><filename>archive-configured-sources.bbclass</filename></listitem>
207 The results of these classes are <filename>tmp/deploy/source/</filename> 207 <listitem><filename>archiver.bbclass</filename></listitem>
208 subdirectories with sources sorted by 208 </itemizedlist>
209 <filename><link linkend='var-LICENSE'>LICENSE</link></filename> field.
210 If recipes list few licenses (or have entries like "Bitstream Vera"),
211 the source archive is placed in each license directory.
212 </para> 209 </para>
213 210
214 <para> 211 <para>
215 This class operates using three modes: 212 For more details on the source archiver, see the
216 <itemizedlist> 213 "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>
217 <listitem><para><emphasis>copy:</emphasis> Copies the files to the 214 Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>"
218 distribution directory.</para></listitem> 215 section in the Yocto Project Development Manual.
219 <listitem><para><emphasis>symlink:</emphasis> Creates symbolic
220 links for the files to the distribution directory.
221 </para></listitem>
222 <listitem><para><emphasis>move+symlink:</emphasis> Moves the files
223 into the distribution directory and then creates symbolic
224 links back to where they originated.</para></listitem>
225 </itemizedlist>
226 </para> 216 </para>
227</section> 217</section>
228 218