summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Olbrich <m.olbrich@pengutronix.de>2019-06-14 18:15:28 +0200
committerMichael Olbrich <m.olbrich@pengutronix.de>2019-06-25 07:59:03 +0200
commitbca53cf091eef0d522776a94ee838cbc3109352b (patch)
treed9fbfd97b8437a1cfbbc3b0d038c556a3155f1c7
parent4cf6adf7df75f7b95a27b373b253ab79ed431013 (diff)
downloadptxdist-bca53cf091eef0d522776a94ee838cbc3109352b.tar.gz
ptxdist-bca53cf091eef0d522776a94ee838cbc3109352b.tar.xz
doc: ref_make_macros: add more details to the 'extract' documentation
Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
-rw-r--r--doc/ref_make_macros.inc6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/ref_make_macros.inc b/doc/ref_make_macros.inc
index 5bef79f44..b36a82575 100644
--- a/doc/ref_make_macros.inc
+++ b/doc/ref_make_macros.inc
@@ -67,6 +67,8 @@ For the package *foo* and the *compile* stage, this macro will output::
finished target foo.compile
+.. _clean:
+
clean
~~~~~
@@ -108,6 +110,10 @@ 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.
+The target directory is not removed, so ``extract`` can be used multipe
+times in a row to extract several archives. Usually :ref:`clean` is
+called before the first ``extract``.
+
compile
~~~~~~~