diff mbox series

[3/3] variables.rst: Add USERADD_DEPENDS

Message ID 1943d053c1276a7ad940f67868aaa9d4c59397bc.1701952927.git.pidge@baylibre.com
State New
Headers show
Series useradd fixes, tests and documentation | expand

Commit Message

Eilís 'pidge' Ní Fhlannagáin Dec. 7, 2023, 12:45 p.m. UTC 
Adding USERADD_DEPENDS to the variables document

Signed-off-by: Eilís 'pidge' Ní Fhlannagáin <pidge@baylibre.com>
---
 documentation/ref-manual/variables.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index b394d310990..9ec0ce4b4ca 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -9736,6 +9736,21 @@  system and gives an overview of their function and contents.
       ``meta-poky/conf/templates/default/local.conf.sample`` in the
       :term:`Source Directory`.
 
+   :term:`USERADD_DEPENDS`
+      Lists a recipe's USERADD dependencies. These are dependencies on
+      other recipes whose create users and groups via useradd.bbclass and are
+      needed by the recipe at build time. This variable is now required for
+      recipes that rely on other recipes for part of their useradd.
+      
+      As an example, consider a recipe ``foo``. Recipe ``bar`` creates a group
+      that foo requires for it's useradd tasks. In order to ensure that the
+      useradd tasks exist for foo, we add the the following assignment::
+
+          $USERADD_DEPENDS = "bar"
+
+      The practical effect of this assignment is that bar's sysroot_setscene is
+      added to :term:`USERADDSETSCENEDEPS` variable.
+
    :term:`USERADD_ERROR_DYNAMIC`
       If set to ``error``, forces the OpenEmbedded build system to produce
       an error if the user identification (``uid``) and group