diff mbox series

[3/3] doc: document bb-local-conf-header and bb-target

Message ID 20260320150312.1243270-4-zhangfei.gao@linaro.org
State New
Headers show
Series bitbake-setup: config-driven local.conf, default target and docs | expand

Commit Message

Zhangfei Gao March 20, 2026, 3:03 p.m. UTC 
Describe two optional bitbake-setup configuration keys in the user
manual:
- bb-local-conf-header
- bb-target

Include behavior notes and a minimal JSON example for local.conf
injection and setupdir/build-target usage.

Signed-off-by: Zhangfei Gao <zhangfei.gao@linaro.org>
---
 .../bitbake-user-manual-environment-setup.rst | 23 +++++++++++++++++++
 1 file changed, 23 insertions(+)
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
index f7580c8e0..fc9ab12ac 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-environment-setup.rst
@@ -847,6 +847,29 @@  They contain the following sections:
    -  ``bb-env-passthrough-additions`` (*optional*): List of environment
       variables to include in :term:`BB_ENV_PASSTHROUGH_ADDITIONS`.
 
+   -  ``bb-local-conf-header`` (*optional*): Local configuration lines to
+      append into ``build/conf/local.conf`` during :ref:`ref-bbsetup-command-init`.
+
+      This can be either a single string or a list of strings.
+
+      Example::
+
+         {
+            ...
+            "bb-local-conf-header": [
+               "MACHINE ?= "qemux86-64"",
+               "DISTRO ?= "poky""
+            ],
+            ...
+         }
+
+   -  ``bb-target`` (*optional*): Default bitbake target to
+      use for the generated ``build-target`` helper in a :term:`Setup`.
+
+      If this key is present, bitbake-setup generates a ``build-target`` script
+      in the setup directory. Running ``./build-target`` uses this default
+      target. Passing arguments to ``./build-target`` overrides the default.
+
    -  ``bb-layers`` (*optional*): List of layers to add to the ``bblayers.conf``
       file. Paths in this list are relative to the ``layers/`` directory of a
       :term:`Setup`.