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

dts: bindings: stepper: use hyphens instead of underscore #83842

Conversation

jilaypandya
Copy link
Contributor

This commit replaces hyphens with underscore in order to comply with devicetree standards

@rruuaanng
Copy link
Collaborator

That's great! But it seems there are no changes to the DTS files. Hopefully, we didn't miss any DTS files.

rruuaanng
rruuaanng previously approved these changes Jan 11, 2025
faxe1008
faxe1008 previously approved these changes Jan 11, 2025
fabiobaltieri
fabiobaltieri previously approved these changes Jan 12, 2025
Copy link
Collaborator

@kartben kartben left a comment

Choose a reason for hiding this comment

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

needs migration guide entry (unless they were added post 4.0, maybe?)

@rruuaanng
Copy link
Collaborator

Perhaps the proposed changes will be implemented in the 4.1 release. Adding a migration for version 4.1 might be more appropriate, as these property names are still present in the 4.0 release.
(I think)

This commit replaces hyphens with underscore in order to comply with
devicetree standards

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
@jilaypandya jilaypandya force-pushed the fix/use_hyphens_instead_of_underscore branch from 458d326 to 2263c6d Compare January 16, 2025 10:58
@zephyrbot zephyrbot added the Release Notes To be mentioned in the release notes label Jan 16, 2025
@@ -279,6 +279,17 @@ Stepper
:kconfig:option:`STEPPER_ADI_TMC5041_RAMP_GEN` option.
* To control the velocity for :dtcompatible:`adi,tmc5041` stepper driver, use
:c:func:`tmc5041_stepper_set_max_velocity` or :c:func:`tmc5041_stepper_set_ramp`.
* Renamed following DeviceTree properties:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Perhaps listing them individually would be better, as there are too many of them, and this approach would align better with the existing style of the migration entry.

E.g.

* Renamed the devicetree property ``en_spreadcycle`` to ``en-spreadcycle``.
* ...

add migration guide for following renamed variables
 - ``en_spreadcycle`` to ``en-spreadcycle``
- ``i_scale_analog`` to ``i-scale-analog``
- ``index_optw``to ``index-otpw```
- ``ìndex_step`` to ``index-step``
- ``internal_rsense`` to ``internal-rsense``
- ``lock_gconf`` to ``lock-gconf``
- ``mstep_reg_select`` to ``mstep-reg-select``
- ``pdn_disable`` to ``pdn-disable``
- ``poscmp_enable`` to ``poscmp-enable``
- ``test_mode`` to ``test-mode``

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
@jilaypandya jilaypandya force-pushed the fix/use_hyphens_instead_of_underscore branch from 2263c6d to 01572d6 Compare January 16, 2025 11:11
@jilaypandya jilaypandya requested a review from rruuaanng January 16, 2025 11:11
@jilaypandya
Copy link
Contributor Author

jilaypandya commented Jan 21, 2025

needs migration guide entry (unless they were added post 4.0, maybe?)

@kartben Done

@kartben kartben merged commit 1b39277 into zephyrproject-rtos:main Jan 21, 2025
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Stepper Release Notes To be mentioned in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants