Skip to content

Commit e222b25

Browse files
committed
doc: document packageDepends property
1 parent a5fbe67 commit e222b25

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

doc/manual/configuration.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -548,15 +548,16 @@ a script for the same step are joined in front of this script in the order the
548548
inheritance is specified. The inheritance graph is traversed depth first and
549549
every class is included exactly once.
550550

551-
Dependencies of the recipe are by default only available to the
551+
Dependencies of the recipe are generally only available to the
552552
``buildScript``. The path to the previous step (checkout workspace for
553553
``buildScript``, build workspace for ``packageScript``) is always passed in
554554
``$1``. Other dependencies are available in the order in which they were
555555
declared at the :ref:`configuration-recipes-depends` section of the recipe. If
556556
a dependencies ``checkoutDep`` flag is set to ``True`` it will also be
557557
available to the ``checkoutScript``. This should be used carefully as it makes
558558
the checkout of the recipe sources dependent on the result of another
559-
dependency.
559+
dependency. Enabling the :ref:`configuration-recipes-packagedepends` property
560+
will make the dependencies available to the package step too.
560561

561562
During execution of the script only the environment variables SHELL, USER,
562563
TERM, HOME and anything that was declared via {checkout,build,package}Vars
@@ -1694,6 +1695,20 @@ packages that are built from a library: a ``-target`` packet that has the
16941695
shared libraries needed during runtime and a ``-dev`` packet that has the
16951696
header files and other needed files to link with this library.
16961697

1698+
.. _configuration-recipes-packagedepends:
1699+
1700+
packageDepends
1701+
~~~~~~~~~~~~~~
1702+
1703+
Type: Boolean
1704+
1705+
Defaults to ``False``. If enabled, all dependencies that are named in the
1706+
:ref:`configuration-recipes-depends` section are available during the package
1707+
step execution too. By default, just the build step has access to them.
1708+
1709+
Enabling this property is useful for recipes that only need a package script.
1710+
Typical examples are recipes that create images or that just gather packages.
1711+
16971712
.. _configuration-recipes-privateenv:
16981713

16991714
privateEnvironment

0 commit comments

Comments
 (0)