lkml.org 
[lkml]   [2017]   [Jul]   [21]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH] bluetooth: document config options
From
Date
Hi Pavel,

> Kernel config options should include useful help text; I had to look
> up the terms on wikipedia.
>
> Signed-off-by: Pavel Machek <pavel@ucw.cz>
>
> diff --git a/net/bluetooth/Kconfig b/net/bluetooth/Kconfig
> index 68f951b..133c8a6 100644
> --- a/net/bluetooth/Kconfig
> +++ b/net/bluetooth/Kconfig
> @@ -45,6 +45,8 @@ config BT_BREDR
> bool "Bluetooth Classic (BR/EDR) features"
> depends on BT
> default y
> + help
> + Support Bluetooth version 1 and 2 connections.

so this is actually not correct. Version 5.0 is also Bluetooth BR/EDR.

I am fine if use the terms "Basic Rate" and "Enhanced Data Rate" in the description, but the version numbers are kinda not how this works. So some alternative wording needs to be used:

"Bluetooth Classic includes support for Basic Rate (BR) available with Bluetooth version 1.0b or later and support for Enhanced Data Rate (EDR) available with Bluetooth version 2.0 or later."

> source "net/bluetooth/rfcomm/Kconfig"
>
> @@ -58,11 +60,17 @@ config BT_HS
> bool "Bluetooth High Speed (HS) features"
> depends on BT_BREDR
> default y
> + help
> + Bluetooth 3 introduces high-speed mode where bluetooth endpoints
> + negotiate fast connection over WIFI. This controls its support.

Again, while Bluetooth version 3.0 introduces HS support, it is not what is selecting this.

I think here we can write something like this:

"Bluetooth High Speed includes support for off-loading Bluetooth connections via 802.11 physical layer available with Bluetooth version 3.0 or later."

>
> config BT_LE
> bool "Bluetooth Low Energy (LE) features"
> depends on BT
> default y
> + help
> + Bluetooth 4 introduces special low-energy protocol, designed
> + for simple devices. This controls its support.

I think here it is also better to have an alternative text:

"Bluetooth Low Energy includes support low-energy physical layer available with Bluetooth version 4.0 or later."

Regards

Marcel

\
 
 \ /
  Last update: 2017-07-21 11:56    [W:0.048 / U:1.556 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site