diff options
author | Paul Eggleton <paul.eggleton@microsoft.com> | 2022-10-09 16:44:31 +1300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-10-19 17:32:57 +0100 |
commit | b1d17778658275a7757419f53bd47ed3906d50b2 (patch) | |
tree | e8098b8c308feb668dc83138ada8c40e6b1de046 /documentation/ref-manual/structure.rst | |
parent | c29eb10e31809a523109d638b80175d68dfc9930 (diff) | |
download | poky-b1d17778658275a7757419f53bd47ed3906d50b2.tar.gz |
Update documentation for classes split
* Make reference to meta/classes* instead of just meta/classes
* Update each reference to the path where the class has moved
* Add a brief explanation to the classes reference explaining the split
* Add a note to INHERIT, INHERIT_DISTRO, IMAGE_CLASSES and USER_CLASSES
variable glossary entries mentioning where the specified classes must
be located. I contemplated adding the same note to PACKAGE_CLASSES
but decided against it, as it has a very specific usage and such a
note might distract from the narrative of that entry.
* Also trim the IMAGE_CLASSES entry which was quite outdated.
* INHERIT += no longer works with testimage so drop the note about that
(From yocto-docs rev: e76bed00b452d3049f6c22afbfb980b557a141bd)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/structure.rst')
-rw-r--r-- | documentation/ref-manual/structure.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 533745b370..fe27d17caa 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -669,10 +669,10 @@ Yocto Project. Metadata has several important subdivisions: | |||
669 | 669 | ||
670 | .. _structure-meta-classes: | 670 | .. _structure-meta-classes: |
671 | 671 | ||
672 | ``meta/classes/`` | 672 | ``meta/classes*/`` |
673 | ----------------- | 673 | ------------------ |
674 | 674 | ||
675 | This directory contains the ``*.bbclass`` files. Class files are used to | 675 | These directories contain the ``*.bbclass`` files. Class files are used to |
676 | abstract common code so it can be reused by multiple packages. Every | 676 | abstract common code so it can be reused by multiple packages. Every |
677 | package inherits the :ref:`ref-classes-base` file. Examples of other important | 677 | package inherits the :ref:`ref-classes-base` file. Examples of other important |
678 | classes are :ref:`ref-classes-autotools`, which in theory allows any | 678 | classes are :ref:`ref-classes-autotools`, which in theory allows any |