diff mbox series

[1/8] doc: bitbake-user-manual-metadata: list (in order) all sharing directives

Message ID 20260112-doc-directives-v1-1-b23923cfce89@cherry.de
State New
Headers show
Series doc: bitbake-user-manual-metadata: misc improvements on sharing functionality | expand

Commit Message

Quentin Schulz Jan. 12, 2026, 4:36 p.m. UTC 
From: Quentin Schulz <quentin.schulz@cherry.de>

The Sharing Functionality section has multiple subsections each
representing a way to share code.

Let's list all directives listed in the subsections (we were missing
inherit_defer and include_all) and provide a link for each subsection.

This also fixes the link to INHERIT to point to the subsection where it
is explained instead of to the variable glossary.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index ef401d4ab..0c5466943 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -753,7 +753,12 @@  share the task.
 
 This section presents the mechanisms BitBake provides to allow you to
 share functionality between recipes. Specifically, the mechanisms
-include ``include``, ``inherit``, :term:`INHERIT`, and ``require``
+include :ref:`inherit<ref-bitbake-user-manual-metadata-inherit>`,
+:ref:`inherit_defer<ref-bitbake-user-manual-metadata-inherit-defer>`,
+:ref:`include<ref-include-directive>`,
+:ref:`include_all<ref-include-all-directive>`,
+:ref:`require<require-inclusion>` and
+:ref:`INHERIT<bitbake-user-manual/bitbake-user-manual-metadata:\`\`INHERIT\`\` configuration directive>`
 directives. There is also a higher-level abstraction called
 ``configuration fragments`` that is enabled with ``addfragments``
 directive.