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>
This commit is contained in:
Kevin Strasser
2013-04-15 14:06:09 -07:00
committed by Richard Purdie
parent f5cd276edc
commit d0f6c29f42

View File

@@ -193,37 +193,27 @@
</para>
</section>
<section id='ref-classes-src-distribute'>
<title>Distribution of Sources - <filename>src_distribute_local.bbclass</filename></title>
<section id='ref-classes-archiver'>
<title>Archiving Sources - <filename>archive*.bbclass</filename></title>
<para>
Many software licenses require that source files be provided along with the binaries.
To simplify this process, two classes were created:
<filename>src_distribute.bbclass</filename> and
<filename>src_distribute_local.bbclass</filename>.
</para>
<para>
The results of these classes are <filename>tmp/deploy/source/</filename>
subdirectories with sources sorted by
<filename><link linkend='var-LICENSE'>LICENSE</link></filename> field.
If recipes list few licenses (or have entries like "Bitstream Vera"),
the source archive is placed in each license directory.
</para>
<para>
This class operates using three modes:
Many software licenses require that source code and/or other materials be
released with the binaries. To help with that task the following classes
are provided:
<itemizedlist>
<listitem><para><emphasis>copy:</emphasis> Copies the files to the
distribution directory.</para></listitem>
<listitem><para><emphasis>symlink:</emphasis> Creates symbolic
links for the files to the distribution directory.
</para></listitem>
<listitem><para><emphasis>move+symlink:</emphasis> Moves the files
into the distribution directory and then creates symbolic
links back to where they originated.</para></listitem>
<listitem><filename>archive-original-sources.bbclass</filename></listitem>
<listitem><filename>archive-patched-sources.bbclass</filename></listitem>
<listitem><filename>archive-configured-sources.bbclass</filename></listitem>
<listitem><filename>archiver.bbclass</filename></listitem>
</itemizedlist>
</para>
<para>
For more details on the source archiver, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>
Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>"
section in the Yocto Project Development Manual.
</para>
</section>
<section id='ref-classes-perl'>