manual: add information about INSTALL_IMAGES_CMDS
authorRyan Barnett <rjbarnet@rockwellcollins.com>
Fri, 9 May 2014 00:20:11 +0000 (19:20 -0500)
committerPeter Korsgaard <peter@korsgaard.com>
Mon, 12 May 2014 20:58:51 +0000 (22:58 +0200)
The Buildroot manual currently does not contain any mention of the
<pkg>_INSTALL_IMAGES_CMDS which could potentially be of interest when
developing a new 'generic-package'.

Signed-off-by: Ryan Barnett <rjbarnet@rockwellcollins.com>
CC: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
docs/manual/adding-packages-generic.txt

index 1567487740dfc16ae02a1a5d78d7d573fddb3718..f421651bb0dda1cccdf8ea96216b5a0b95716bc9 100644 (file)
@@ -410,6 +410,15 @@ different steps of the build process.
   should be installed, since they might be needed to compile other
   packages.
 
+* +LIBFOO_INSTALL_IMAGES_CMDS+ lists the actions to be performed to
+  install the package to the images directory, when the package is a
+  target package. The package must install its files to the directory
+  given by +$(BINARIES_DIR)+. Only files that are binary images (aka
+  images) that do not belong in the +TARGET_DIR+ but are necessary
+  for booting the board should be placed here. For example, a package
+  should utilize this step if it has binaries which would be similar
+  to the kernel image, bootloader or root filesystem images.
+
 * +LIBFOO_INSTALL_INIT_SYSV+ and +LIBFOO_INSTALL_INIT_SYSTEMD+ list the
   actions to install init scripts either for the systemV-like init systems
   (busybox, sysvinit, etc.) or for the systemd units. These commands