rules: introduce new macros to install files to images/

Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>

1 files changed, 27 insertions, 0 deletions

diff --git a/doc/ref_make_macros.rst b/doc/ref_make_macros.rst
index 730687daf..684390089 100644
--- a/doc/ref_make_macros.rst
+++ b/doc/ref_make_macros.rst
@@ -150,6 +150,33 @@ When ``--verbose`` is used then the full command is logged. With
 
 .. _install_copy:
 
+ptx/image-install, ptx/image-install-link, world/image-clean
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Usage:
+
+.. code-block:: make
+
+ @$(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>)
+
+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
+omitted.
+
+``ptx/image-install-link`` creates a symlink in the image directory.
+
 install_copy
 ~~~~~~~~~~~~~