| Message ID | c5f80e07-16fe-d9fa-b3e5-a8a6b1506278@crashcourse.ca |
|---|---|
| State | New |
| Headers | show |
| Series | [v2] Mention existence of three supported "classes" directories | expand |
Hi Robert, On 7/8/25 1:33 PM, Robert P. J. Day via lists.yoctoproject.org wrote: > > Early in Section 1, mention that BitBake supports three related > classes directories. > > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> > > --- > > fix typo in first submission > > diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst > index 539bb62d8..d25f07ff9 100644 > --- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst > +++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst > @@ -206,6 +206,18 @@ installing (empty by default) and packaging (empty by default). These > tasks are often overridden or extended by other classes added during the > project development process. > > +.. note:: > + > + While BitBake comes with just the one ``base.bbclass`` file in the > + ``classes`` directory, it supports class files also being installed > + in related directories ``classes-global`` and ``classes-recipe`` and > + will automatically search all three directories for a selected class > + file. > + > + This means that, in this documentation, when you see a reference to > + class files being in the ``classes`` directory, you can interpret that > + as meaning in any one of the above three directories. > + Maybe we can say a few words on when one is supposed to put a class in classes-recipe, classes-global or classes directory? Using the wording from YP docs, documentation/ref-manual/classes.rst probably is good enough? Cheers, Quentin
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst index 539bb62d8..d25f07ff9 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst @@ -206,6 +206,18 @@ installing (empty by default) and packaging (empty by default). These tasks are often overridden or extended by other classes added during the project development process. +.. note:: + + While BitBake comes with just the one ``base.bbclass`` file in the + ``classes`` directory, it supports class files also being installed + in related directories ``classes-global`` and ``classes-recipe`` and + will automatically search all three directories for a selected class + file. + + This means that, in this documentation, when you see a reference to + class files being in the ``classes`` directory, you can interpret that + as meaning in any one of the above three directories. + Layers ------
Early in Section 1, mention that BitBake supports three related classes directories. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> --- fix typo in first submission