diff mbox series

ref-manual: warn reader about confusing DEPLOYDIR and DEPLOY_DIR

Message ID 26faff6a-a213-9eac-e244-7aef097a9f33@crashcourse.ca
State New
Headers show
Series ref-manual: warn reader about confusing DEPLOYDIR and DEPLOY_DIR | expand

Commit Message

Robert P. J. Day June 26, 2026, 4:28 p.m. UTC 
Add a couple warnings about mistaking the variables DEPLOYDIR and
DEPLOY_DIR for one another.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index b4c6bc957..cd88a20e0 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2276,6 +2276,11 @@  system and gives an overview of their function and contents.
       ":ref:`overview-manual/concepts:application development sdk`" sections all in the
       Yocto Project Overview and Concepts Manual.

+      .. warning::
+
+         Do not confuse this variable with the similarly-named
+         :term:`DEPLOYDIR` variable.
+
    :term:`DEPLOY_DIR_DEB`
       Points to the area that the OpenEmbedded build system uses to place
       Debian packages that are ready to be used outside of the build
@@ -2366,6 +2371,11 @@  system and gives an overview of their function and contents.
       them into :term:`DEPLOY_DIR_IMAGE`
       afterwards.

+      .. warning::
+
+         Do not confuse this variable with the similarly-named
+         :term:`DEPLOY_DIR` variable.
+
    :term:`DESCRIPTION`
       The package description used by package managers. If not set,
       :term:`DESCRIPTION` takes the value of the :term:`SUMMARY`