diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-01-18 19:11:14 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-02-03 13:47:50 +0000 |
commit | 3a6185404e241790bd17cb563e33eec4a0a9296a (patch) | |
tree | f7d1b86f5f2b82631491d6ae5f295c948d296e69 /documentation/ref-manual/structure.rst | |
parent | a9fdd010b9382c05a0fd5aefb14280dc125f1808 (diff) | |
download | poky-3a6185404e241790bd17cb563e33eec4a0a9296a.tar.gz |
manuals: improve references to classes
- Simplify references to class sections, by replacing references such as
:ref:`image.bbclass <ref-classes-image>`
by
:ref:`ref-classes-image`
That's equivalent, because the class sections always called <class>.bbclass
- Adding references to class sections, by replacing strings such as
``image.bbclass``
by
:ref:`ref-classes-image`
- Simplifying a few class section links
(From yocto-docs rev: 29d66aaa898390c19f121baf0f4fdcc178e4cd80)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.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 | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 5d2e3a86ef..262b041ea6 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -667,16 +667,17 @@ Yocto Project. Metadata has several important subdivisions: | |||
667 | 667 | ||
668 | This directory contains the ``*.bbclass`` files. Class files are used to | 668 | This directory contains the ``*.bbclass`` files. Class files are used to |
669 | abstract common code so it can be reused by multiple packages. Every | 669 | abstract common code so it can be reused by multiple packages. Every |
670 | package inherits the ``base.bbclass`` file. Examples of other important | 670 | package inherits the :ref:`ref-classes-base` file. Examples of other important |
671 | classes are ``autotools.bbclass``, which in theory allows any | 671 | classes are :ref:`ref-classes-autotools`, which in theory allows any |
672 | Autotool-enabled package to work with the Yocto Project with minimal | 672 | Autotool-enabled package to work with the Yocto Project with minimal |
673 | effort. Another example is ``kernel.bbclass`` that contains common code | 673 | effort. Another example is :ref:`ref-classes-kernel` that contains common code |
674 | and functions for working with the Linux kernel. Functions like image | 674 | and functions for working with the Linux kernel. Functions like image |
675 | generation or packaging also have their specific class files such as | 675 | generation or packaging also have their specific class files such as |
676 | ``image.bbclass``, ``rootfs_*.bbclass`` and ``package*.bbclass``. | 676 | :ref:`ref-classes-image`, :ref:`ref-classes-rootfs*` and |
677 | :ref:`package*.bbclass <ref-classes-package>`. | ||
677 | 678 | ||
678 | For reference information on classes, see the | 679 | For reference information on classes, see the |
679 | ":ref:`ref-manual/classes:Classes`" chapter. | 680 | ":doc:`/ref-manual/classes`" chapter. |
680 | 681 | ||
681 | .. _structure-meta-conf: | 682 | .. _structure-meta-conf: |
682 | 683 | ||