summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-12-05 15:54:08 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-11 14:19:27 +0000
commit79ba3e4561099fc905a389c9853d1fec0f2db251 (patch)
tree1df89cfb90c10be1207aac28e84b33f8a286f393
parentde7ead9cfdf8275edb99d7940514e68acdfd1388 (diff)
downloadpoky-79ba3e4561099fc905a389c9853d1fec0f2db251.tar.gz
ref-manual: Re-ordered externalsrc class into the "C"'s
(From yocto-docs rev: 4b655fbc4abd9ae4a6280346b057b54e99be9d84) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-classes.xml106
1 files changed, 53 insertions, 53 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index be68fce8ee..e631c0ca18 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -585,6 +585,59 @@
585 </para> 585 </para>
586</section> 586</section>
587 587
588<section id='ref-classes-externalsrc'>
589 <title><filename>externalsrc.bbclass</filename></title>
590
591 <para>
592 The <filename>externalsrc</filename> class supports building software
593 from source code that is external to the OpenEmbedded build system.
594 Building software from an external source tree means that the build
595 system's normal fetch, unpack, and patch process is not used.
596 </para>
597
598 <para>
599 By default, the OpenEmbedded build system uses the
600 <link linkend='var-S'><filename>S</filename></link> and
601 <link linkend='var-B'><filename>B</filename></link> variables to
602 locate unpacked recipe source code and to build it, respectively.
603 When your recipe inherits the <filename>externalsrc</filename> class,
604 you use the
605 <link linkend='var-EXTERNALSRC'><filename>EXTERNALSRC</filename></link>
606 and
607 <link linkend='var-EXTERNALSRC_BUILD'><filename>EXTERNALSRC_BUILD</filename></link>
608 variables to ultimately define <filename>S</filename> and
609 <filename>B</filename>.
610 </para>
611
612 <para>
613 By default, this class expects the source code to support recipe builds
614 that use the <link linkend='var-B'><filename>B</filename></link>
615 variable to point to the directory in which the OpenEmbedded build
616 system places the generated objects built from the recipes.
617 By default, the <filename>B</filename> directory is set to the
618 following, which is separate from the source directory
619 (<filename>S</filename>):
620 <literallayout class='monospaced'>
621 ${WORKDIR}/${BPN}/{PV}/
622 </literallayout>
623 See these variables for more information:
624 <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>,
625 <link linkend='var-BPN'><filename>BPN</filename></link>, and
626 <link linkend='var-PV'><filename>PV</filename></link>,
627 </para>
628
629 <para>
630 For more information on the
631 <filename>externalsrc</filename> class, see the comments in
632 <filename>meta/classes/externalsrc.bbclass</filename> in the
633 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
634 For information on how to use the <filename>externalsrc</filename>
635 class, see the
636 "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>"
637 section in the Yocto Project Development Manual.
638 </para>
639</section>
640
588<section id='ref-classes-extrausers'> 641<section id='ref-classes-extrausers'>
589 <title><filename>extrausers.bbclass</filename></title> 642 <title><filename>extrausers.bbclass</filename></title>
590 643
@@ -2846,59 +2899,6 @@
2846 </para> 2899 </para>
2847</section> 2900</section>
2848 2901
2849<section id='ref-classes-externalsrc'>
2850 <title><filename>externalsrc.bbclass</filename></title>
2851
2852 <para>
2853 The <filename>externalsrc</filename> class supports building software
2854 from source code that is external to the OpenEmbedded build system.
2855 Building software from an external source tree means that the build
2856 system's normal fetch, unpack, and patch process is not used.
2857 </para>
2858
2859 <para>
2860 By default, the OpenEmbedded build system uses the
2861 <link linkend='var-S'><filename>S</filename></link> and
2862 <link linkend='var-B'><filename>B</filename></link> variables to
2863 locate unpacked recipe source code and to build it, respectively.
2864 When your recipe inherits the <filename>externalsrc</filename> class,
2865 you use the
2866 <link linkend='var-EXTERNALSRC'><filename>EXTERNALSRC</filename></link>
2867 and
2868 <link linkend='var-EXTERNALSRC_BUILD'><filename>EXTERNALSRC_BUILD</filename></link>
2869 variables to ultimately define <filename>S</filename> and
2870 <filename>B</filename>.
2871 </para>
2872
2873 <para>
2874 By default, this class expects the source code to support recipe builds
2875 that use the <link linkend='var-B'><filename>B</filename></link>
2876 variable to point to the directory in which the OpenEmbedded build
2877 system places the generated objects built from the recipes.
2878 By default, the <filename>B</filename> directory is set to the
2879 following, which is separate from the source directory
2880 (<filename>S</filename>):
2881 <literallayout class='monospaced'>
2882 ${WORKDIR}/${BPN}/{PV}/
2883 </literallayout>
2884 See these variables for more information:
2885 <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>,
2886 <link linkend='var-BPN'><filename>BPN</filename></link>, and
2887 <link linkend='var-PV'><filename>PV</filename></link>,
2888 </para>
2889
2890 <para>
2891 For more information on the
2892 <filename>externalsrc</filename> class, see the comments in
2893 <filename>meta/classes/externalsrc.bbclass</filename> in the
2894 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
2895 For information on how to use the <filename>externalsrc</filename>
2896 class, see the
2897 "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>"
2898 section in the Yocto Project Development Manual.
2899 </para>
2900</section>
2901
2902<section id='ref-classes-others'> 2902<section id='ref-classes-others'>
2903 <title>Other Classes</title> 2903 <title>Other Classes</title>
2904 2904