[Buildroot] [PATCH 1/2] help: add a way to document targets declared in local.mk/external.mk

[Buildroot] [PATCH 1/2] help: add a way to document targets declared in local.mk/external.mk

[Jérôme Pouiller]

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

[Buildroot] [PATCH 2/2] help: relocate help messages specific to one package

[Jérôme Pouiller]

Use $LOCAL_HELP feature in order to integrate help messages specific
to one package (linux-menuconfig, etc...) package they are
related.

It would be possible to do it using kconfig framework, but I was not
sure it is necessary to document kconfig targets systematicaly.

Signed-off-by: J?r?me Pouiller <jezz@sysmic.org>
---
 Makefile                   | 16 ----------------
 boot/barebox/barebox.mk    |  5 +++++
 linux/linux.mk             |  7 +++++++
 package/busybox/busybox.mk |  4 ++++
 package/uclibc/uclibc.mk   |  4 ++++
 5 files changed, 20 insertions(+), 16 deletions(-)

diff --git a/Makefile b/Makefile
index 4322da9..8c14281 100644
--- a/Makefile
+++ b/Makefile
@@ -885,22 +885,6 @@ help:
 	@echo '  <pkg>-dirclean         - Remove <pkg> build directory'
 	@echo '  <pkg>-reconfigure      - Restart the build from the configure step'
 	@echo '  <pkg>-rebuild          - Restart the build from the build step'
-ifeq ($(BR2_PACKAGE_BUSYBOX),y)
-	@echo '  busybox-menuconfig     - Run BusyBox menuconfig'
-endif
-ifeq ($(BR2_LINUX_KERNEL),y)
-	@echo '  linux-menuconfig       - Run Linux kernel menuconfig'
-	@echo '  linux-savedefconfig    - Run Linux kernel savedefconfig'
-	@echo '  linux-update-defconfig - Save the Linux configuration to the path specified'
-	@echo '                             by BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE'
-endif
-ifeq ($(BR2_TOOLCHAIN_BUILDROOT),y)
-	@echo '  uclibc-menuconfig      - Run uClibc menuconfig'
-endif
-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:'
diff --git a/boot/barebox/barebox.mk b/boot/barebox/barebox.mk
index 00e1537..d8dde20 100644
--- a/boot/barebox/barebox.mk
+++ b/boot/barebox/barebox.mk
@@ -116,4 +116,9 @@ $(error No Barebox config file. Check your BR2_TARGET_BAREBOX_BOARD_DEFCONFIG or
 endif
 endif
 
+ifeq ($(BR2_TARGET_BAREBOX),y)
+	LOCAL_HELP += 'barebox-menuconfig     - Run barebox menuconfig'
+	LOCAL_HELP += 'barebox-savedefconfig  - Run barebox savedefconfig'
+endif
+
 $(eval $(kconfig-package))
diff --git a/linux/linux.mk b/linux/linux.mk
index 9507837..a4d1301 100644
--- a/linux/linux.mk
+++ b/linux/linux.mk
@@ -390,6 +390,13 @@ endif
 
 endif # BR_BUILDING
 
+ifeq ($(BR2_LINUX_KERNEL),y)
+	LOCAL_HELP += 'linux-menuconfig       - Run Linux kernel menuconfig'
+	LOCAL_HELP += 'linux-savedefconfig    - Run Linux kernel savedefconfig'
+	LOCAL_HELP += 'linux-update-defconfig - Save the Linux configuration to the path specified'
+	LOCAL_HELP += '                             by BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE'
+endif
+
 $(eval $(kconfig-package))
 
 # Support for rebuilding the kernel after the cpio archive has
diff --git a/package/busybox/busybox.mk b/package/busybox/busybox.mk
index 7f6dbd6..3e6ca78 100644
--- a/package/busybox/busybox.mk
+++ b/package/busybox/busybox.mk
@@ -262,4 +262,8 @@ $(error No BusyBox configuration file specified, check your BR2_PACKAGE_BUSYBOX_
 endif
 endif
 
+ifeq ($(BR2_PACKAGE_BUSYBOX),y)
+	LOCAL_HELP += 'busybox-menuconfig     - Run BusyBox menuconfig'
+endif
+
 $(eval $(kconfig-package))
diff --git a/package/uclibc/uclibc.mk b/package/uclibc/uclibc.mk
index c62a40f..e8af45e 100644
--- a/package/uclibc/uclibc.mk
+++ b/package/uclibc/uclibc.mk
@@ -470,4 +470,8 @@ $(error No uClibc configuration file specified, check your BR2_UCLIBC_CONFIG set
 endif
 endif
 
+ifeq ($(BR2_PACKAGE_UCLIBC),y)
+	LOCAL_HELP += 'uclibc-menuconfig      - Run uClibc menuconfig'
+endif
+
 $(eval $(kconfig-package))
-- 
2.1.4

[Buildroot] [PATCH 2/2] help: relocate help messages specific to one package

[Thomas Petazzoni]

Hello,

On Wed, 18 Nov 2015 15:37:01 +0100, J?r?me Pouiller wrote:
> Use $LOCAL_HELP feature in order to integrate help messages specific
> to one package (linux-menuconfig, etc...) package they are
> related.
> 
> It would be possible to do it using kconfig framework, but I was not
> sure it is necessary to document kconfig targets systematicaly.
> 
> Signed-off-by: J?r?me Pouiller <jezz@sysmic.org>
> ---
>  Makefile                   | 16 ----------------
>  boot/barebox/barebox.mk    |  5 +++++
>  linux/linux.mk             |  7 +++++++
>  package/busybox/busybox.mk |  4 ++++
>  package/uclibc/uclibc.mk   |  4 ++++
>  5 files changed, 20 insertions(+), 16 deletions(-)

I already proposed something achieving a similar thing (but more
integrated into the package infrastructure) a while ago, and it wasn't
accepted.

See:

  http://lists.busybox.net/pipermail/buildroot/2015-January/118159.html

Best regards,

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

[Buildroot] [PATCH 2/2] help: relocate help messages specific to one package

[Jérôme Pouiller]

Hello Thomas,

On Wednesday 18 November 2015 15:49:12 Thomas Petazzoni wrote:
> Hello,
> 
> On Wed, 18 Nov 2015 15:37:01 +0100, J?r?me Pouiller wrote:
> > Use $LOCAL_HELP feature in order to integrate help messages specific
> > to one package (linux-menuconfig, etc...) package they are
> > related.
> > 
> > It would be possible to do it using kconfig framework, but I was not
> > sure it is necessary to document kconfig targets systematicaly.
> > 
> > Signed-off-by: J?r?me Pouiller <jezz@sysmic.org>
> > ---
> > 
> >  Makefile                   | 16 ----------------
> >  boot/barebox/barebox.mk    |  5 +++++
> >  linux/linux.mk             |  7 +++++++
> >  package/busybox/busybox.mk |  4 ++++
> >  package/uclibc/uclibc.mk   |  4 ++++
> >  5 files changed, 20 insertions(+), 16 deletions(-)
> 
> I already proposed something achieving a similar thing (but more
> integrated into the package infrastructure) a while ago, and it wasn't
> accepted.
> 
> See:
> 
>  
> http://lists.busybox.net/pipermail/buildroot/2015-January/118159.html

Indeed, second patch of my series seems achieving a similar thing (it's 
a pity arguments provided to reject it were not logged). 

However I think first patch has really different aim.


BR,

-- 
J?r?me Pouiller, Sysmic
Embedded Linux specialist
http://www.sysmic.fr

[Buildroot] [PATCH 2/2] help: relocate help messages specific to one package

[Arnout Vandecappelle]

On 18-11-15 15:49, Thomas Petazzoni wrote:
> Hello,
> 
> On Wed, 18 Nov 2015 15:37:01 +0100, J?r?me Pouiller wrote:
>> Use $LOCAL_HELP feature in order to integrate help messages specific
>> to one package (linux-menuconfig, etc...) package they are
>> related.
>>
>> It would be possible to do it using kconfig framework, but I was not
>> sure it is necessary to document kconfig targets systematicaly.
>>
>> Signed-off-by: J?r?me Pouiller <jezz@sysmic.org>
>> ---
>>  Makefile                   | 16 ----------------
>>  boot/barebox/barebox.mk    |  5 +++++
>>  linux/linux.mk             |  7 +++++++
>>  package/busybox/busybox.mk |  4 ++++
>>  package/uclibc/uclibc.mk   |  4 ++++
>>  5 files changed, 20 insertions(+), 16 deletions(-)
> 
> I already proposed something achieving a similar thing (but more
> integrated into the package infrastructure) a while ago, and it wasn't
> accepted.
> 
> See:
> 
>   http://lists.busybox.net/pipermail/buildroot/2015-January/118159.html

 Your proposal had a lot more impact. J?r?me's proposal is diffstat-neutral
(except for 4 added empty lines, and with 5 additional lines needed in the infra
in patch 1/2). So I'm not opposed to this proposal at all.


 Regards,
 Arnout

> 
> Best regards,
> 
> Thomas
> 


-- 
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF

[Buildroot] [PATCH 2/2] help: relocate help messages specific to one package

[Arnout Vandecappelle]

On 11/18/15 15:37, J?r?me Pouiller wrote:
> Use $LOCAL_HELP feature in order to integrate help messages specific
> to one package (linux-menuconfig, etc...) package they are
> related.
>
> It would be possible to do it using kconfig framework, but I was not
> sure it is necessary to document kconfig targets systematicaly.
>
> Signed-off-by: J?r?me Pouiller <jezz@sysmic.org>

  With the change LOCAL -> ADDITIONAL:

  Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>


  Regards,
  Arnout

> ---
>   Makefile                   | 16 ----------------
>   boot/barebox/barebox.mk    |  5 +++++
>   linux/linux.mk             |  7 +++++++
>   package/busybox/busybox.mk |  4 ++++
>   package/uclibc/uclibc.mk   |  4 ++++
>   5 files changed, 20 insertions(+), 16 deletions(-)
>
> diff --git a/Makefile b/Makefile
> index 4322da9..8c14281 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -885,22 +885,6 @@ help:
>   	@echo '  <pkg>-dirclean         - Remove <pkg> build directory'
>   	@echo '  <pkg>-reconfigure      - Restart the build from the configure step'
>   	@echo '  <pkg>-rebuild          - Restart the build from the build step'
> -ifeq ($(BR2_PACKAGE_BUSYBOX),y)
> -	@echo '  busybox-menuconfig     - Run BusyBox menuconfig'
> -endif
> -ifeq ($(BR2_LINUX_KERNEL),y)
> -	@echo '  linux-menuconfig       - Run Linux kernel menuconfig'
> -	@echo '  linux-savedefconfig    - Run Linux kernel savedefconfig'
> -	@echo '  linux-update-defconfig - Save the Linux configuration to the path specified'
> -	@echo '                             by BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE'
> -endif
> -ifeq ($(BR2_TOOLCHAIN_BUILDROOT),y)
> -	@echo '  uclibc-menuconfig      - Run uClibc menuconfig'
> -endif
> -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:'
> diff --git a/boot/barebox/barebox.mk b/boot/barebox/barebox.mk
> index 00e1537..d8dde20 100644
> --- a/boot/barebox/barebox.mk
> +++ b/boot/barebox/barebox.mk
> @@ -116,4 +116,9 @@ $(error No Barebox config file. Check your BR2_TARGET_BAREBOX_BOARD_DEFCONFIG or
>   endif
>   endif
>
> +ifeq ($(BR2_TARGET_BAREBOX),y)
> +	LOCAL_HELP += 'barebox-menuconfig     - Run barebox menuconfig'
> +	LOCAL_HELP += 'barebox-savedefconfig  - Run barebox savedefconfig'
> +endif
> +
>   $(eval $(kconfig-package))
> diff --git a/linux/linux.mk b/linux/linux.mk
> index 9507837..a4d1301 100644
> --- a/linux/linux.mk
> +++ b/linux/linux.mk
> @@ -390,6 +390,13 @@ endif
>
>   endif # BR_BUILDING
>
> +ifeq ($(BR2_LINUX_KERNEL),y)
> +	LOCAL_HELP += 'linux-menuconfig       - Run Linux kernel menuconfig'
> +	LOCAL_HELP += 'linux-savedefconfig    - Run Linux kernel savedefconfig'
> +	LOCAL_HELP += 'linux-update-defconfig - Save the Linux configuration to the path specified'
> +	LOCAL_HELP += '                             by BR2_LINUX_KERNEL_CUSTOM_CONFIG_FILE'
> +endif
> +
>   $(eval $(kconfig-package))
>
>   # Support for rebuilding the kernel after the cpio archive has
> diff --git a/package/busybox/busybox.mk b/package/busybox/busybox.mk
> index 7f6dbd6..3e6ca78 100644
> --- a/package/busybox/busybox.mk
> +++ b/package/busybox/busybox.mk
> @@ -262,4 +262,8 @@ $(error No BusyBox configuration file specified, check your BR2_PACKAGE_BUSYBOX_
>   endif
>   endif
>
> +ifeq ($(BR2_PACKAGE_BUSYBOX),y)
> +	LOCAL_HELP += 'busybox-menuconfig     - Run BusyBox menuconfig'
> +endif
> +
>   $(eval $(kconfig-package))
> diff --git a/package/uclibc/uclibc.mk b/package/uclibc/uclibc.mk
> index c62a40f..e8af45e 100644
> --- a/package/uclibc/uclibc.mk
> +++ b/package/uclibc/uclibc.mk
> @@ -470,4 +470,8 @@ $(error No uClibc configuration file specified, check your BR2_UCLIBC_CONFIG set
>   endif
>   endif
>
> +ifeq ($(BR2_PACKAGE_UCLIBC),y)
> +	LOCAL_HELP += 'uclibc-menuconfig      - Run uClibc menuconfig'
> +endif
> +
>   $(eval $(kconfig-package))
>


-- 
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF

[Buildroot] [PATCH 1/2] help: add a way to document targets declared in local.mk/external.mk

[Yann E. MORIN]

J?r?me, All,

On 2015-11-18 15:37 +0100, J?r?me Pouiller spake thusly:
> 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

Well, for help from extenal.mk (or local.mk, but I'd arue that would be
a bad idea, given that local.mk is supposedly short-lived), there is in
my opinion a much better solution.

Change the 'help' rule to a double-colon make rule, like so:

    help::
        echo Current Buildroot help

Then you can add as many such rules in as many places you want,
especially in external.mk, and the will be appended one after the
others.

We just have to ensure that our help comes before the external ones, so
maybe you'll have to move our help block before inclusion of
external.mk...

Regards,
Yann E. MORIN.

>  	@echo
>  	@echo 'Documentation:'
>  	@echo '  manual                 - build manual in all formats'
> -- 
> 2.1.4
> 
> _______________________________________________
> buildroot mailing list
> buildroot at busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'

[Buildroot] [PATCH 1/2] help: add a way to document targets declared in local.mk/external.mk

[Jérôme Pouiller]

Hello Yann,

On Sunday 29 November 2015 21:26:50 Yann E. MORIN wrote:
> J?r?me, All,
> 
> On 2015-11-18 15:37 +0100, J?r?me Pouiller spake thusly:
> > 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
> 
> Well, for help from extenal.mk (or local.mk, but I'd arue that would
> be a bad idea, given that local.mk is supposedly short-lived), there
> is in my opinion a much better solution.
> 
> Change the 'help' rule to a double-colon make rule, like so:
> 
>     help::
>         echo Current Buildroot help
> 
> Then you can add as many such rules in as many places you want,
> especially in external.mk, and the will be appended one after the
> others.
Nice trick.


> We just have to ensure that our help comes before the external ones,
> so maybe you'll have to move our help block before inclusion of
> external.mk...

I have a slight preference for my proposal since I think it allows a 
finer control of the way extra help is handled. However, I have no 
problem to send a new patch using your trick.

Regards,

-- 
J?r?me Pouiller, Sysmic
Embedded Linux specialist
http://www.sysmic.fr

[Buildroot] [PATCH 1/2] help: add a way to document targets declared in local.mk/external.mk

[Arnout Vandecappelle]

On 30-11-15 13:04, J?r?me Pouiller wrote:
> Hello Yann,
> 
> On Sunday 29 November 2015 21:26:50 Yann E. MORIN wrote:
>> J?r?me, All,
>>
>> On 2015-11-18 15:37 +0100, J?r?me Pouiller spake thusly:
[snip]
>> Well, for help from extenal.mk (or local.mk, but I'd arue that would
>> be a bad idea, given that local.mk is supposedly short-lived), there
>> is in my opinion a much better solution.
>>
>> Change the 'help' rule to a double-colon make rule, like so:
>>
>>     help::
>>         echo Current Buildroot help
>>
>> Then you can add as many such rules in as many places you want,
>> especially in external.mk, and the will be appended one after the
>> others.
>
> Nice trick.

 IMHO tricks (nice or not) are no good because they make things more difficult
to understand. Also, we don't currently use the :: construct so I'd prefer to
avoid introducing it.


>> We just have to ensure that our help comes before the external ones,
>> so maybe you'll have to move our help block before inclusion of
>> external.mk...
> 
> I have a slight preference for my proposal since I think it allows a 
> finer control of the way extra help is handled. However, I have no 
> problem to send a new patch using your trick.

 Because of what I wrote above, I also prefer your proposal.


 Regards,
 Arnout

> 
> Regards,
> 


-- 
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF

[Buildroot] [PATCH 1/2] help: add a way to document targets declared in local.mk/external.mk

[Arnout Vandecappelle]

On 11/18/15 15:37, J?r?me Pouiller wrote:
> 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>

  Looks good to me, except that I don't like the name 'LOCAL'. I'd prefer e.g. 
ADDITIONAL.

> ---
>   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:'

  And this bit is not needed for me (neither the empty line).

  But with that:

  Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>


  Regards,
  Arnout

> +	@for i in $(LOCAL_HELP); do echo "  $$i"; done
> +endif
>   	@echo
>   	@echo 'Documentation:'
>   	@echo '  manual                 - build manual in all formats'
>


-- 
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF

[Buildroot] [PATCH 1/2] help: add a way to document targets declared in local.mk/external.mk

[Thomas Petazzoni]

Hello,

On Tue, 8 Mar 2016 21:54:55 +0100, Arnout Vandecappelle wrote:
> On 11/18/15 15:37, J?r?me Pouiller wrote:
> > 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>
> 
>   Looks good to me, except that I don't like the name 'LOCAL'. I'd prefer e.g. 
> ADDITIONAL.

Wouldn't EXTERNAL_HELP be even better, suggesting that its main
use-case is for BR2_EXTERNAL ?

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

[Buildroot] [PATCH 1/2] help: add a way to document targets declared in local.mk/external.mk

[Thomas Petazzoni]

Hello,

On Tue, 8 Mar 2016 22:02:21 +0100, Thomas Petazzoni wrote:

> >   Looks good to me, except that I don't like the name 'LOCAL'. I'd prefer e.g. 
> > ADDITIONAL.
> 
> Wouldn't EXTERNAL_HELP be even better, suggesting that its main
> use-case is for BR2_EXTERNAL ?

My suggestion obviously doesn't work if we want to use this for
internal packages, as PATCH 2/2 is doing.

Best regards,

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

[Buildroot] [PATCH 1/2] help: add a way to document targets declared in local.mk/external.mk

[Arnout Vandecappelle]

On 03/08/16 22:02, Thomas Petazzoni wrote:
> Hello,
>
> On Tue, 8 Mar 2016 21:54:55 +0100, Arnout Vandecappelle wrote:
>> On 11/18/15 15:37, J?r?me Pouiller wrote:
>>> 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>
>>
>>    Looks good to me, except that I don't like the name 'LOCAL'. I'd prefer e.g.
>> ADDITIONAL.
>
> Wouldn't EXTERNAL_HELP be even better, suggesting that its main
> use-case is for BR2_EXTERNAL ?

  Works for me as well. Additional is a word we're currently not using at all, 
so perhaps reusing external is better.


  Regards,
  Arnout


-- 
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF