[ptxdist] [PATCH v3 2/3] ptxd_lib_dgen: error out for targetinstall stages in host/cross/image packages

[Roland Hieber <rhi@pengutronix.de>]

This point came up multiple times in the past and the special handling
of targetinstall stages lead to confusion when trying to depend on image
packages. Document it to prevent further confusion in that matter, and
warn the user if such a make target exists.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
Changes in v2 -> v3:
 - use the same syntax as everywhere else in ptxd_lib_dgen.awk
 - error out instead of warning
 - check cross packages too
 - print offending rule file and line number
---
 doc/ref_rule_file_layout.inc  | 12 ++++++++++++
 scripts/lib/ptxd_lib_dgen.awk | 15 +++++++++++++++
 2 files changed, 27 insertions(+)

diff --git a/doc/ref_rule_file_layout.inc b/doc/ref_rule_file_layout.inc
index ea7eb8c4903d..58f37b73da24 100644
--- a/doc/ref_rule_file_layout.inc
+++ b/doc/ref_rule_file_layout.inc
@@ -23,6 +23,18 @@ Each rule file provides PTXdist with the required steps (in PTXdist called
 
    - targetinstall.post
 
+.. note::
+
+  Host, image and cross packages don't need to install anything in the target file system.
+  Therefore, PTXdist only respects the *targetinstall* and *targetinstall.post*
+  stages for packages whose name doesn't start with ``host-``, ``image-``, or ``cross-``.
+
+  When you want to depend on the output of a certain image package, you can
+  usually use its image name as an `additional prerequisite <make-prereq-types_>`_
+  in your make rule for the dependent stage.
+
+.. _make-prereq-types: https://www.gnu.org/software/make/manual/make.html#Prerequisite-Types
+
 Default stage rules
 ~~~~~~~~~~~~~~~~~~~
 
diff --git a/scripts/lib/ptxd_lib_dgen.awk b/scripts/lib/ptxd_lib_dgen.awk
index c577f905b8fb..dce3f8989eb9 100644
--- a/scripts/lib/ptxd_lib_dgen.awk
+++ b/scripts/lib/ptxd_lib_dgen.awk
@@ -97,6 +97,21 @@ function dump_file(src, dst, tmp) {
 }
 
 
+#
+# warn user if an image, host, or cross package contains a targetinstall rule
+# which will not be executed
+#
+$1 ~ /^\$\(STATEDIR\)\/(image-.*|host-.*|cross-.*)\.targetinstall(.post)?:/ {
+	match($0, /\$\(STATEDIR\)\/((image-.*|host-.*|cross-.*)\.targetinstall(.post)?):/, m);
+	print "Error in " old_filename " line " lineno ":\n" \
+		"  '" m[1] "' stage will be ignored.\n" \
+		"  See section 'Rule File Layout' in the PTXdist reference for more info:\n" \
+		"  https://www.ptxdist.org/doc/ref_manual.html#rule-file-layout" \
+	      > "/dev/stderr";
+	exit 1;
+}
+
+
 #
 # parse "PACKAGES-$(PTXCONF_PKG) += pkg" lines, i.e. rules-files from
 # rules/*.make. Setup mapping between upper and lower case pkg names
-- 
2.20.1


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de