package/busybox: add comment about BR2_PACKAGE_BUSYBOX_SHOW_OTHERS

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@free.fr>
Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Cc: Peter Korsgaard <peter@korsgaard.com>
Cc: Romain Naour <romain.naour@openwide.fr>
Reviewed-by: Romain Naour <romain.naour@gmail.com>
[Thomas: slightly improve the wording of one of the comment.]
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

diff --git a/package/busybox/Config.in b/package/busybox/Config.in
index 91c5d9eff317c5e902b48d310ab92ce3e71b45a8..7ef3f0eda83b33e993e3019bbceb2ac788424165 100644 (file)
--- 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