summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Olbrich <m.olbrich@pengutronix.de>2019-02-18 09:04:57 +0100
committerMichael Olbrich <m.olbrich@pengutronix.de>2019-02-19 07:33:03 +0100
commitf4f03806e9d2f027627db89ceae9fa545925504f (patch)
treecb0989e41bdde76ad3f41181902c1711941cc523 /doc
parent03aeed8262a53476bc4a60c47cb2a67e4ee2ed94 (diff)
downloadptxdist-f4f03806e9d2f027627db89ceae9fa545925504f.tar.gz
ptxdist-f4f03806e9d2f027627db89ceae9fa545925504f.tar.xz
introduce 'world/execute' and 'execute' macros
With these, arbitrary commands can be executed in the build stages. They habe the advantage that the environment is identical to the default build stages. Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/ref_manual.rst30
1 files changed, 26 insertions, 4 deletions
diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst
index 7365b01a5..96274ac97 100644
--- a/doc/ref_manual.rst
+++ b/doc/ref_manual.rst
@@ -552,12 +552,34 @@ Usage:
.. code-block:: make
- $(call compile, <PKG>, <build args>)
+ $(call compile, <PKG>, <build arguments>)
This macro is very similar to ``world/compile``. The only differences is
-that is uses the specified ``build args`` instead of ``<PKG>_MAKE_OPT``.
-This is usefull if ``make`` needs to be called more than once in the
-compile stage.
+that is uses the specified ``build arguments`` instead of
+``<PKG>_MAKE_OPT``. This is usefull if ``make`` needs to be called more
+than once in the compile stage.
+
+world/execute, execute
+~~~~~~~~~~~~~~~~~~~~~~
+
+Usage:
+
+.. code-block:: make
+
+ $(call execute, <PKG>, <command with arguments>)
+ $(call world/execute, <PKG>, <command with arguments>)
+
+These macros make it possible to execute arbitrary commands during the
+build stages. This is usefull because the environment is identical to the
+default build commands ``world/*``.
+
+``world/execute`` also handles the generic setup handled in the current
+build stage. For ``prepare`` this means that, for out ot tree builds, the
+build directory is deleted prior to executing the specified command.
+For ``install`` the package directory is deleted.
+
+When ``--verbose`` is used then the full command is logged. With
+``--quiet`` both stdout and stderr are redirected to the logfile.
install_copy
~~~~~~~~~~~~~