Re: [PATCH] bluetooth: document config options

From	Marcel Holtmann <marcel@holtmann.org>
Newsgroups	linux.kernel
Subject	Re: [PATCH] bluetooth: document config options
Date	2017-08-07 08:40 +0200
Message-ID	<ubJRL-4Fq-15@gated-at.bofh.it> (permalink)
References	<u5B0S-1Xy-15@gated-at.bofh.it> <u5CT0-3b5-25@gated-at.bofh.it> <u5DFo-3I1-27@gated-at.bofh.it>
Organization	linux.* mail to news gateway

Show all headers | View raw

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."
>> 
> 
> Ok, works for me.
> 
>>> +	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."
>> 
> 
> Ok.

are you planning to send a patch with updated wording for this?

Regards

Marcel

Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

Re: [PATCH] bluetooth: document config options Marcel Holtmann <marcel@holtmann.org> - 2017-08-07 08:40 +0200
  [PATCHv2] bluetooth: document config options Pavel Machek <pavel@ucw.cz> - 2017-08-08 15:50 +0200
    Re: [PATCHv2] bluetooth: document config options Marcel Holtmann <marcel@holtmann.org> - 2017-08-08 16:10 +0200

csiph-web