summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-01-19 14:54:21 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-02-17 15:16:52 +0000
commitc9b7007f27fb4f8a025f4b9eaf1eb087792dc763 (patch)
treeb673c32c5a055d65b5fc1d7250afa9e33e67a3df /documentation/ref-manual/ref-variables.xml
parent4ab132a20d33e70cf6736737c59d2c0ce2f79298 (diff)
downloadpoky-c9b7007f27fb4f8a025f4b9eaf1eb087792dc763.tar.gz
ref-manual: Added warnings about using package_tar
This option to the PACKAGE_CLASSES variable is broken and not supported. I added several warnings saying such. We opted to keep the documentation rather than eliminating it completely to prevent questions should someone find the code and wonder why it is not documented. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 1acf3da2034c4c3f74acee1ccb375f0450ed90a0) 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/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml25
1 files changed, 13 insertions, 12 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 281c4e3e2d..337c3f4397 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -4444,6 +4444,11 @@
4444 or 4444 or
4445 <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link> 4445 <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>
4446 class. 4446 class.
4447 <note><title>Warning</title>
4448 The <filename>package_tar</filename> class is broken
4449 and is not supported.
4450 It is recommended that you do not use it.
4451 </note>
4447 </para> 4452 </para>
4448 4453
4449 <para> 4454 <para>
@@ -6932,6 +6937,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6932 <literallayout class='monospaced'> 6937 <literallayout class='monospaced'>
6933 PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk package_tar" 6938 PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk package_tar"
6934 </literallayout> 6939 </literallayout>
6940 <note><title>Warning</title>
6941 While it is a legal option, the
6942 <filename>package_tar</filename> class is broken
6943 and is not supported.
6944 It is recommended that you do not use it.
6945 </note>
6935 The build system uses only the first argument in the list 6946 The build system uses only the first argument in the list
6936 as the package manager when creating your image or SDK. 6947 as the package manager when creating your image or SDK.
6937 However, packages will be created using any additional 6948 However, packages will be created using any additional
@@ -6939,20 +6950,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6939 For example, if you use the following in your 6950 For example, if you use the following in your
6940 <filename>local.conf</filename> file: 6951 <filename>local.conf</filename> file:
6941 <literallayout class='monospaced'> 6952 <literallayout class='monospaced'>
6942 PACKAGE_CLASSES ?= "package_ipk package_tar" 6953 PACKAGE_CLASSES ?= "package_ipk"
6943 </literallayout> 6954 </literallayout>
6944 The OpenEmbedded build system uses the IPK package manager 6955 The OpenEmbedded build system uses the IPK package manager
6945 to create your image or SDK as well as generating 6956 to create your image or SDK.
6946 TAR packages.
6947 </para>
6948
6949 <para>
6950 You cannot specify the
6951 <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>
6952 class first in the list.
6953 Files using the <filename>.tar</filename> format cannot
6954 be used as a substitute packaging format
6955 for DEB, RPM, and IPK formatted files for your image or SDK.
6956 </para> 6957 </para>
6957 6958
6958 <para> 6959 <para>