mbox series

[0/8] doc: bitbake-user-manual-metadata: misc improvements on sharing functionality

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

Message

Quentin Schulz Jan. 12, 2026, 4:36 p.m. UTC
This expands on the include_all directive by providing an example and
highlighting the difference with the include directive.

It fixes some highlighting and cross-referencing inconsistencies as well
as the wrong path in the examples.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
Quentin Schulz (8):
      doc: bitbake-user-manual-metadata: list (in order) all sharing directives
      doc: bitbake-user-manual-metadata: highlight configuration fragment differently
      doc: bitbake-user-manual-metadata: use a cross-reference for addfragments
      doc: bitbake-user-manual-metadata: specify that current dir won't be searched for include_all
      doc: bitbake-user-manual-metadata: add missing highlight for BBPATH and PATH
      doc: bitbake-user-manual-metadata: fix incorrect path in example for locating files
      doc: bitbake-user-manual-metadata: expand on search paths for include directive
      doc: bitbake-user-manual-metadata: expand locating files example for include_all directive

 .../bitbake-user-manual-metadata.rst               | 65 ++++++++++++++++++----
 1 file changed, 54 insertions(+), 11 deletions(-)
---
base-commit: f23e186a75e71ba885b9b53a1dfda99af29c67b0
change-id: 20260112-doc-directives-6e42bc047525

Best regards,

Comments

Antonin Godard Jan. 13, 2026, 9:37 a.m. UTC | #1
On Mon Jan 12, 2026 at 5:36 PM CET, Quentin Schulz wrote:
> This expands on the include_all directive by providing an example and
> highlighting the difference with the include directive.
>
> It fixes some highlighting and cross-referencing inconsistencies as well
> as the wrong path in the examples.
>
> Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
> ---
> Quentin Schulz (8):
>       doc: bitbake-user-manual-metadata: list (in order) all sharing directives
>       doc: bitbake-user-manual-metadata: highlight configuration fragment differently
>       doc: bitbake-user-manual-metadata: use a cross-reference for addfragments
>       doc: bitbake-user-manual-metadata: specify that current dir won't be searched for include_all
>       doc: bitbake-user-manual-metadata: add missing highlight for BBPATH and PATH
>       doc: bitbake-user-manual-metadata: fix incorrect path in example for locating files
>       doc: bitbake-user-manual-metadata: expand on search paths for include directive
>       doc: bitbake-user-manual-metadata: expand locating files example for include_all directive
>
>  .../bitbake-user-manual-metadata.rst               | 65 ++++++++++++++++++----
>  1 file changed, 54 insertions(+), 11 deletions(-)
> ---
> base-commit: f23e186a75e71ba885b9b53a1dfda99af29c67b0
> change-id: 20260112-doc-directives-6e42bc047525
>
> Best regards,

Great improvements over what I wrote a while back! I'm glad we have a detailed
explanation on all of these directives now.

Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>

Thanks!
Antonin