[Buildroot] [PATCH 8/8] docs/manual: document the br2-external help-local

Yann E. MORIN yann.morin.1998 at free.fr
Wed Mar 9 22:22:27 UTC 2016


Signed-off-by: "Yann E. MORIN" <yann.morin.1998 at free.fr>
Cc: Jérôme Pouiller <jezz at sysmic.org>
Cc: Arnout Vandecappelle <arnout at mind.be>
Cc: Thomas Petazzoni <thomas.petazzoni at free-electrons.com>
---
 docs/manual/customize-outside-br.txt | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/docs/manual/customize-outside-br.txt b/docs/manual/customize-outside-br.txt
index 9ad177d..d89dc6f 100644
--- a/docs/manual/customize-outside-br.txt
+++ b/docs/manual/customize-outside-br.txt
@@ -107,3 +107,23 @@ And then in +$(BR2_EXTERNAL)/package/package1+ and
    output of +make list-defconfigs+ and allow them to be loaded with the
    normal +make <name>_defconfig+ command. They will be visible under the
    +User-provided configs+' label in the 'make list-defconfigs' output.
+
+Additionally, an +external.mk+ file may define the +help-local+ make
+rule, to document custom make targets specific to this +BR2_EXTERNAL+
+tree. It is possible to use the +HELP_RULE+ macro to pretty-print those
+additional rules:
+
+------
+BR2_EXTERNAL_HELP = \
+    "my-rule : some help text for my-rule" \
+    "my-other-rule : some help text for my-other-rule"
+
+help-local:
+    @echo 'Here goes your local help'
+    @$(call HELP_RULE,$(BR2_EXTERNAL_HELP))
+    @echo
+    @echo 'Please contact support at company.com in case of problem.'
+------
+
+The format for +BR2_EXTERNAL_HELP+ is the same as the +LIBFOO_HELP+
+package variable, defined in xref:generic-package-tutorial[].
-- 
1.9.1




More information about the buildroot mailing list