* [Buildroot] [PATCH] package/bluez5_utils: Clean up descriptions
@ 2021-04-21 13:17 Michael Nosthoff
2021-06-14 20:29 ` Arnout Vandecappelle
2021-06-21 19:44 ` Peter Korsgaard
0 siblings, 2 replies; 3+ messages in thread
From: Michael Nosthoff @ 2021-04-21 13:17 UTC (permalink / raw
To: buildroot
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>
---
package/bluez5_utils/Config.in | 45 ++++++++++++++++------------------
1 file changed, 21 insertions(+), 24 deletions(-)
diff --git a/package/bluez5_utils/Config.in b/package/bluez5_utils/Config.in
index 016a16c4c5..f79155997a 100644
--- a/package/bluez5_utils/Config.in
+++ b/package/bluez5_utils/Config.in
@@ -11,13 +11,8 @@ config BR2_PACKAGE_BLUEZ5_UTILS
help
bluez utils version 5.x
- With this release BlueZ only supports the new Bluetooth
- Management kernel interface (introduced in Linux 3.4).
-
- For Low Energy support at least kernel version 3.5 is
- needed.
-
- The API is not backward compatible with BlueZ 4.
+ Provides Stack, Library and Tooling for Bluetooth Classic
+ and Bluetooth LE.
Bluez utils will use systemd and/or udev if enabled.
@@ -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
--
2.25.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [Buildroot] [PATCH] package/bluez5_utils: Clean up descriptions
2021-04-21 13:17 [Buildroot] [PATCH] package/bluez5_utils: Clean up descriptions Michael Nosthoff
@ 2021-06-14 20:29 ` Arnout Vandecappelle
2021-06-21 19:44 ` Peter Korsgaard
1 sibling, 0 replies; 3+ messages in thread
From: Arnout Vandecappelle @ 2021-06-14 20:29 UTC (permalink / raw
To: buildroot
On 21/04/2021 15:17, Michael Nosthoff via buildroot wrote:
> 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>
Applied to master, thanks.
I made two more changes:
- removed 5.x from the prompt and main help text as well;
- spell as BlueZ in the main help text.
Regards,
Arnout
> ---
> package/bluez5_utils/Config.in | 45 ++++++++++++++++------------------
> 1 file changed, 21 insertions(+), 24 deletions(-)
>
> diff --git a/package/bluez5_utils/Config.in b/package/bluez5_utils/Config.in
> index 016a16c4c5..f79155997a 100644
> --- a/package/bluez5_utils/Config.in
> +++ b/package/bluez5_utils/Config.in
> @@ -11,13 +11,8 @@ config BR2_PACKAGE_BLUEZ5_UTILS
> help
> bluez utils version 5.x
>
> - With this release BlueZ only supports the new Bluetooth
> - Management kernel interface (introduced in Linux 3.4).
> -
> - For Low Energy support at least kernel version 3.5 is
> - needed.
> -
> - The API is not backward compatible with BlueZ 4.
> + Provides Stack, Library and Tooling for Bluetooth Classic
> + and Bluetooth LE.
>
> Bluez utils will use systemd and/or udev if enabled.
>
> @@ -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
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* [Buildroot] [PATCH] package/bluez5_utils: Clean up descriptions
2021-04-21 13:17 [Buildroot] [PATCH] package/bluez5_utils: Clean up descriptions Michael Nosthoff
2021-06-14 20:29 ` Arnout Vandecappelle
@ 2021-06-21 19:44 ` Peter Korsgaard
1 sibling, 0 replies; 3+ messages in thread
From: Peter Korsgaard @ 2021-06-21 19:44 UTC (permalink / raw
To: buildroot
>>>>> "Michael" == Michael Nosthoff via buildroot <buildroot@busybox.net> writes:
> 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>
Committed to 2021.02.x and 2021.05.x, thanks.
--
Bye, Peter Korsgaard
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-06-21 19:44 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-04-21 13:17 [Buildroot] [PATCH] package/bluez5_utils: Clean up descriptions Michael Nosthoff
2021-06-14 20:29 ` Arnout Vandecappelle
2021-06-21 19:44 ` Peter Korsgaard
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.