mailarchive of the ptxdist mailing list
 help / color / mirror / Atom feed
From: Roland Hieber <rhi@pengutronix.de>
To: ptxdist@pengutronix.de
Cc: Roland Hieber <rhi@pengutronix.de>
Subject: [ptxdist] [PATCH 1/4] doc: ref_make_macros: improve world/image-clean documentation
Date: Thu,  8 Aug 2024 11:40:32 +0200	[thread overview]
Message-ID: <20240808094035.1636229-1-rhi@pengutronix.de> (raw)

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 <rhi@pengutronix.de>
---
 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, <PKG>)
  @$(call ptx/image-install, <PKG>, $(<PKG>_BUILD_DIR)/<source-image-name>[, <image-name>])
  @$(call ptx/image-install-link, <PKG>, <link-target>, <link-name>)
+ @$(call world/image-clean, <PKG>)
 
 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




             reply	other threads:[~2024-08-08  9:40 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-08  9:40 Roland Hieber [this message]
2024-08-08  9:40 ` [ptxdist] [PATCH 2/4] docs: ref_rule_file_layout: document default clean stage Roland Hieber
2024-09-12 12:11   ` [ptxdist] [APPLIED] " Michael Olbrich
2024-08-08  9:40 ` [ptxdist] [PATCH 3/4] doc: conf.py: replace 'versatilepb' with example placeholder Roland Hieber
2024-09-12 12:11   ` [ptxdist] [APPLIED] " Michael Olbrich
2024-08-08  9:40 ` [ptxdist] [PATCH 4/4] doc: conf.py: update default toolchain version Roland Hieber
2024-09-12 12:11   ` [ptxdist] [APPLIED] " Michael Olbrich
2024-09-12 12:11 ` [ptxdist] [APPLIED] doc: ref_make_macros: improve world/image-clean documentation Michael Olbrich

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240808094035.1636229-1-rhi@pengutronix.de \
    --to=rhi@pengutronix.de \
    --cc=ptxdist@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox