package/bluez5_utils: Clean up descriptions
authorMichael Nosthoff <buildroot@heine.tech>
Wed, 21 Apr 2021 13:17:23 +0000 (15:17 +0200)
committerArnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Mon, 14 Jun 2021 20:25:50 +0000 (22:25 +0200)
The descriptions in this package have grown pretty confusing over time.
Try to make this a bit more consistent and up-to-date.

* drop references to old kernel versions not supported by BR anymore
* Remove "Bluez 5.x" string from options
* consistently use the term "plugin" (plugins implement profiles)
* make mentioned profile appreviations upper-case
* make descriptions closer to the ones in BlueZ Readme [0]
* make clear that "tests" refers to the python test scripts

[0] https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/README?h=5.58

Signed-off-by: Michael Nosthoff <buildroot@heine.tech>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
[Arnout:
 - remove more 5.x references;
 - Use official spelling BlueZ in main help text]

package/bluez5_utils/Config.in

index 016a16c4c5b86b7b9b02ef0cb1a4e327294e5553..2c8625a66db58842d62d7cf901fd35a3540e45a4 100644 (file)
@@ -1,5 +1,5 @@
 config BR2_PACKAGE_BLUEZ5_UTILS
-       bool "bluez-utils 5.x"
+       bool "bluez-utils"
        depends on BR2_USE_WCHAR # libglib2
        depends on BR2_TOOLCHAIN_HAS_THREADS # dbus, libglib2
        depends on BR2_USE_MMU # dbus
@@ -9,17 +9,12 @@ config BR2_PACKAGE_BLUEZ5_UTILS
        select BR2_PACKAGE_DBUS
        select BR2_PACKAGE_LIBGLIB2
        help
-         bluez utils version 5.x
+         BlueZ utils
 
-         With this release BlueZ only supports the new Bluetooth
-         Management kernel interface (introduced in Linux 3.4).
+         Provides Stack, Library and Tooling for Bluetooth Classic
+         and Bluetooth LE.
 
-         For Low Energy support at least kernel version 3.5 is
-         needed.
-
-         The API is not backward compatible with BlueZ 4.
-
-         Bluez utils will use systemd and/or udev if enabled.
+         BlueZ utils will use systemd and/or udev if enabled.
 
          http://www.bluez.org
          http://www.kernel.org/pub/linux/bluetooth
@@ -31,7 +26,7 @@ config BR2_PACKAGE_BLUEZ5_UTILS_OBEX
        depends on BR2_INSTALL_LIBSTDCPP
        select BR2_PACKAGE_LIBICAL
        help
-         Enable the OBEX support in Bluez 5.x.
+         Enable OBEX support.
 
 comment "OBEX support needs a toolchain w/ C++"
        depends on !BR2_INSTALL_LIBSTDCPP
@@ -40,75 +35,77 @@ config BR2_PACKAGE_BLUEZ5_UTILS_CLIENT
        bool "build CLI client"
        select BR2_PACKAGE_READLINE
        help
-         Enable the Bluez 5.x command line client.
+         Build the command line client "bluetoothctl".
 
 config BR2_PACKAGE_BLUEZ5_UTILS_DEPRECATED
-       bool "install deprecated tool"
+       bool "install deprecated tools"
        depends on BR2_PACKAGE_BLUEZ5_UTILS_CLIENT
        help
-         Build BlueZ 5.x deprecated tools. These currently include:
+         Build deprecated tools. These currently include:
          hciattach, hciconfig, hcitool, hcidump, rfcomm, sdptool,
          ciptool, gatttool.
 
 config BR2_PACKAGE_BLUEZ5_UTILS_EXPERIMENTAL
-       bool "build experimental obexd plugin"
+       bool "build experimental tools"
        help
-         Build BlueZ 5.x experimental Nokia OBEX PC Suite plugin
+         Build experimental tools. This is currently only the
+         "Nokia OBEX PC Suite tool". So, only if OBEX support is
+         enabled this option has an effect.
 
 config BR2_PACKAGE_BLUEZ5_UTILS_PLUGINS_HEALTH
        bool "build health plugin"
        help
-         Build BlueZ 5.x health plugin
+         Build plugin for health profiles.
 
 config BR2_PACKAGE_BLUEZ5_UTILS_PLUGINS_MESH
-       bool "build mesh profile"
+       bool "build mesh plugin"
        depends on BR2_TOOLCHAIN_HEADERS_AT_LEAST_4_12 # ell
        select BR2_PACKAGE_ELL
        select BR2_PACKAGE_JSON_C
        select BR2_PACKAGE_READLINE
        help
-         Build BlueZ 5.x mesh plugin
+         Build plugin for Mesh support.
 
 comment "mesh profile needs a toolchain w/ headers >= 4.12"
        depends on !BR2_TOOLCHAIN_HEADERS_AT_LEAST_4_12
 
 config BR2_PACKAGE_BLUEZ5_UTILS_PLUGINS_MIDI
-       bool "build midi profile"
+       bool "build midi plugin"
        select BR2_PACKAGE_ALSA_LIB
        select BR2_PACKAGE_ALSA_LIB_SEQ
        help
-         Build BlueZ 5.x midi plugin
+         Build MIDI support via ALSA sequencer.
 
 config BR2_PACKAGE_BLUEZ5_UTILS_PLUGINS_NFC
        bool "build nfc plugin"
        help
-         Build BlueZ 5.x nfc plugin
+         Build plugin for NFC pairing.
 
 config BR2_PACKAGE_BLUEZ5_UTILS_PLUGINS_SAP
        bool "build sap plugin"
        help
-         Build BlueZ 5.x sap plugin
+         Build plugin for SAP profile.
 
 config BR2_PACKAGE_BLUEZ5_UTILS_PLUGINS_SIXAXIS
        bool "build sixaxis plugin"
        depends on BR2_PACKAGE_HAS_UDEV
        help
-         Build BlueZ 5.x sixaxis plugin (support Sony Dualshock
+         Build sixaxis plugin (support Sony Dualshock
          controller)
 
 comment "sixaxis plugin needs udev /dev management"
        depends on !BR2_PACKAGE_HAS_UDEV
 
 config BR2_PACKAGE_BLUEZ5_UTILS_TEST
-       bool "build tests"
+       bool "install test scripts"
        help
-         Build BlueZ 5.x tests
+         Install the python test scripts from the "test" directory.
 
 config BR2_PACKAGE_BLUEZ5_UTILS_TOOLS_HID2HCI
        bool "build hid2hci tool"
        depends on BR2_PACKAGE_HAS_UDEV
        help
-         Build BlueZ 5.x hid2hci tool
+         Build hid2hci tool
 
 comment "hid2hci tool needs udev /dev management"
        depends on !BR2_PACKAGE_HAS_UDEV