Message ID | 20230623080603.3249960-1-luca.ceresoli@bootlin.com |
---|---|
State | New |
Headers | show |
Series | ref-manual: classes: devicetree: fix sentence saying the same thing twice | expand |
Luca, Quentin, Thanks for the correction and review! On 23.06.23 at 10:06, Luca Ceresoli via lists.yoctoproject.org wrote: > From: Luca Ceresoli <luca.ceresoli@bootlin.com> > > This sentence was originally written based on the comments in the .bbclass > file, but further editing led to saying the same thing twice. Remove the > duplication and also reword it to make it generally better. > > Fixes: f65816f5ea62 ("ref-manual: classes.rst: document devicetree.bbclass") > Reported-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> > Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> > --- > documentation/ref-manual/classes.rst | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > > diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst > index 11e70006e5ac..e555a80b5af9 100644 > --- a/documentation/ref-manual/classes.rst > +++ b/documentation/ref-manual/classes.rst > @@ -600,12 +600,12 @@ The :ref:`ref-tasks-compile` task will compile two kinds of files: > - Device tree overlays, detected from the presence of the ``/plugin/;`` > string in the file contents. > > -This class behaves in a similar way as the :ref:`ref-classes-kernel-devicetree` > -class, also deploying output files into ``/boot/devicetree``. However, this > -class stores the deployed device tree binaries into the ``devicetree`` > -subdirectory. This avoids clashes with the :ref:`ref-classes-kernel-devicetree` > -output. Additionally, the device trees are populated into the sysroot for > -access via the sysroot from within other recipes. > +This class deploys the generated device tree binaries into > +``${``\ :term:`DEPLOY_DIR_IMAGE`\ ``}/devicetree/``. This is similar to > +what the :ref:`ref-classes-kernel-devicetree` class does, with the added > +``devicetree`` subdirectory to avoid name clashes. Additionally, the device > +trees are populated into the sysroot for access via the sysroot from within > +other recipes. > > By default, all device tree sources located in :term:`DT_FILES_PATH` directory > are compiled. To select only particular sources, set :term:`DT_FILES` to Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> ... and merged into "master-next" (for my own convenience). Not too late for further changes and reviews :) Thanks again Michael.
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 11e70006e5ac..e555a80b5af9 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -600,12 +600,12 @@ The :ref:`ref-tasks-compile` task will compile two kinds of files: - Device tree overlays, detected from the presence of the ``/plugin/;`` string in the file contents. -This class behaves in a similar way as the :ref:`ref-classes-kernel-devicetree` -class, also deploying output files into ``/boot/devicetree``. However, this -class stores the deployed device tree binaries into the ``devicetree`` -subdirectory. This avoids clashes with the :ref:`ref-classes-kernel-devicetree` -output. Additionally, the device trees are populated into the sysroot for -access via the sysroot from within other recipes. +This class deploys the generated device tree binaries into +``${``\ :term:`DEPLOY_DIR_IMAGE`\ ``}/devicetree/``. This is similar to +what the :ref:`ref-classes-kernel-devicetree` class does, with the added +``devicetree`` subdirectory to avoid name clashes. Additionally, the device +trees are populated into the sysroot for access via the sysroot from within +other recipes. By default, all device tree sources located in :term:`DT_FILES_PATH` directory are compiled. To select only particular sources, set :term:`DT_FILES` to