[Buildroot] [git commit] package/busybox: add comment about BR2_PACKAGE_BUSYBOX_SHOW_OTHERS

Thomas Petazzoni thomas.petazzoni at free-electrons.com
Mon Jul 18 21:29:01 UTC 2016


commit: https://git.buildroot.net/buildroot/commit/?id=781c85eb38ba43735218e906e319d6acee6846d7
branch: https://git.buildroot.net/buildroot/commit/?id=refs/heads/master

BR2_PACKAGE_BUSYBOX_SHOW_OTHERS is a bit special. When Busybox is
enabled, it is a Busybox option. When Busybox is not enabled, it is a
stand-alone option, forcibly enabled.

So we can safely 'select' it without ensuring (via a 'depends on' or
another 'select') that Busybox is enabled.

However, the name of this option does not express the fact that it is
safe to select it without checking Busybox, which can lead to a bit of
time-consuming head-scratching.

To avoid future puzzlement from an unsuspecting observer, add a a big
fat comment that this option can be selected without any dependency on
Busybox.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998 at free.fr>
Cc: Thomas Petazzoni <thomas.petazzoni at free-electrons.com>
Cc: Peter Korsgaard <peter at korsgaard.com>
Cc: Romain Naour <romain.naour at openwide.fr>
Reviewed-by: Romain Naour <romain.naour at gmail.com>
[Thomas: slightly improve the wording of one of the comment.]
Signed-off-by: Thomas Petazzoni <thomas.petazzoni at free-electrons.com>
---
 package/busybox/Config.in | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/package/busybox/Config.in b/package/busybox/Config.in
index 91c5d9e..7ef3f0e 100644
--- a/package/busybox/Config.in
+++ b/package/busybox/Config.in
@@ -26,6 +26,8 @@ config BR2_PACKAGE_BUSYBOX_CONFIG_FRAGMENT_FILES
 	  A space-separated list of configuration fragment files,
 	  that will be merged to the main BusyBox configuration file.
 
+# This option is not an option of Busybox, it can be selected even
+# if Busybox is not enabled.
 config BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
 	bool "Show packages that are also provided by busybox"
 	help
@@ -75,8 +77,10 @@ endif
 
 if !BR2_PACKAGE_BUSYBOX # kconfig doesn't support else
 
-# add dummy config so the stuff with busybox alternatives are shown
-# when busybox is disabled
+# This option is not an option of Busybox, it can be selected even if
+# Busybox is not enabled. This dummy option ensures that packages that
+# depend on BR2_PACKAGE_BUSYBOX_SHOW_OTHERS are visible when Busybox
+# is disabled.
 config BR2_PACKAGE_BUSYBOX_SHOW_OTHERS
 	default y
 endif


More information about the buildroot mailing list