From mboxrd@z Thu Jan 1 00:00:00 1970 Delivery-date: Thu, 08 Aug 2024 11:40:50 +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.96) (envelope-from ) id 1sbzda-007S1t-1E for lore@lore.pengutronix.de; Thu, 08 Aug 2024 11:40:50 +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 1sbzdZ-0008Ud-UN; Thu, 08 Aug 2024 11:40:49 +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 1sbzdR-0008Ti-2x; Thu, 08 Aug 2024 11:40:41 +0200 Received: from [2a0a:edc0:0:1101:1d::ac] (helo=dude04.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 1sbzdQ-005Oa5-Ld; Thu, 08 Aug 2024 11:40:40 +0200 Received: from rhi by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1sbzdQ-006sbZ-20; Thu, 08 Aug 2024 11:40:40 +0200 From: Roland Hieber To: ptxdist@pengutronix.de Date: Thu, 8 Aug 2024 11:40:32 +0200 Message-Id: <20240808094035.1636229-1-rhi@pengutronix.de> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 Mail-Followup-To: Roland Hieber , ptxdist@pengutronix.de Content-Transfer-Encoding: 8bit Subject: [ptxdist] [PATCH 1/4] doc: ref_make_macros: improve world/image-clean documentation 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 Improve the phrasing that the default clean stage already calls world/image-clean, then order the macros alphabetically like in the section header as well as the order in which they are usually called. Signed-off-by: Roland Hieber --- doc/ref_make_macros.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/ref_make_macros.rst b/doc/ref_make_macros.rst index fe300c45757a..a81d54961298 100644 --- a/doc/ref_make_macros.rst +++ b/doc/ref_make_macros.rst @@ -155,19 +155,15 @@ Usage: .. code-block:: none - @$(call world/image-clean, ) @$(call ptx/image-install, , $(_BUILD_DIR)/[, ]) @$(call ptx/image-install-link, , , ) + @$(call world/image-clean, ) These macros are used to install files to ``|ptxdistPlatformDir|/images``. They are only allowed in the *targetinstall* stage. They are used by packages that produce files that are not part of a filesystem. Bootloaders are typical packages that do this. -``world/image-clean`` will remove the files that were created by the other -two macros in a previous run of the *targetinstall* stage. This also -happens implicitly when the package is cleaned. - ``ptx/image-install`` copies a file. The source must be an absolute path. The destination must be relative to the image directory. If the destination file name is the source file without the path, then this argument can be @@ -175,6 +171,10 @@ omitted. ``ptx/image-install-link`` creates a symlink in the image directory. +``world/image-clean`` will remove the files that were created by the other +two macros in a previous run of the *targetinstall* stage. This macro is also +called automatically by PTXdist's default *clean* stage. + .. _world_image_fit: world/image-fit -- 2.39.2