[Buildroot] [RFC 0/8] Add a per-package help text

[Buildroot] [RFC 0/8] Add a per-package help text

[Thomas Petazzoni]

Hello,

This commit implements one item of our TODO-list, which I believe we
added at the latest Buildroot meeting: adding a per-package help text
to document the available make targets for this package.

This idea came after a long discussion about which per-package make
targets should be documented under "make help", and which should
not. The idea is that the only per-package make target that now gets
documented in the global "make help" is "make <pkg>-help", and that
this per-package help text gives detailed information about which make
targets are available for this package.

The first patch adds support for <pkg>-help in generic-package, which
documents the generic targets.

The second patch extends the help text in the kconfig-package
infrastructure with the kconfig specific targets.

The three next patches (3, 4, 5) update the linux, barebox and ccache
packages to also document their own custom make targets using this new
mechanism.

The two next patches (6, 7) update the main "make help" text to take
into account those changes.

The last patch updates the manual.

Let me know what you think about this, and if the idea is worth
pursuing.

Thanks,

Thomas

Thomas Petazzoni (8):
  package: core support for per-package help text
  pkg-kconfig: extend per-package help text with kconfig targets
  linux: add custom per-package help text contents
  barebox: add custom help entries
  ccache: add custom help entries
  Makefile: remove uclibc, barebox, linux, busybox specific help
  Makefile: point users to the per-package help text
  docs/manual: update manual about <pkg>-help tagret

 Makefile                            | 15 +--------------
 boot/barebox/barebox.mk             | 10 ++++++++++
 docs/manual/make-tips.txt           | 11 -----------
 docs/manual/package-make-target.txt |  2 ++
 linux/linux.mk                      | 10 ++++++++++
 package/ccache/ccache.mk            |  7 +++++++
 package/pkg-generic.mk              | 24 ++++++++++++++++++++++++
 package/pkg-kconfig.mk              |  8 ++++++++
 package/pkg-utils.mk                |  4 ++++
 9 files changed, 66 insertions(+), 25 deletions(-)

-- 
2.1.0

[Buildroot] [RFC 1/8] package: core support for per-package help text

[Thomas Petazzoni]

This commit adds to the generic-package infrastructure a new
per-package $(1)-help target, which shows a help text containing
details about all available make targets for this package.

Each target is displayed using a small helper function called
pkg-print-help-opt, also added by this commit.

This basic generic-package help text can be extended by specialized
package infrastructure, or by individual packages, using the
$(2)_HELP_HOOKS variable.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 package/pkg-generic.mk | 24 ++++++++++++++++++++++++
 package/pkg-utils.mk   |  4 ++++
 2 files changed, 28 insertions(+)

diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
index 9643a30..cf7333d 100644
--- a/package/pkg-generic.mk
+++ b/package/pkg-generic.mk
@@ -594,6 +594,30 @@ $(1)-clean-for-reconfigure: $(1)-clean-for-rebuild
 
 $(1)-reconfigure:	$(1)-clean-for-reconfigure $(1)
 
+$(1)-help:
+	@$(call pkg-print-help-opt,$(1),"Build completely")
+	@$(call pkg-print-help-opt,$(1)-install,"Build up to the installation step")
+ifeq ($$($(2)_TYPE),host)
+	@$(call pkg-print-help-opt,$(1)-install-host,"Build up to the host installation step")
+else
+	@$(call pkg-print-help-opt,$(1)-install-target,"Build up to the target installation step")
+	@$(call pkg-print-help-opt,$(1)-install-staging,"Build up to the staging installation step")
+	@$(call pkg-print-help-opt,$(1)-install-images,"Build up to the images installation step")
+endif
+	@$(call pkg-print-help-opt,$(1)-build,"Build up to the compile step")
+	@$(call pkg-print-help-opt,$(1)-configure,"Build up to the configure step")
+	@$(call pkg-print-help-opt,$(1)-patch,"Build up to the patch step")
+	@$(call pkg-print-help-opt,$(1)-extract,"Build up to the extract step")
+	@$(call pkg-print-help-opt,$(1)-depends,"Build package dependencies")
+	@$(call pkg-print-help-opt,$(1)-source,"Only download the source files")
+	@$(call pkg-print-help-opt,$(1)-show-depends,"Display the list of dependencies")
+	@$(call pkg-print-help-opt,$(1)-graph-depends,"Generate a graph of the dependencies")
+	@$(call pkg-print-help-opt,$(1)-dirclean,"Remove the package build directory")
+	@$(call pkg-print-help-opt,$(1)-rebuild,"Restart the build from the compile step")
+	@$(call pkg-print-help-opt,$(1)-reconfigure,"Restart the build from the configure step")
+	@$(call pkg-print-help-opt,$(1)-legal-info,"Generate legal informations")
+	$(foreach hook,$$($(2)_HELP_HOOKS),$$(call $(hook))$(sep))
+
 # define the PKG variable for all targets, containing the
 # uppercase package variable prefix
 $$($(2)_TARGET_INSTALL_TARGET):		PKG=$(2)
diff --git a/package/pkg-utils.mk b/package/pkg-utils.mk
index 7eddc47..fbb94cf 100644
--- a/package/pkg-utils.mk
+++ b/package/pkg-utils.mk
@@ -37,6 +37,10 @@ endef
 $(eval $(call caseconvert-helper,UPPERCASE,$(join $(addsuffix :,$([FROM])),$([TO]))))
 $(eval $(call caseconvert-helper,LOWERCASE,$(join $(addsuffix :,$([TO])),$([FROM]))))
 
+define pkg-print-help-opt
+	printf "%30s - %s\n" $(1) $(2)
+endef
+
 #
 # Manipulation of .config files based on the Kconfig
 # infrastructure. Used by the BusyBox package, the Linux kernel
-- 
2.1.0

[Buildroot] [RFC 1/8] package: core support for per-package help text

[Yann E. MORIN]

Thomas, All,

On 2015-01-27 22:41 +0100, Thomas Petazzoni spake thusly:
> This commit adds to the generic-package infrastructure a new
> per-package $(1)-help target, which shows a help text containing
> details about all available make targets for this package.
> 
> Each target is displayed using a small helper function called
> pkg-print-help-opt, also added by this commit.
> 
> This basic generic-package help text can be extended by specialized
> package infrastructure, or by individual packages, using the
> $(2)_HELP_HOOKS variable.
> 
> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
> ---
>  package/pkg-generic.mk | 24 ++++++++++++++++++++++++
>  package/pkg-utils.mk   |  4 ++++
>  2 files changed, 28 insertions(+)
> 
> diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
> index 9643a30..cf7333d 100644
> --- a/package/pkg-generic.mk
> +++ b/package/pkg-generic.mk
> @@ -594,6 +594,30 @@ $(1)-clean-for-reconfigure: $(1)-clean-for-rebuild
>  
>  $(1)-reconfigure:	$(1)-clean-for-reconfigure $(1)
>  
> +$(1)-help:
> +	@$(call pkg-print-help-opt,$(1),"Build completely")
> +	@$(call pkg-print-help-opt,$(1)-install,"Build up to the installation step")
> +ifeq ($$($(2)_TYPE),host)
> +	@$(call pkg-print-help-opt,$(1)-install-host,"Build up to the host installation step")
> +else
> +	@$(call pkg-print-help-opt,$(1)-install-target,"Build up to the target installation step")
> +	@$(call pkg-print-help-opt,$(1)-install-staging,"Build up to the staging installation step")
> +	@$(call pkg-print-help-opt,$(1)-install-images,"Build up to the images installation step")
> +endif
> +	@$(call pkg-print-help-opt,$(1)-build,"Build up to the compile step")
> +	@$(call pkg-print-help-opt,$(1)-configure,"Build up to the configure step")
> +	@$(call pkg-print-help-opt,$(1)-patch,"Build up to the patch step")
> +	@$(call pkg-print-help-opt,$(1)-extract,"Build up to the extract step")
> +	@$(call pkg-print-help-opt,$(1)-depends,"Build package dependencies")
> +	@$(call pkg-print-help-opt,$(1)-source,"Only download the source files")
> +	@$(call pkg-print-help-opt,$(1)-show-depends,"Display the list of dependencies")
> +	@$(call pkg-print-help-opt,$(1)-graph-depends,"Generate a graph of the dependencies")
> +	@$(call pkg-print-help-opt,$(1)-dirclean,"Remove the package build directory")
> +	@$(call pkg-print-help-opt,$(1)-rebuild,"Restart the build from the compile step")
> +	@$(call pkg-print-help-opt,$(1)-reconfigure,"Restart the build from the configure step")
> +	@$(call pkg-print-help-opt,$(1)-legal-info,"Generate legal informations")
> +	$(foreach hook,$$($(2)_HELP_HOOKS),$$(call $(hook))$(sep))
> +
>  # define the PKG variable for all targets, containing the
>  # uppercase package variable prefix
>  $$($(2)_TARGET_INSTALL_TARGET):		PKG=$(2)
> diff --git a/package/pkg-utils.mk b/package/pkg-utils.mk
> index 7eddc47..fbb94cf 100644
> --- a/package/pkg-utils.mk
> +++ b/package/pkg-utils.mk
> @@ -37,6 +37,10 @@ endef
>  $(eval $(call caseconvert-helper,UPPERCASE,$(join $(addsuffix :,$([FROM])),$([TO]))))
>  $(eval $(call caseconvert-helper,LOWERCASE,$(join $(addsuffix :,$([TO])),$([FROM]))))
>  
> +define pkg-print-help-opt
> +	printf "%30s - %s\n" $(1) $(2)
> +endef

As discussed live, I'd rather we have the quotes here rather than in the
make function call. But I agree with you that it is nicer to see syntax
colouring on the strings...

So, what about:

    printf "%30s - %s\n" $(1) "$(cal qstrip,$(2))"

so that we ensure the parameter *is* quoted, but accept already quoted
strings.

Beside, the output is looking like:

                       busybox - Build completely
               busybox-install - Build up to the installation step
        busybox-install-target - Build up to the target installation step
       busybox-install-staging - Build up to the staging installation step
 
I'd rather we left-align, like so:

       busybox                 - Build completely
       busybox-install         - Build up to the installation step
       busybox-install-target  - Build up to the target installation step
       busybox-install-staging - Build up to the staging installation step

(but that's just really very minor)

Regards,
Yann E. MORIN.

>  #
>  # Manipulation of .config files based on the Kconfig
>  # infrastructure. Used by the BusyBox package, the Linux kernel
> -- 
> 2.1.0
> 
> _______________________________________________
> 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] [RFC 2/8] pkg-kconfig: extend per-package help text with kconfig targets

[Thomas Petazzoni]

This commit makes the kconfig-package infrastructure use the
$(2)_HELP_HOOKS mechanism to extend the per-package help text with the
specific kconfig targets. These targets allow to run *config editors,
and perform other configuration related actions.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 package/pkg-kconfig.mk | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/package/pkg-kconfig.mk b/package/pkg-kconfig.mk
index ec58d69..7e7b776 100644
--- a/package/pkg-kconfig.mk
+++ b/package/pkg-kconfig.mk
@@ -36,6 +36,14 @@ $(2)_KCONFIG_EDITORS ?= menuconfig
 $(2)_KCONFIG_OPTS ?=
 $(2)_KCONFIG_FIXUP_CMDS ?=
 
+define $(2)_KCONFIG_PACKAGE_HELP
+	$$(foreach editor,$$($(2)_KCONFIG_EDITORS),\
+            @$(call pkg-print-help-opt,$(1)-$$(editor),"Run the $$(editor) configuration tool")$(sep))
+	@$(call pkg-print-help-opt,$(1)-update-config,"Update configuration")
+endef
+
+$(2)_HELP_HOOKS += $(2)_KCONFIG_PACKAGE_HELP
+
 # FOO_KCONFIG_FILE is required
 ifndef $(2)_KCONFIG_FILE
 $$(error Internal error: no value specified for $(2)_KCONFIG_FILE)
-- 
2.1.0

[Buildroot] [RFC 2/8] pkg-kconfig: extend per-package help text with kconfig targets

[Yann E. MORIN]

Thomas, Al,,

On 2015-01-27 22:41 +0100, Thomas Petazzoni spake thusly:
> This commit makes the kconfig-package infrastructure use the
> $(2)_HELP_HOOKS mechanism to extend the per-package help text with the
> specific kconfig targets. These targets allow to run *config editors,
> and perform other configuration related actions.
> 
> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Regards,
Yann E. MORIN.

> ---
>  package/pkg-kconfig.mk | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/package/pkg-kconfig.mk b/package/pkg-kconfig.mk
> index ec58d69..7e7b776 100644
> --- a/package/pkg-kconfig.mk
> +++ b/package/pkg-kconfig.mk
> @@ -36,6 +36,14 @@ $(2)_KCONFIG_EDITORS ?= menuconfig
>  $(2)_KCONFIG_OPTS ?=
>  $(2)_KCONFIG_FIXUP_CMDS ?=
>  
> +define $(2)_KCONFIG_PACKAGE_HELP
> +	$$(foreach editor,$$($(2)_KCONFIG_EDITORS),\
> +            @$(call pkg-print-help-opt,$(1)-$$(editor),"Run the $$(editor) configuration tool")$(sep))
> +	@$(call pkg-print-help-opt,$(1)-update-config,"Update configuration")
> +endef
> +
> +$(2)_HELP_HOOKS += $(2)_KCONFIG_PACKAGE_HELP
> +
>  # FOO_KCONFIG_FILE is required
>  ifndef $(2)_KCONFIG_FILE
>  $$(error Internal error: no value specified for $(2)_KCONFIG_FILE)
> -- 
> 2.1.0
> 
> _______________________________________________
> 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] [RFC 3/8] linux: add custom per-package help text contents

[Thomas Petazzoni]

Since the linux package is not yet converted to kconfig-package, make
it register its own LINUX_HELP_HOOKS so that its custom make targets
are visible in 'linux-help'.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 linux/linux.mk | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/linux/linux.mk b/linux/linux.mk
index 29f59e8..c2b31e9 100644
--- a/linux/linux.mk
+++ b/linux/linux.mk
@@ -317,6 +317,16 @@ define LINUX_INSTALL_TARGET_CMDS
 	$(LINUX_INSTALL_HOST_TOOLS)
 endef
 
+define LINUX_PACKAGE_HELP
+	@$(foreach editor,menuconfig xconfig gconfig nconfig,\
+		@$(call pkg-print-help-opt,linux-$(editor),"Run the $(editor) configuration tool")$(sep))
+	@$(call pkg-print-help-opt,linux-savedefconfig,"Generate a minimal defconfig")
+	@$(call pkg-print-help-opt,linux-update-config,"Update configuration as a full config file")
+	@$(call pkg-print-help-opt,linux-update-defconfig,"Update configuration as a minimal defconfig")
+endef
+
+LINUX_HELP_HOOKS += LINUX_PACKAGE_HELP
+
 include $(sort $(wildcard linux/linux-ext-*.mk))
 
 $(eval $(generic-package))
-- 
2.1.0

[Buildroot] [RFC 3/8] linux: add custom per-package help text contents

[Yann E. MORIN]

Thomas, All,

On 2015-01-27 22:41 +0100, Thomas Petazzoni spake thusly:
> Since the linux package is not yet converted to kconfig-package, make
> it register its own LINUX_HELP_HOOKS so that its custom make targets
> are visible in 'linux-help'.
> 
> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Regards,
Yann E. MORIN.

> ---
>  linux/linux.mk | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/linux/linux.mk b/linux/linux.mk
> index 29f59e8..c2b31e9 100644
> --- a/linux/linux.mk
> +++ b/linux/linux.mk
> @@ -317,6 +317,16 @@ define LINUX_INSTALL_TARGET_CMDS
>  	$(LINUX_INSTALL_HOST_TOOLS)
>  endef
>  
> +define LINUX_PACKAGE_HELP
> +	@$(foreach editor,menuconfig xconfig gconfig nconfig,\
> +		@$(call pkg-print-help-opt,linux-$(editor),"Run the $(editor) configuration tool")$(sep))
> +	@$(call pkg-print-help-opt,linux-savedefconfig,"Generate a minimal defconfig")
> +	@$(call pkg-print-help-opt,linux-update-config,"Update configuration as a full config file")
> +	@$(call pkg-print-help-opt,linux-update-defconfig,"Update configuration as a minimal defconfig")
> +endef
> +
> +LINUX_HELP_HOOKS += LINUX_PACKAGE_HELP
> +
>  include $(sort $(wildcard linux/linux-ext-*.mk))
>  
>  $(eval $(generic-package))
> -- 
> 2.1.0
> 
> _______________________________________________
> 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] [RFC 4/8] barebox: add custom help entries

[Thomas Petazzoni]

Since the barebox package is not yet converted to kconfig-package,
make it register its own BAREBOX_HELP_HOOKS so that its custom make
targets are visible in 'barebox-help'.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 boot/barebox/barebox.mk | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/boot/barebox/barebox.mk b/boot/barebox/barebox.mk
index 0fb7cec..4a89952 100644
--- a/boot/barebox/barebox.mk
+++ b/boot/barebox/barebox.mk
@@ -106,6 +106,16 @@ define BAREBOX_INSTALL_TARGET_CMDS
 endef
 endif
 
+define BAREBOX_PACKAGE_HELP
+	@$(foreach editor,menuconfig xconfig gconfig nconfig,\
+		@$(call pkg-print-help-opt,barebox-$(editor),"Run the $(editor) configuration tool")$(sep))
+	@$(call pkg-print-help-opt,barebox-savedefconfig,"Generate a minimal defconfig")
+	@$(call pkg-print-help-opt,barebox-update-config,"Update configuration as a full config file")
+	@$(call pkg-print-help-opt,barefbox-update-defconfig,"Update configuration as a minimal defconfig")
+endef
+
+BAREBOX_HELP_HOOKS += BAREBOX_PACKAGE_HELP
+
 $(eval $(generic-package))
 
 ifeq ($(BR2_TARGET_BAREBOX),y)
-- 
2.1.0

[Buildroot] [RFC 4/8] barebox: add custom help entries

[Yann E. MORIN]

Thomas, All,

On 2015-01-27 22:41 +0100, Thomas Petazzoni spake thusly:
> Since the barebox package is not yet converted to kconfig-package,
> make it register its own BAREBOX_HELP_HOOKS so that its custom make
> targets are visible in 'barebox-help'.
> 
> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Regards,
Yann E. MORIN.

> ---
>  boot/barebox/barebox.mk | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/boot/barebox/barebox.mk b/boot/barebox/barebox.mk
> index 0fb7cec..4a89952 100644
> --- a/boot/barebox/barebox.mk
> +++ b/boot/barebox/barebox.mk
> @@ -106,6 +106,16 @@ define BAREBOX_INSTALL_TARGET_CMDS
>  endef
>  endif
>  
> +define BAREBOX_PACKAGE_HELP
> +	@$(foreach editor,menuconfig xconfig gconfig nconfig,\
> +		@$(call pkg-print-help-opt,barebox-$(editor),"Run the $(editor) configuration tool")$(sep))
> +	@$(call pkg-print-help-opt,barebox-savedefconfig,"Generate a minimal defconfig")
> +	@$(call pkg-print-help-opt,barebox-update-config,"Update configuration as a full config file")
> +	@$(call pkg-print-help-opt,barefbox-update-defconfig,"Update configuration as a minimal defconfig")
> +endef
> +
> +BAREBOX_HELP_HOOKS += BAREBOX_PACKAGE_HELP
> +
>  $(eval $(generic-package))
>  
>  ifeq ($(BR2_TARGET_BAREBOX),y)
> -- 
> 2.1.0
> 
> _______________________________________________
> 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] [RFC 5/8] ccache: add custom help entries

[Thomas Petazzoni]

The host-ccache package has some custom targets to get statistics
about ccache or change ccache options. This commit adds a
HOST_CCACHE_HELP_HOOKS to ensure such targets are documented in 'make
host-ccache-help'.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 package/ccache/ccache.mk | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/package/ccache/ccache.mk b/package/ccache/ccache.mk
index 270ea4b..5f86125 100644
--- a/package/ccache/ccache.mk
+++ b/package/ccache/ccache.mk
@@ -58,6 +58,13 @@ endef
 HOST_CCACHE_POST_INSTALL_HOOKS += HOST_CCACHE_DO_INITIAL_SETUP
 endif
 
+define HOST_CCACHE_PACKAGE_HELP
+	@$(call pkg-print-help-opt,ccache-stats,"Show ccache statistics")
+	@$(call pkg-print-help-opt,cache-options,"Update ccache options using CCACHE_OPTIONS variable")
+endef
+
+HOST_CCACHE_HELP_HOOKS += HOST_CCACHE_PACKAGE_HELP
+
 $(eval $(host-autotools-package))
 
 ifeq ($(BR2_CCACHE),y)
-- 
2.1.0

[Buildroot] [RFC 5/8] ccache: add custom help entries

[Baruch Siach]

Hi Thomas,

On Tue, Jan 27, 2015 at 10:41:50PM +0100, Thomas Petazzoni wrote:
[...]
> +define HOST_CCACHE_PACKAGE_HELP
> +	@$(call pkg-print-help-opt,ccache-stats,"Show ccache statistics")
> +	@$(call pkg-print-help-opt,cache-options,"Update ccache options using CCACHE_OPTIONS variable")

s/cache-options/ccache-options/

> +endef
> +
> +HOST_CCACHE_HELP_HOOKS += HOST_CCACHE_PACKAGE_HELP
> +

baruch

-- 
     http://baruch.siach.name/blog/                  ~. .~   Tk Open Systems
=}------------------------------------------------ooO--U--Ooo------------{=
   - baruch at tkos.co.il - tel: +972.2.679.5364, http://www.tkos.co.il -

[Buildroot] [RFC 5/8] ccache: add custom help entries

[Thomas Petazzoni]

Dear Baruch Siach,

On Wed, 28 Jan 2015 07:51:51 +0200, Baruch Siach wrote:

> On Tue, Jan 27, 2015 at 10:41:50PM +0100, Thomas Petazzoni wrote:
> [...]
> > +define HOST_CCACHE_PACKAGE_HELP
> > +	@$(call pkg-print-help-opt,ccache-stats,"Show ccache statistics")
> > +	@$(call pkg-print-help-opt,cache-options,"Update ccache options using CCACHE_OPTIONS variable")
> 
> s/cache-options/ccache-options/

Indeed, thanks for spotting, will fix in the next iteration if people
think the patch series is worthwhile.

Thanks!

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

[Buildroot] [RFC 6/8] Makefile: remove uclibc, barebox, linux, busybox specific help

[Thomas Petazzoni]

Now that each package has its own custom help text, there is no need
to have those busybox, linux, uclibc and barebox specific targets
mentionned in the main help text.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 Makefile | 14 --------------
 1 file changed, 14 deletions(-)

diff --git a/Makefile b/Makefile
index 6cee027..1e5390b 100644
--- a/Makefile
+++ b/Makefile
@@ -868,20 +868,6 @@ help:
 	@echo '  randpackageconfig      - New config with random answer to package options'
 	@echo '  allyespackageconfig    - New config where pkg options are accepted with yes'
 	@echo '  allnopackageconfig     - New config where package options are answered with no'
-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'
-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
 	@echo
 	@echo 'Documentation:'
 	@echo '  manual                 - build manual in all formats'
-- 
2.1.0

[Buildroot] [RFC 6/8] Makefile: remove uclibc, barebox, linux, busybox specific help

[Yann E. MORIN]

Thomas, all,

On 2015-01-27 22:41 +0100, Thomas Petazzoni spake thusly:
> Now that each package has its own custom help text, there is no need
> to have those busybox, linux, uclibc and barebox specific targets
> mentionned in the main help text.
> 
> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Regards,
Yann E. MORIN.

> ---
>  Makefile | 14 --------------
>  1 file changed, 14 deletions(-)
> 
> diff --git a/Makefile b/Makefile
> index 6cee027..1e5390b 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -868,20 +868,6 @@ help:
>  	@echo '  randpackageconfig      - New config with random answer to package options'
>  	@echo '  allyespackageconfig    - New config where pkg options are accepted with yes'
>  	@echo '  allnopackageconfig     - New config where package options are answered with no'
> -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'
> -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
>  	@echo
>  	@echo 'Documentation:'
>  	@echo '  manual                 - build manual in all formats'
> -- 
> 2.1.0
> 
> _______________________________________________
> 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] [RFC 7/8] Makefile: point users to the per-package help text

[Thomas Petazzoni]

Now that each package has its own help text, mention it in the main
help text available from "make help".

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 Makefile | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Makefile b/Makefile
index 1e5390b..adf3558 100644
--- a/Makefile
+++ b/Makefile
@@ -878,6 +878,7 @@ help:
 	@echo '  manual-epub            - build manual in ePub'
 	@echo '  graph-build            - generate graphs of the build times'
 	@echo '  graph-depends          - generate graph of the dependency tree'
+	@echo '  <pkg>-help		- get help about a specific package'
 	@echo
 	@echo 'Miscellaneous:'
 	@echo '  source                 - download all sources needed for offline-build'
-- 
2.1.0

[Buildroot] [RFC 7/8] Makefile: point users to the per-package help text

[Yann E. MORIN]

Thomas, All,

On 2015-01-27 22:41 +0100, Thomas Petazzoni spake thusly:
> Now that each package has its own help text, mention it in the main
> help text available from "make help".
> 
> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Regards,
Yann E. MORIN.

> ---
>  Makefile | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Makefile b/Makefile
> index 1e5390b..adf3558 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -878,6 +878,7 @@ help:
>  	@echo '  manual-epub            - build manual in ePub'
>  	@echo '  graph-build            - generate graphs of the build times'
>  	@echo '  graph-depends          - generate graph of the dependency tree'
> +	@echo '  <pkg>-help		- get help about a specific package'
>  	@echo
>  	@echo 'Miscellaneous:'
>  	@echo '  source                 - download all sources needed for offline-build'
> -- 
> 2.1.0
> 
> _______________________________________________
> 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] [RFC 8/8] docs/manual: update manual about <pkg>-help tagret

[Thomas Petazzoni]

This commit updates the manual to:

 * Indicate the existence of the <pkg>-help target;

 * Remove the explanation about certain targets in "make help" not
   being always visible, since this is no longer true.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 docs/manual/make-tips.txt           | 11 -----------
 docs/manual/package-make-target.txt |  2 ++
 2 files changed, 2 insertions(+), 11 deletions(-)

diff --git a/docs/manual/make-tips.txt b/docs/manual/make-tips.txt
index 027eddf..2ad4dbd 100644
--- a/docs/manual/make-tips.txt
+++ b/docs/manual/make-tips.txt
@@ -18,17 +18,6 @@ This is a collection of tips that help you make the most of Buildroot.
  $ make help
 --------------------
 
-Not all targets are always available,
-some settings in the +.config+ file may hide some targets:
-
-* +busybox-menuconfig+ only works when +busybox+ is enabled;
-* +linux-menuconfig+ and +linux-savedefconfig+ only work when
-  +linux+ is enabled;
-* +uclibc-menuconfig+ is only available when the uClibc C library is
-  selected in the internal toolchain backend;
-* +barebox-menuconfig+ and +barebox-savedefconfig+ only work when the
-  +barebox+ bootloader is enabled.
-
 .Cleaning:
 
 Explicit cleaning is required when any of the architecture or toolchain
diff --git a/docs/manual/package-make-target.txt b/docs/manual/package-make-target.txt
index 25d3f44..4426e5f 100644
--- a/docs/manual/package-make-target.txt
+++ b/docs/manual/package-make-target.txt
@@ -59,6 +59,8 @@ Additionally, there are some other useful make targets:
 |===================================================
 | command/target    | Description
 
+| +help+            | Show the available targets for this package
+
 | +show-depends+    | Displays the dependencies required to build the
 package
 
-- 
2.1.0

[Buildroot] [RFC 8/8] docs/manual: update manual about <pkg>-help tagret

[Yann E. MORIN]

Thomas, All,

On 2015-01-27 22:41 +0100, Thomas Petazzoni spake thusly:
> This commit updates the manual to:
> 
>  * Indicate the existence of the <pkg>-help target;
> 
>  * Remove the explanation about certain targets in "make help" not
>    being always visible, since this is no longer true.

That's unfortunate that we can see such help text even when the packag
is not enabled. But OK...

> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Regards,
Yann E. MORIN.

> ---
>  docs/manual/make-tips.txt           | 11 -----------
>  docs/manual/package-make-target.txt |  2 ++
>  2 files changed, 2 insertions(+), 11 deletions(-)
> 
> diff --git a/docs/manual/make-tips.txt b/docs/manual/make-tips.txt
> index 027eddf..2ad4dbd 100644
> --- a/docs/manual/make-tips.txt
> +++ b/docs/manual/make-tips.txt
> @@ -18,17 +18,6 @@ This is a collection of tips that help you make the most of Buildroot.
>   $ make help
>  --------------------
>  
> -Not all targets are always available,
> -some settings in the +.config+ file may hide some targets:
> -
> -* +busybox-menuconfig+ only works when +busybox+ is enabled;
> -* +linux-menuconfig+ and +linux-savedefconfig+ only work when
> -  +linux+ is enabled;
> -* +uclibc-menuconfig+ is only available when the uClibc C library is
> -  selected in the internal toolchain backend;
> -* +barebox-menuconfig+ and +barebox-savedefconfig+ only work when the
> -  +barebox+ bootloader is enabled.
> -
>  .Cleaning:
>  
>  Explicit cleaning is required when any of the architecture or toolchain
> diff --git a/docs/manual/package-make-target.txt b/docs/manual/package-make-target.txt
> index 25d3f44..4426e5f 100644
> --- a/docs/manual/package-make-target.txt
> +++ b/docs/manual/package-make-target.txt
> @@ -59,6 +59,8 @@ Additionally, there are some other useful make targets:
>  |===================================================
>  | command/target    | Description
>  
> +| +help+            | Show the available targets for this package
> +
>  | +show-depends+    | Displays the dependencies required to build the
>  package
>  
> -- 
> 2.1.0
> 
> _______________________________________________
> 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] [RFC 0/8] Add a per-package help text

[Yann E. MORIN]

Thomas, All,

On 2015-01-27 22:41 +0100, Thomas Petazzoni spake thusly:
> This commit implements one item of our TODO-list, which I believe we
> added at the latest Buildroot meeting: adding a per-package help text
> to document the available make targets for this package.

While reviewing this series, I was wodering if we could also get rid of
the defconfig list in hte main help output, because it moves the real
useful help way out of the terminal.

Instead, add a new target, like "make listdefconfig" that woudl print
this big list, and document that alongside the existing *defconfig
targets.

Thoughts?

Regards,
Yann E. MORIN.

-- 
.-----------------.--------------------.------------------.--------------------.
|  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] [RFC 0/8] Add a per-package help text

[Yann E. MORIN]

Thomas, All,

On 2015-01-27 22:41 +0100, Thomas Petazzoni spake thusly:
> This commit implements one item of our TODO-list, which I believe we
> added at the latest Buildroot meeting: adding a per-package help text
> to document the available make targets for this package.

As discussed live, I've marked this series as being Rejected in our
Patchwork.

Regards,
Yann E. MORIN.

-- 
.-----------------.--------------------.------------------.--------------------.
|  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.  |
'------------------------------^-------^------------------^--------------------'