summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2024-05-23 15:39:27 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-05-29 20:58:49 +0100
commitc3d154813b4f8ed573750263ffdc79a15c646c9e (patch)
treec30c8c605562d07c8c6663971e28049e38fc3430 /documentation
parent90e510aee75bcbc95bdb3de25440786f27987604 (diff)
downloadpoky-c3d154813b4f8ed573750263ffdc79a15c646c9e.tar.gz
ref-manual: introduce UNPACKDIR variable
Note that this doesn't touch the "Source Fetching" section in overview-manual/concepts.rst yet, as the unpack implementation may not be finalized yet. (From yocto-docs rev: 2c892663c3e2d72493ee29898e99335a1e45c01f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Andrew Murray <amurray@thegoodpenguin.co.uk> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/tasks.rst9
-rw-r--r--documentation/ref-manual/variables.rst5
2 files changed, 9 insertions, 5 deletions
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 2e4b23408d..df751d75a3 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -412,12 +412,11 @@ them. You can learn more by looking at the
412------------- 412-------------
413 413
414Unpacks the source code into a working directory pointed to by 414Unpacks the source code into a working directory pointed to by
415``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` 415``${``\ :term:`UNPACKDIR`\ ``}``. A legacy way to specify
416variable also plays a role in where unpacked source files ultimately 416this directory is through the :term:`S` and :term:`WORKDIR` variables.
417reside. For more information on how source files are unpacked, see the 417For more information on how source files are unpacked, see the
418":ref:`overview-manual/concepts:source fetching`" 418":ref:`overview-manual/concepts:source fetching`"
419section in the Yocto Project Overview and Concepts Manual and also see 419section in the Yocto Project Overview and Concepts Manual.
420the :term:`WORKDIR` and :term:`S` variable descriptions.
421 420
422Manually Called Tasks 421Manually Called Tasks
423===================== 422=====================
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 546c674699..07b5b6f95c 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -9698,6 +9698,11 @@ system and gives an overview of their function and contents.
9698 :ref:`ref-classes-insane` class and is only enabled if the 9698 :ref:`ref-classes-insane` class and is only enabled if the
9699 recipe inherits the :ref:`ref-classes-autotools` class. 9699 recipe inherits the :ref:`ref-classes-autotools` class.
9700 9700
9701 :term:`UNPACKDIR`
9702 This variable, used by the :ref:`ref-classes-base` class,
9703 specifies where fetches sources should be unpacked by the
9704 :ref:`ref-tasks-unpack` task.
9705
9701 :term:`UPDATERCPN` 9706 :term:`UPDATERCPN`
9702 For recipes inheriting the 9707 For recipes inheriting the
9703 :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN` 9708 :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN`