From mboxrd@z Thu Jan 1 00:00:00 1970 Delivery-date: Sun, 24 Sep 2023 07:44:51 +0200 Received: from metis.whiteo.stw.pengutronix.de ([2a0a:edc0:2:b01:1d::104]) by lore.white.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1qkHvI-008zlc-U7 for lore@lore.pengutronix.de; Sun, 24 Sep 2023 07:44:51 +0200 Received: from localhost ([127.0.0.1] helo=metis.whiteo.stw.pengutronix.de) by metis.whiteo.stw.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1qkHvG-00072z-8B; Sun, 24 Sep 2023 07:44:50 +0200 Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qkHua-0006YY-IE; Sun, 24 Sep 2023 07:44:08 +0200 Received: from [2a0a:edc0:0:1101:1d::54] (helo=dude05.red.stw.pengutronix.de) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1qkHua-008ZDw-65; Sun, 24 Sep 2023 07:44:08 +0200 Received: from mol by dude05.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1qkHua-000VYP-0T; Sun, 24 Sep 2023 07:44:08 +0200 From: Michael Olbrich To: ptxdist@pengutronix.de Date: Sun, 24 Sep 2023 07:44:08 +0200 Message-Id: <20230924054408.121286-1-m.olbrich@pengutronix.de> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230912165759.3492269-3-rhi@pengutronix.de> References: <20230912165759.3492269-3-rhi@pengutronix.de> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: Re: [ptxdist] [APPLIED] doc: ref_make_macros: document world/image-fit macro X-BeenThere: ptxdist@pengutronix.de X-Mailman-Version: 2.1.29 Precedence: list List-Id: PTXdist Development Mailing List List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: ptxdist@pengutronix.de Cc: Roland Hieber Sender: "ptxdist" X-SA-Exim-Connect-IP: 127.0.0.1 X-SA-Exim-Mail-From: ptxdist-bounces@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false Thanks, applied as bf4292a7b34731ab8fb45a316c6a2215ddef26aa. Michael [sent from post-receive hook] On Sun, 24 Sep 2023 07:44:08 +0200, Roland Hieber wrote: > Signed-off-by: Roland Hieber > Message-Id: <20230912165759.3492269-3-rhi@pengutronix.de> > Signed-off-by: Michael Olbrich > > diff --git a/doc/ref_make_macros.rst b/doc/ref_make_macros.rst > index b8cfe9eff644..fe300c45757a 100644 > --- a/doc/ref_make_macros.rst > +++ b/doc/ref_make_macros.rst > @@ -175,6 +175,44 @@ omitted. > > ``ptx/image-install-link`` creates a symlink in the image directory. > > +.. _world_image_fit: > + > +world/image-fit > +~~~~~~~~~~~~~~~ > + > +.. code-block:: none > + > + @$(call world/image-fit, ) > + > +Build a FIT image containing a kernel, optionally an initial ramdisk, and one or > +multiple device trees. For each device tree, a configuration node is generated. > + > +.. note:: You can generate a template for a new FIT image recipe by > + calling ``ptxdist newpackage image-fit``. > + > +The following variables are respected: > + > +``_IMAGE`` > + The output file, usually something like ``$(IMAGEDIR)/pkg.fit``. > + > +``_KERNEL`` > + The kernel image to package into the FIT image. > + > +``_DTB`` > + One or more device trees that should be included in the FIT image. > + > +``_INITRAMFS`` > + If the FIT image should contain an initial ramdisk, this variable determines > + the initrd file name that is included. Otherwise it can be left empty. > + > +``_SIGN_ROLE`` > + If the FIT image should be signed, this variable determines the role name > + used for the signature. It is passed to :ref:`cs_get_uri`. > + > +``_KEY_NAME_HINT`` > + If the FIT image should be signed, this variable determines the > + *key-name-hint* property of the signature node. > + > .. _install_copy: > > install_copy