| Message ID | 20240523073938.2135-2-marcus.folkesson@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | [1/2] image-bootfiles.bbclass: new class, copy boot files to /boot on rfs | expand |
Hi Marcus Thanks for the documentation patch! On 5/23/24 at 13:09, Marcus Folkesson wrote: > Describe the newly introduced image-bootfiles class. > > Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com> > --- > documentation/ref-manual/classes.rst | 14 ++++++++++++++ > 1 file changed, 14 insertions(+) > > diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst > index 9520d0bf7c..53b3697bee 100644 > --- a/documentation/ref-manual/classes.rst > +++ b/documentation/ref-manual/classes.rst > @@ -1169,6 +1169,20 @@ Yocto Project Overview and Concepts Manual. > > .. _ref-classes-image-buildinfo: > > +``image-bootfiles`` > +=================== > + > +The :ref:`ref-classes-image-buildinfo` class copies over files listed > +in :ref:`IMAGE_BOOT_FILES` to the /boot directory of the root filesystem. > + > +This can be useful if no separate boot partition is used but all boot files > +should be included into the rootfs image. > + > +:ref:`IMAGE_BOOT_FILES` is the same space-separated list of files used > +by the ``bootimg-partition`` source plugin to populate the boot partition. > + > +.. _ref-classes-image_types: > + > ``image-buildinfo`` > =================== There are issues though... cd documentation make html reading sources... [100%] releases /home/mike/work/git/git.yoctoproject.org/yocto-docs/documentation/ref-manual/classes.rst:1206: WARNING: Duplicate explicit target name: "ref-classes-image_types". looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done /home/mike/work/git/git.yoctoproject.org/yocto-docs/documentation/ref-manual/classes.rst:1175: WARNING: undefined label: 'image_boot_files' /home/mike/work/git/git.yoctoproject.org/yocto-docs/documentation/ref-manual/classes.rst:1181: WARNING: undefined label: 'image_boot_files' /home/mike/work/git/git.yoctoproject.org/yocto-docs/documentation/ref-manual/classes.rst:1211: WARNING: undefined label: 'ref-classes-image_types' /home/mike/work/git/git.yoctoproject.org/yocto-docs/documentation/ref-manual/classes.rst:1217: WARNING: undefined label: 'ref-classes-image_types' /home/mike/work/git/git.yoctoproject.org/yocto-docs/documentation/ref-manual/classes.rst:1234: WARNING: undefined label: 'ref-classes-image_types' You should actually add the new class documentation before " .. _ref-classes-image-buildinfo:" and have your own ".. _ref-classes-image-bootfiles" definition. Thanks in advance. You may wait for your class to be merged before submitting a V2 of the documentation (though early documentation is always useful!), as I won't be able to merge the documentation changes before this happens. Thanks again, Michael.
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 9520d0bf7c..53b3697bee 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -1169,6 +1169,20 @@ Yocto Project Overview and Concepts Manual. .. _ref-classes-image-buildinfo: +``image-bootfiles`` +=================== + +The :ref:`ref-classes-image-buildinfo` class copies over files listed +in :ref:`IMAGE_BOOT_FILES` to the /boot directory of the root filesystem. + +This can be useful if no separate boot partition is used but all boot files +should be included into the rootfs image. + +:ref:`IMAGE_BOOT_FILES` is the same space-separated list of files used +by the ``bootimg-partition`` source plugin to populate the boot partition. + +.. _ref-classes-image_types: + ``image-buildinfo`` ===================
Describe the newly introduced image-bootfiles class. Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com> --- documentation/ref-manual/classes.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+)