summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Eggleton <bluelightning@bluelightning.org>2023-04-22 15:19:43 +1200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-04-22 10:42:54 +0100
commit356b6f0e3266175d310dae2009f69707e5f010c3 (patch)
tree31caf557a329065d1e06f0bd764f69b48e66b293
parent8242bd30def1af9286a8cdbed8c569c58a6af38b (diff)
downloadpoky-356b6f0e3266175d310dae2009f69707e5f010c3.tar.gz
ref-manual: Remove references to package_tar class
This has been removed in 4.2. (From yocto-docs rev: a5dcaf95915deec5243ab2fd0711c63e98b2a661) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/overview-manual/concepts.rst8
-rw-r--r--documentation/ref-manual/classes.rst27
-rw-r--r--documentation/ref-manual/tasks.rst11
-rw-r--r--documentation/ref-manual/variables.rst35
4 files changed, 6 insertions, 75 deletions
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index e7551149a1..6db515e500 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -638,9 +638,8 @@ package files are kept:
638 type sub-folder. Given RPM, IPK, or DEB packaging and tarball 638 type sub-folder. Given RPM, IPK, or DEB packaging and tarball
639 creation, the 639 creation, the
640 :term:`DEPLOY_DIR_RPM`, 640 :term:`DEPLOY_DIR_RPM`,
641 :term:`DEPLOY_DIR_IPK`, 641 :term:`DEPLOY_DIR_IPK`, or
642 :term:`DEPLOY_DIR_DEB`, or 642 :term:`DEPLOY_DIR_DEB`
643 :term:`DEPLOY_DIR_TAR`,
644 variables are used, respectively. 643 variables are used, respectively.
645 644
646- :term:`PACKAGE_ARCH`: Defines 645- :term:`PACKAGE_ARCH`: Defines
@@ -653,9 +652,8 @@ tasks to generate packages and place them into the package holding area
653(e.g. ``do_package_write_ipk`` for IPK packages). See the 652(e.g. ``do_package_write_ipk`` for IPK packages). See the
654":ref:`ref-tasks-package_write_deb`", 653":ref:`ref-tasks-package_write_deb`",
655":ref:`ref-tasks-package_write_ipk`", 654":ref:`ref-tasks-package_write_ipk`",
656":ref:`ref-tasks-package_write_rpm`",
657and 655and
658":ref:`ref-tasks-package_write_tar`" 656":ref:`ref-tasks-package_write_rpm`"
659sections in the Yocto Project Reference Manual for additional 657sections in the Yocto Project Reference Manual for additional
660information. As an example, consider a scenario where an IPK packaging 658information. As an example, consider a scenario where an IPK packaging
661manager is being used and there is package architecture support for both 659manager is being used and there is package architecture support for both
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index f8172e6b29..32494ee09f 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2025,13 +2025,7 @@ The :ref:`ref-classes-package` class supports generating packages from a build's
2025output. The core generic functionality is in ``package.bbclass``. The 2025output. The core generic functionality is in ``package.bbclass``. The
2026code specific to particular package types resides in these 2026code specific to particular package types resides in these
2027package-specific classes: :ref:`ref-classes-package_deb`, 2027package-specific classes: :ref:`ref-classes-package_deb`,
2028:ref:`ref-classes-package_rpm`, :ref:`ref-classes-package_ipk`, and 2028:ref:`ref-classes-package_rpm`, :ref:`ref-classes-package_ipk`.
2029:ref:`ref-classes-package_tar`.
2030
2031.. note::
2032
2033 The :ref:`ref-classes-package_tar` class is broken and
2034 not supported. It is recommended that you do not use this class.
2035 2029
2036You can control the list of resulting package formats by using the 2030You can control the list of resulting package formats by using the
2037:term:`PACKAGE_CLASSES` variable defined in your ``conf/local.conf`` 2031:term:`PACKAGE_CLASSES` variable defined in your ``conf/local.conf``
@@ -2121,25 +2115,6 @@ This class inherits the :ref:`ref-classes-package` class and
2121is enabled through the :term:`PACKAGE_CLASSES` 2115is enabled through the :term:`PACKAGE_CLASSES`
2122variable in the ``local.conf`` file. 2116variable in the ``local.conf`` file.
2123 2117
2124.. _ref-classes-package_tar:
2125
2126``package_tar``
2127===============
2128
2129The :ref:`ref-classes-package_tar` class provides support for creating tarballs. The
2130class ensures the packages are written out in a tarball format to the
2131``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory.
2132
2133This class inherits the :ref:`ref-classes-package` class and
2134is enabled through the :term:`PACKAGE_CLASSES`
2135variable in the ``local.conf`` file.
2136
2137.. note::
2138
2139 You cannot specify the :ref:`ref-classes-package_tar` class first using the
2140 :term:`PACKAGE_CLASSES` variable. You must use ``.deb``, ``.ipk``, or ``.rpm``
2141 file formats for your image or SDK.
2142
2143.. _ref-classes-packagedata: 2118.. _ref-classes-packagedata:
2144 2119
2145``packagedata`` 2120``packagedata``
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index f2b93185af..0db960b22f 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -260,17 +260,6 @@ the package feeds area. For more information, see the
260":ref:`overview-manual/concepts:package feeds`" section in 260":ref:`overview-manual/concepts:package feeds`" section in
261the Yocto Project Overview and Concepts Manual. 261the Yocto Project Overview and Concepts Manual.
262 262
263.. _ref-tasks-package_write_tar:
264
265``do_package_write_tar``
266------------------------
267
268Creates tarballs and places them in the
269``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in
270the package feeds area. For more information, see the
271":ref:`overview-manual/concepts:package feeds`" section in
272the Yocto Project Overview and Concepts Manual.
273
274.. _ref-tasks-packagedata: 263.. _ref-tasks-packagedata:
275 264
276``do_packagedata`` 265``do_packagedata``
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 2efb3f8db7..bd11b362e5 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1989,25 +1989,6 @@ system and gives an overview of their function and contents.
1989 ":ref:`overview-manual/concepts:package feeds`" section 1989 ":ref:`overview-manual/concepts:package feeds`" section
1990 in the Yocto Project Overview and Concepts Manual. 1990 in the Yocto Project Overview and Concepts Manual.
1991 1991
1992 :term:`DEPLOY_DIR_TAR`
1993 Points to the area that the OpenEmbedded build system uses to place
1994 tarballs that are ready to be used outside of the build system. This
1995 variable applies only when :term:`PACKAGE_CLASSES` contains
1996 ":ref:`ref-classes-package_tar`".
1997
1998 The BitBake configuration file initially defines this variable as a
1999 sub-folder of :term:`DEPLOY_DIR`::
2000
2001 DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar"
2002
2003 The :ref:`ref-classes-package_tar` class uses the
2004 :term:`DEPLOY_DIR_TAR` variable to make sure the
2005 :ref:`ref-tasks-package_write_tar` task
2006 writes TAR packages into the appropriate folder. For more information
2007 on how packaging works, see the
2008 ":ref:`overview-manual/concepts:package feeds`" section
2009 in the Yocto Project Overview and Concepts Manual.
2010
2011 :term:`DEPLOYDIR` 1992 :term:`DEPLOYDIR`
2012 When inheriting the :ref:`ref-classes-deploy` class, the 1993 When inheriting the :ref:`ref-classes-deploy` class, the
2013 :term:`DEPLOYDIR` points to a temporary work area for deployed files that 1994 :term:`DEPLOYDIR` points to a temporary work area for deployed files that
@@ -3679,12 +3660,7 @@ system and gives an overview of their function and contents.
3679 Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the 3660 Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the
3680 OpenEmbedded build system. The variable is defined appropriately by 3661 OpenEmbedded build system. The variable is defined appropriately by
3681 the :ref:`ref-classes-package_deb`, :ref:`ref-classes-package_rpm`, 3662 the :ref:`ref-classes-package_deb`, :ref:`ref-classes-package_rpm`,
3682 :ref:`ref-classes-package_ipk`, or :ref:`ref-classes-package_tar` class. 3663 or :ref:`ref-classes-package_ipk` class.
3683
3684 .. note::
3685
3686 The ``package_tar`` class is broken and is not supported. It is
3687 recommended that you do not use it.
3688 3664
3689 The :ref:`ref-classes-populate-sdk-*` and :ref:`ref-classes-image` 3665 The :ref:`ref-classes-populate-sdk-*` and :ref:`ref-classes-image`
3690 classes use the :term:`IMAGE_PKGTYPE` for packaging up images and SDKs. 3666 classes use the :term:`IMAGE_PKGTYPE` for packaging up images and SDKs.
@@ -5663,14 +5639,7 @@ system and gives an overview of their function and contents.
5663 You can provide one or more of the following arguments for the 5639 You can provide one or more of the following arguments for the
5664 variable:: 5640 variable::
5665 5641
5666 PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk package_tar" 5642 PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk"
5667
5668 .. note::
5669
5670 While it is a legal option, the :ref:`ref-classes-package_tar`
5671 class has limited functionality due to no support for package
5672 dependencies by that backend. Therefore, it is recommended that
5673 you do not use it.
5674 5643
5675 The build system uses only the first argument in the list as the 5644 The build system uses only the first argument in the list as the
5676 package manager when creating your image or SDK. However, packages 5645 package manager when creating your image or SDK. However, packages