From mboxrd@z Thu Jan 1 00:00:00 1970 Delivery-date: Tue, 22 Aug 2023 14:13:24 +0200 Received: from metis.ext.pengutronix.de ([2001:67c:670:201:290:27ff:fe1d:cc33]) 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 1qYQGD-004kgP-6x for lore@lore.pengutronix.de; Tue, 22 Aug 2023 14:13:24 +0200 Received: from localhost ([127.0.0.1] helo=metis.ext.pengutronix.de) by metis.ext.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1qYQGA-0002fb-88; Tue, 22 Aug 2023 14:13:22 +0200 Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.ext.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qYQFQ-0002X2-Og; Tue, 22 Aug 2023 14:12:36 +0200 Received: from [2a0a:edc0:0:1101:1d::ac] (helo=dude04.red.stw.pengutronix.de) by drehscheibe.grey.stw.pengutronix.de with esmtp (Exim 4.94.2) (envelope-from ) id 1qYQFQ-000oAI-4y; Tue, 22 Aug 2023 14:12:36 +0200 Received: from rhi by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1qYQFP-008cQ2-29; Tue, 22 Aug 2023 14:12:35 +0200 From: Roland Hieber To: ptxdist@pengutronix.de Date: Tue, 22 Aug 2023 14:12:34 +0200 Message-Id: <20230822121234.2040303-3-rhi@pengutronix.de> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230822121234.2040303-1-rhi@pengutronix.de> References: <20230822121234.2040303-1-rhi@pengutronix.de> MIME-Version: 1.0 Mail-Followup-To: Roland Hieber , ptxdist@pengutronix.de Content-Transfer-Encoding: 8bit Subject: [ptxdist] [PATCH 3/3] 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.ext.pengutronix.de); SAEximRunCond expanded to false Signed-off-by: Roland Hieber --- doc/ref_make_macros.rst | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) 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 -- 2.39.2