Re: [docs] [PATCH v4] classes.rst variables.rst: add documentation for uki.bbclass

[Mikko Rapeli <mikko.rapeli@linaro.org>]

Hi,

On Wed, Nov 27, 2024 at 02:52:20PM +0100, Antonin Godard wrote:
> Hi Mikko,
> 
> On Wed Nov 27, 2024 at 12:20 PM CET, Mikko Rapeli via lists.yoctoproject.org wrote:
> > Documentation for the new class.
> >
> > [YOCTO #15650]
> > https://bugzilla.yoctoproject.org/show_bug.cgi?id=15650
> >
> > Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
> > ---
> >  documentation/ref-manual/classes.rst   | 50 ++++++++++++++++++++++++++
> >  documentation/ref-manual/variables.rst | 42 ++++++++++++++++++++++
> >  2 files changed, 92 insertions(+)
> >
> > diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> > index b92f4e4f20..ad22511b4d 100644
> > --- a/documentation/ref-manual/classes.rst
> > +++ b/documentation/ref-manual/classes.rst
> > @@ -3345,6 +3345,56 @@ and the `signature process
> >  See also the description of :ref:`ref-classes-kernel-fitimage` class, which this class
> >  imitates.
> >  
> > +.. _ref-classes-uki:
> > +
> > +``uki``
> > +=======
> > +
> > +The :ref:`ref-classes-uki` class provides support for `Unified Kernel Image
> > +(UKI) <https://uapi-group.org/specifications/specs/unified_kernel_image/>`__
> > +format. UKIs combine kernel, :term:`Initramfs`, signatures, metadata etc to a
> > +single UEFI firmware compatible binary. The class is intended to be inherited
> > +by rootfs image recipes. The build configuration should also use an
> > +:term:`Initramfs, ``systemd-boot`` as boot menu provider and have UEFI support
> 
> There's a missing backtick after Initramfs here, which prompts an error message.

Oops, will fix in v5.

Cheers,

-Mikko