Buildroot Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: "Jérôme Pouiller" <jezz@sysmic.org>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH 1/2] help: add a way to document targets declared in local.mk/external.mk
Date: Wed, 18 Nov 2015 15:37:00 +0100	[thread overview]
Message-ID: <1447857421-9380-1-git-send-email-jezz@sysmic.org> (raw)

It is handy to use local.mk or external.mk to add specific targets
for current project. However, until now, it not possible to add help
message these targets.
This patch add LOCAL_HELP variable. This variable is aimed to be assigned
from any .mk files. Its content is displayed with 'make help'.

For exemple:
  LOCAL_HELP += "flash                  - Flash target"
  LOCAL_HELP += "chroot                 - Chroot into target/"
  LOCAL_HELP += "qemu                   - Run image with qemu"
  LOCAL_HELP += "install-nfs            - Extract rootfs in \$$NFSROOT (=$(NFSROOT))"
  LOCAL_HELP += "`printf '%-22s%s' '$(var)-feature' ' - Call $(var) feature'`"
  LOCAL_HELP += "Please contact support at company.com in case of problem."

Signed-off-by: J?r?me Pouiller <jezz@sysmic.org>
---
 Makefile | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Makefile b/Makefile
index 80c264f..4322da9 100644
--- a/Makefile
+++ b/Makefile
@@ -901,6 +901,11 @@ ifeq ($(BR2_TARGET_BAREBOX),y)
 	@echo '  barebox-menuconfig     - Run barebox menuconfig'
 	@echo '  barebox-savedefconfig  - Run barebox savedefconfig'
 endif
+ifneq ($(LOCAL_HELP),)
+	@echo
+	@echo 'Local targets:'
+	@for i in $(LOCAL_HELP); do echo "  $$i"; done
+endif
 	@echo
 	@echo 'Documentation:'
 	@echo '  manual                 - build manual in all formats'
-- 
2.1.4

             reply	other threads:[~2015-11-18 14:37 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-11-18 14:37 Jérôme Pouiller [this message]
2015-11-18 14:37 ` [Buildroot] [PATCH 2/2] help: relocate help messages specific to one package Jérôme Pouiller
2015-11-18 14:49   ` Thomas Petazzoni
2015-11-19 10:44     ` Jérôme Pouiller
2015-11-29 20:39     ` Arnout Vandecappelle
2016-03-08 20:58   ` Arnout Vandecappelle
2015-11-29 20:26 ` [Buildroot] [PATCH 1/2] help: add a way to document targets declared in local.mk/external.mk Yann E. MORIN
2015-11-30 12:04   ` Jérôme Pouiller
2015-11-30 22:22     ` Arnout Vandecappelle
2016-03-08 20:54 ` Arnout Vandecappelle
2016-03-08 21:02   ` Thomas Petazzoni
2016-03-08 21:19     ` Thomas Petazzoni
2016-03-08 21:21     ` Arnout Vandecappelle

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=1447857421-9380-1-git-send-email-jezz@sysmic.org \
    --to=jezz@sysmic.org \
    --cc=buildroot@busybox.net \
    /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