From f6a20a8bddcc3975b76db5a1a6cc0179d85be853 Mon Sep 17 00:00:00 2001 From: Roland Hieber Date: Wed, 5 Jun 2019 17:20:31 +0200 Subject: doc: ref_make_macros: improve language, typos and markup 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 Signed-off-by: Michael Olbrich --- doc/ref_make_macros.inc | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) (limited to 'doc') diff --git a/doc/ref_make_macros.inc b/doc/ref_make_macros.inc index 749cf31ed..5bef79f44 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 -``_MAKE_OPT``. This is usefull if ``make`` needs to be called more +``_MAKE_OPT``. This is useful if ``make`` needs to be called more than once in the compile stage. world/execute, execute -- cgit v1.2.3