You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your enhancement proposal related to a problem? Please describe.
Periodic Advertising, Periodic Advertising List, Filter Accept List, and Resolving List use abbreviations per_adv, pal, fal and rl respectively, which are "It is hard to figure out what is it until you are in the topic."
Originally, pl was used for Periodic Advertising List as pal would overlapped with 802.11 PAL in BT Spec
pa is popular for Power Amplifier
PER is abbreviation for Peripheral in the Bluetooth Test Specification
per is a word in itself having different meaning, like in "as per" something
I see no real reason not to use pal, fal and rl. Those are the literal abbreviations of the spec terms, and this is internal code, not public APIs. My vote goes to staying with those.
Even the code is internal it should be as readable as possible. That would not intimidate new developers that want to contribute to the implementation.
The abbreviations are not used in BT Core Spec. @Thalley can confirm that, because he has verified it.
What more there is a number of abbreviations used in the Bluetooth stack. These are ok for people that are already experienced in development of the stack and read the code related with periodic advertiser list, filter accept list, resolving list. If one hadn't been familiar with the features of the protocol and hadn't done anything in that areas of the stack, then it would be hard to guess what the abbreviations mean.
In my humble opinion, we should avoid making steeper already steep learning curve of the stack implementation.
Is your enhancement proposal related to a problem? Please describe.
Periodic Advertising, Periodic Advertising List, Filter Accept List, and Resolving List use abbreviations
per_adv
,pal
,fal
andrl
respectively, which are "It is hard to figure out what is it until you are in the topic."pl
was used for Periodic Advertising List aspal
would overlapped with 802.11 PAL in BT Specpa
is popular for Power AmplifierPER
is abbreviation for Peripheral in the Bluetooth Test Specificationper
is a word in itself having different meaning, like in "as per" somethingRefer to discussions here:
Describe the solution you'd like
Baseline the variable abbreviations in this issue, and take actions to refactor implementation to reflect the decided namings.
Describe alternatives you've considered
Keep the
per_adv
,pal
,fal
andrl
until a consensus is reached on an adopted rules for variable namingAdditional context
None for now.
The text was updated successfully, but these errors were encountered: