diff options
author | Michael Olbrich <m.olbrich@pengutronix.de> | 2019-02-18 09:29:19 +0100 |
---|---|---|
committer | Michael Olbrich <m.olbrich@pengutronix.de> | 2019-02-19 07:33:03 +0100 |
commit | 03aeed8262a53476bc4a60c47cb2a67e4ee2ed94 (patch) | |
tree | aeca61b7d1eb39f0ca0229849511d580ba7d8573 | |
parent | 5334086af718bf4309e0118e927444784ba41b95 (diff) | |
download | ptxdist-03aeed8262a53476bc4a60c47cb2a67e4ee2ed94.tar.gz ptxdist-03aeed8262a53476bc4a60c47cb2a67e4ee2ed94.tar.xz |
doc: add some basic documentation for 'world/*' and 'compile'
Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
-rw-r--r-- | doc/ref_manual.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst index 0ac92a9a0..7365b01a5 100644 --- a/doc/ref_manual.rst +++ b/doc/ref_manual.rst @@ -532,6 +532,33 @@ Removes the given directory ``<directory path>`` .. _install_copy: +world/get, world/extract, world/prepare, world/compile, world/install +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Usage: + +.. code-block:: make + + $(call world/get, <PKG>) + +The same for all other macros. These are the default build commands for the +corresponding stages. For more details see the documentation of the default +stages below. + +compile +~~~~~~~ + +Usage: + +.. code-block:: make + + $(call compile, <PKG>, <build args>) + +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. + install_copy ~~~~~~~~~~~~~ |