mailarchive of the ptxdist mailing list
 help / color / mirror / Atom feed
From: Roland Hieber <rhi@pengutronix.de>
To: ptxdist@pengutronix.de
Cc: Roland Hieber <rhi@pengutronix.de>
Subject: [ptxdist] [PATCH 1/2] doc: ref_make_macros: document the 'extract' macro
Date: Wed,  5 Jun 2019 17:20:30 +0200	[thread overview]
Message-ID: <20190605152031.17474-1-rhi@pengutronix.de> (raw)

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 doc/ref_make_macros.inc | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/doc/ref_make_macros.inc b/doc/ref_make_macros.inc
index 329f3821ce77..749cf31edf66 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
 ~~~~~~~
 
-- 
2.20.1


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

             reply	other threads:[~2019-06-05 15:20 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-05 15:20 Roland Hieber [this message]
2019-06-05 15:20 ` [ptxdist] [PATCH 2/2] doc: ref_make_macros: improve language, typos and markup Roland Hieber

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190605152031.17474-1-rhi@pengutronix.de \
    --to=rhi@pengutronix.de \
    --cc=ptxdist@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox