Dt docs for 2.3 part 3, and some test cases as well #25685
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
At some point, "child-binding:" apparently only worked up to 2 levels deep. That's not the case anymore, but add a regression test to make sure that doesn't break. 3 levels deep ought to be enough for anyone. Signed-off-by: Martí Bolívar <[email protected]>
Remove some deprecated or obsolete functionality: - the 'title:' key is now deprecated - more than 2 levels of child-binding are now supported Signed-off-by: Martí Bolívar <[email protected]>
This is preparation for an additional test suite specifically for the legacy API which will be added next. Signed-off-by: Martí Bolívar <[email protected]>
mbolivar-nordic
added
bug
mbolivar-nordic
requested review from
carlescufi,
galak,
henrikbrixandersen,
mnkp,
pabigot and
ulfalizer
Contributor
Author
|
@hakonfam you originally proposed the migration guide, so any feedback on this effort would be welcome. Thanks! |
zephyrbot
added
area: Devicetree
area: Samples
|
All checks are passing now. Tip: The bot edits this comment instead of posting a new one, so you can check the comment's history to see earlier messages. |
pabigot
reviewed
May 28, 2020
mbolivar-nordic
force-pushed
the
dt-docs-for-2.3-part-3
branch
from
79a0c0c to
50b753d
Compare
galak
requested changes
May 28, 2020
Contributor
galak
left a comment
galak
left a comment
There was a problem hiding this comment.
Looks good, beyond addition of samples/hello_world/app.overlay
mbolivar-nordic
force-pushed
the
dt-docs-for-2.3-part-3
branch
2 times, most recently
from
5efe57c to
4bc1db8
Compare
galak
approved these changes
May 28, 2020
Contributor
galak
left a comment
galak
left a comment
There was a problem hiding this comment.
Not sure if you can add a license/copyright header to migration-example.inc to make scancode happy.
pabigot
approved these changes
May 28, 2020
Contributor
Author
I tried that with the C file but I couldn't get the presentation to come out right using |
Add test cases that verify various bits and pieces of the legacy devicetree macros match the new APIs. Writing these test cases without giving rise to deprecated macro warnings which might break people's CI if they build with -Werror requires turning off the __WARN() generation in devicetree_legacy_unfixed.h. The entire file is deprecated at this point and must be explicitly enabled with an opt-in Kconfig option, so there isn't any harm in doing this. Nevertheless, take a minimally invasive approach to avoiding __WARN() generation in gen_legacy_defines.py, to avoid the possibility of breakage. This code is basically frozen anyway, so hacks like this won't cause maintainability problems since it isn't being actively maintained. Use the new tests as fodder for a migration guide from the old API in the documentation. Signed-off-by: Martí Bolívar <[email protected]>
I believe the devicetree documentation for the release is in good enough shape now. Add a few more links to the release notes to provide users with more hints for adapting to the new API. Signed-off-by: Martí Bolívar <[email protected]>
mbolivar-nordic
force-pushed
the
dt-docs-for-2.3-part-3
branch
from
4bc1db8 to
45bb529
Compare
carlescufi
approved these changes
May 28, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Along with #25633 and #25470 (already merged), this PR:
Fixes: #25469
By:
I wanted to make sure the migration guide doesn't regress and the bindings restriction is indeed lifted in perpetuity, so I added test cases as well. I did have to touch gen_legacy_defines.py to make those tests cases not throw warnings about deprecated macros.
With this PR, I also give my sign-off to the DT release notes for #22637.