[ptxdist] [PATCH 1/2] doc: ref_make_macros: document the 'extract' macro

[ptxdist] [PATCH 1/2] doc: ref_make_macros: document the 'extract' macro

[Roland Hieber]

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

[ptxdist] [PATCH 2/2] doc: ref_make_macros: improve language, typos and markup

[Roland Hieber]

The literal blocks don't need to be code-blocks, as there is no code to
be highlighted.

Turn down the inline markup to make the text better readable. A
technical term doesn't need to be emphasized every time it occurs.

Use semantic newlines where applicable.

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

diff --git a/doc/ref_make_macros.inc b/doc/ref_make_macros.inc
index 749cf31edf66..5bef79f44d00 100644
--- a/doc/ref_make_macros.inc
+++ b/doc/ref_make_macros.inc
@@ -44,11 +44,9 @@ Usage:
 
  $(call targetinfo)
 
-Gives a feedback, what build *stage* is just started. That's why it
-should always be the first call for each *stage*. For the package
-*foo* and the *compile stage* it will output:
-
-.. code-block:: bash
+Gives the user feedback about which build stage has just started.
+That's why it should always be the first call for each stage.
+For the package *foo* and the *compile* stage, this macro will output::
 
  --------------------
  target: foo.compile
@@ -63,11 +61,9 @@ Usage:
 
  $(call touch)
 
-Gives a feedback, what build *stage* is just finished. That's why it
-should always be the last call for each *stage*. For the package
-*foo* and the *compile stage* it will output:
-
-.. code-block:: bash
+Gives the user feedback about which build stage has just finished.
+That's why it should always be the last call for each stage.
+For the package *foo* and the *compile* stage, this macro will output::
 
  finished target foo.compile
 
@@ -123,7 +119,7 @@ Usage:
 
 This macro is very similar to ``world/compile``. The only differences is
 that is uses the specified ``build arguments`` instead of
-``<PKG>_MAKE_OPT``. This is usefull if ``make`` needs to be called more
+``<PKG>_MAKE_OPT``. This is useful if ``make`` needs to be called more
 than once in the compile stage.
 
 world/execute, execute
-- 
2.20.1


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de