Re: [ptxdist] [APPLIED] doc: ref_make_macros: improve world/image-clean documentation

[Michael Olbrich <m.olbrich@pengutronix.de>]

Thanks, applied as 7242b87b98e2f4f1503ae72c28b481da4812a567.

Michael

[sent from post-receive hook]

On Thu, 12 Sep 2024 14:11:37 +0200, Roland Hieber <rhi@pengutronix.de> wrote:
> 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>
> Message-Id: <20240808094035.1636229-1-rhi@pengutronix.de>
> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
> 
> 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