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

devicetree: remove label property accessors #66001

Conversation

mbolivar-ampere
Copy link
Contributor

These were first deprecated in v3.2. We have kept support for them for as long as we can, but now their presence is causing CI failures in some configurations. Specifically, using the deprecated 'label' property is causing a warning which is promoted to an error in some twister runs. This is blocking other forward progress in the devicetree API.

I tried to rework the tests to avoid this, but it was too much effort for the time I had to work on the task. Removing the APIs is therefore unfortunately the best way forward to unblocking other work.

Re-work the test suite a bit to maintain coverage where we are using the label property to test other macros.

Add a migration guide section to help with the transition.

These were first deprecated in v3.2. We have kept support for them
for as long as we can, but now their presence is causing CI failures
in some configurations. Specifically, using the deprecated 'label'
property is causing a warning which is promoted to an error in some
twister runs. This is blocking other forward progress in the
devicetree API.

I tried to rework the tests to avoid this, but it was too much effort
for the time I had to work on the task. Removing the APIs is therefore
unfortunately the best way forward to unblocking other work.

Re-work the test suite a bit to maintain coverage where we are using
the label property to test other macros.

Add a migration guide section to help with the transition.

Signed-off-by: Martí Bolívar <[email protected]>
@mbolivar-ampere mbolivar-ampere force-pushed the remove-dt-label-property-accessors branch from 7989dac to 0426743 Compare December 1, 2023 00:09
@mbolivar-ampere mbolivar-ampere merged commit b1532ce into zephyrproject-rtos:main Dec 1, 2023
18 checks passed
@kartben
Copy link
Collaborator

kartben commented Dec 1, 2023

@mbolivar-ampere a kind reminder that PRs should generally stay open for at least two business days before getting merged. https://docs.zephyrproject.org/latest/project/project_roles.html#merge-criteria
Thanks!

@mbolivar-ampere mbolivar-ampere added the Hotfix Fix for issues blocking development, i.e. CI issues, tests failing in CI, etc. label Dec 1, 2023
@mbolivar-ampere
Copy link
Contributor Author

@kartben Thanks for the reminder! I think there is no problem here, though. That document states:

Hotfixes can be merged at any time after CI has passed and are excluded from most of the conditions listed above.

Where a hotfix is defined as an issue that is blocking development. This certainly qualifies. I have added the label since it was missing just for the record.

@kartben
Copy link
Collaborator

kartben commented Dec 1, 2023

Sounds good, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Devicetree Binding PR modifies or adds a Device Tree binding area: Devicetree Hotfix Fix for issues blocking development, i.e. CI issues, tests failing in CI, etc. Release Notes To be mentioned in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants