diff mbox series

[1/2] doc: add a terms glossary and define "datastore"

Message ID 20261104-terms-doc-v1-1-0ded0b9e1623@bootlin.com
State New
Headers show
Series Add a terms glossary and define "datastore" | expand

Commit Message

Antonin Godard Nov. 4, 2026, 10:56 a.m. UTC 
The "datastore" term is used widely in the BitBake documentation with no
formal definition for it. Add a "BitBake Terms" section to store common
definitions which can be cross-referenced with :term:`...`, and define
Datastore.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 .../bitbake-user-manual-terms.rst                  | 25 ++++++++++++++++++++++
 doc/index.rst                                      |  1 +
 2 files changed, 26 insertions(+)
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-terms.rst b/doc/bitbake-user-manual/bitbake-user-manual-terms.rst
new file mode 100644
index 00000000000..697f0570ef7
--- /dev/null
+++ b/doc/bitbake-user-manual/bitbake-user-manual-terms.rst
@@ -0,0 +1,25 @@ 
+.. SPDX-License-Identifier: CC-BY-2.5
+
+*************
+BitBake Terms
+*************
+
+Below is a list of terms and definitions common to BitBake.
+
+.. glossary::
+
+   :term:`Datastore`
+      The datastore is a dictionary-like object represented by the ``DataSmart``
+      class in BitBake (in ``lib/bb/data_smart.py``) and contains the values of
+      variables under the current execution of BitBake. As explained in
+      :ref:`bitbake-user-manual/bitbake-user-manual-execution:Locating and
+      Parsing Recipes`, BitBake parses recipes, bbappends, and classes and
+      stores the values of various variables into the :term:`datastore`.
+
+      The datastore is available by default in recipes and classes under the
+      name ``d``.
+
+      The :term:`datastore` defines several helper functions to read, write or
+      manipulate BitBake variables, which are documented in the
+      :ref:`bitbake-user-manual/bitbake-user-manual-metadata:Functions for
+      Accessing Datastore Variables` section.
diff --git a/doc/index.rst b/doc/index.rst
index 9f2a9067d38..5dc0cd0ae5f 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -13,6 +13,7 @@  BitBake User Manual
    bitbake-user-manual/bitbake-user-manual-intro
    bitbake-user-manual/bitbake-user-manual-execution
    bitbake-user-manual/bitbake-user-manual-environment-setup
+   bitbake-user-manual/bitbake-user-manual-terms
    bitbake-user-manual/bitbake-user-manual-metadata
    bitbake-user-manual/bitbake-user-manual-ref-variables-context
    bitbake-user-manual/bitbake-user-manual-fetching