Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bluetooth: Controller: Fix bt_ctrl to bt_ctlr abbreviation #81773

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

cvinayak
Copy link
Contributor

The Controller is abbreviated as CTLR in contrast to CTRL
which is used in the context of Link Layer Control
Procedures.

Fix to rename BT_CTRL_ADV_ADI_IN_SCAN_RSP to
BT_CTLR_ADV_ADI_IN_SCAN_RSP.

The Controller is abbreviated as CTLR in contrast to CTRL
which is used in the context of Link Layer Control
Procedures.

Signed-off-by: Vinayak Kariappa Chettimada <[email protected]>
jhedberg
jhedberg previously approved these changes Nov 22, 2024
Comment on lines 495 to +499
config BT_CTRL_ADV_ADI_IN_SCAN_RSP
bool "Include ADI in AUX_SCAN_RSP PDU [DEPRECATED]"
depends on BT_BROADCASTER && BT_CTLR_ADV_EXT
select BT_CTLR_ADV_ADI_IN_SCAN_RSP
select DEPRECATED
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit of a slippery slope effect here, but now that you did the formal deprecation it means that this should also be mentioned in doc/releases/migration-guide-4.1.rst (or maybe it was the release notes - please double check where deprecations are normally listed)

Bluetooth Controller
====================

* The following Kconfig option have been renamed:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The following Kconfig option have been renamed:
* The following Kconfig option has been renamed:

Comment on lines 123 to 124
* :kconfig:option:`CONFIG_BT_CTRL_ADV_ADI_IN_SCAN_RSP` to
:kconfig:option:`CONFIG_BT_CTLR_ADV_ADI_IN_SCAN_RSP`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider whether a list with a single element is the best choice :)

@@ -489,7 +489,7 @@ Bluetooth
``ticks_slot_window``. Implement continuous scanning with it.
* Added support for considering the SDU interval, along with the packet
sequence number and time stamps, in SDU fragmentation.
* Added a new ``BT_CTRL_TX_PWR_DBM`` option to set the TX power directly in
* Added a new ``BT_CTLR_TX_PWR_DBM`` option to set the TX power directly in
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Added a new ``BT_CTLR_TX_PWR_DBM`` option to set the TX power directly in
* Added a new ``BT_CTRL_TX_PWR_DBM`` option to set the TX power directly in

Old release notes should not be modified

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Old release notes have been modified post release tags to keep the latest documentation link to old release notes fixed for typo, correctness and style changes etc... that is what I see in the history of the release notes files.

@kartben can correct me.

@fabiobaltieri fabiobaltieri assigned Thalley and unassigned kartben Nov 22, 2024
@fabiobaltieri fabiobaltieri removed their assignment Nov 22, 2024
@Thalley Thalley assigned cvinayak and unassigned Thalley Nov 22, 2024
Fix to rename BT_CTRL_ADV_ADI_IN_SCAN_RSP to
BT_CTLR_ADV_ADI_IN_SCAN_RSP.

Signed-off-by: Vinayak Kariappa Chettimada <[email protected]>
@cvinayak cvinayak force-pushed the github_bt_ctrl_to_bt_ctlr_fix branch from 3dda4c1 to 468580f Compare November 23, 2024 04:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants