diff options
author | Roland Hieber <rhi@pengutronix.de> | 2019-06-05 17:20:30 +0200 |
---|---|---|
committer | Michael Olbrich <m.olbrich@pengutronix.de> | 2019-06-12 13:36:04 +0200 |
commit | 1b9c62533d034ed8020116d78c19bae11234789f (patch) | |
tree | b124c3a0143a2e5de07becadf075ef9afb9a71bd | |
parent | 1019ebf97c7668e0ccc6c061d4848dedb0daa07a (diff) | |
download | ptxdist-1b9c62533d034ed8020116d78c19bae11234789f.tar.gz ptxdist-1b9c62533d034ed8020116d78c19bae11234789f.tar.xz |
doc: ref_make_macros: document the 'extract' macro
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
-rw-r--r-- | doc/ref_make_macros.inc | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/ref_make_macros.inc b/doc/ref_make_macros.inc index 329f3821c..749cf31ed 100644 --- a/doc/ref_make_macros.inc +++ b/doc/ref_make_macros.inc @@ -97,6 +97,21 @@ 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. +extract +~~~~~~~ + +Usage: + +.. code-block:: make + + $(call extract, <PKG>) + +Extract a source archive into a directory. +The source archive to unpack is taken from the ``<PKG>_SOURCE`` variable, +and the directory to unpack to is taken from the ``<PKG>_DIR`` variable. +This macro doesn't do anything if ``<PKG>_URL`` points to a local directory +instead of an archive or online URL. + compile ~~~~~~~ |