[PATCH] ref-manual: organize all recipes-* directories under subdirectory

[PATCH] ref-manual: organize all recipes-* directories under subdirectory

[Robert P. J. Day]

It's cumbersome to list all meta/recipes-* directories under the same
level as other meta/ directories, so place them under a recipes-*
higher-level directory.

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

---

diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index ff84b250b..fae0368b9 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -881,10 +881,17 @@ build process. It is enabled via the ``addpylib`` directive in
 ``meta/conf/local.conf``. For more information, see
 :ref:`bitbake-user-manual/bitbake-user-manual-metadata:extending python library code`.

+.. _structure-meta-recipes:
+
+``meta/recipes-*/``
+---------------------
+
+All of the "recipes-*" subdirectories define recipes broken into related sub-categories.
+
 .. _structure-meta-recipes-bsp:

 ``meta/recipes-bsp/``
----------------------
+~~~~~~~~~~~~~~~~~~~~~

 This directory contains anything linking to specific hardware or
 hardware configuration information such as "u-boot" and "grub".
@@ -892,7 +899,7 @@ hardware configuration information such as "u-boot" and "grub".
 .. _structure-meta-recipes-connectivity:

 ``meta/recipes-connectivity/``
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 This directory contains libraries and applications related to
 communication with other devices.
@@ -900,7 +907,7 @@ communication with other devices.
 .. _structure-meta-recipes-core:

 ``meta/recipes-core/``
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~

 This directory contains what is needed to build a basic working Linux
 image including commonly used dependencies.
@@ -908,7 +915,7 @@ image including commonly used dependencies.
 .. _structure-meta-recipes-devtools:

 ``meta/recipes-devtools/``
---------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~

 This directory contains tools that are primarily used by the build
 system. The tools, however, can also be used on targets.
@@ -916,7 +923,7 @@ system. The tools, however, can also be used on targets.
 .. _structure-meta-recipes-extended:

 ``meta/recipes-extended/``
---------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~

 This directory contains non-essential applications that add features
 compared to the alternatives in core. You might need this directory for
@@ -925,7 +932,7 @@ full tool functionality.
 .. _structure-meta-recipes-gnome:

 ``meta/recipes-gnome/``
------------------------
+~~~~~~~~~~~~~~~~~~~~~~~

 This directory contains all things related to the GTK+ application
 framework.
@@ -933,7 +940,7 @@ framework.
 .. _structure-meta-recipes-graphics:

 ``meta/recipes-graphics/``
---------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~

 This directory contains X and other graphically related system
 libraries.
@@ -941,7 +948,7 @@ libraries.
 .. _structure-meta-recipes-kernel:

 ``meta/recipes-kernel/``
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~

 This directory contains the kernel and generic applications and
 libraries that have strong kernel dependencies.
@@ -949,7 +956,7 @@ libraries that have strong kernel dependencies.
 .. _structure-meta-recipes-multimedia:

 ``meta/recipes-multimedia/``
-----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 This directory contains codecs and support utilities for audio, images
 and video.
@@ -957,7 +964,7 @@ and video.
 .. _structure-meta-recipes-rt:

 ``meta/recipes-rt/``
---------------------
+~~~~~~~~~~~~~~~~~~~~

 This directory contains package and image recipes for using and testing
 the ``PREEMPT_RT`` kernel.
@@ -965,7 +972,7 @@ the ``PREEMPT_RT`` kernel.
 .. _structure-meta-recipes-sato:

 ``meta/recipes-sato/``
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~

 This directory contains the Sato demo/reference UI/UX and its associated
 applications and configuration data.
@@ -973,7 +980,7 @@ applications and configuration data.
 .. _structure-meta-recipes-support:

 ``meta/recipes-support/``
--------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~

 This directory contains recipes used by other recipes, but that are not
 directly included in images (i.e. dependencies of other recipes).

Re: [docs] [PATCH] ref-manual: organize all recipes-* directories under subdirectory

[Antonin Godard]

Hi,

On Mon Jun 22, 2026 at 10:29 PM CEST, Robert P. J. Day wrote:
>
> It's cumbersome to list all meta/recipes-* directories under the same
> level as other meta/ directories, so place them under a recipes-*
> higher-level directory.

I disagree. I don't see the added value of this, and following this logic you'd
have to do this for conf/ as well. I think it would just add too many levels of
headers.

Antonin

Re: [docs] [PATCH] ref-manual: organize all recipes-* directories under subdirectory

[Robert P. J. Day]

On Thu, 25 Jun 2026, Antonin Godard via lists.yoctoproject.org wrote:

> Hi,
>
> On Mon Jun 22, 2026 at 10:29 PM CEST, Robert P. J. Day wrote:
> >
> > It's cumbersome to list all meta/recipes-* directories under the same
> > level as other meta/ directories, so place them under a recipes-*
> > higher-level directory.
>
> I disagree. I don't see the added value of this, and following this
> logic you'd have to do this for conf/ as well. I think it would just
> add too many levels of headers.

  yeah, i rethought that and you're right. toss it.

rday