edtlib: amend PropertySpec.path API documentation #83457
Merged
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.
PropertySpec.pathdoes not tell "the file where the property was last modified", but instead the binding file specifying the devicetree node of which this is a property.This is a known issue (#65135), which we thought was fixed (#65221). The solution turned out to be incorrect, and we reverted the patch (#80030).
This PR aims to definitively close #65135 by simply amending the API documentation:
edtlib: amend PropertySpec.path API documentation.While writing this PR, I came across another wording that I found confusing (class
edtlib.Node):AFAICT, assuming that "mentioned in 'properties:' in the binding" refers to properties whose specification we find in
Node._binding.prop2specs, node properties are created only for those that actually have a value (a default value from the binding, or an explicit value from the DTS).And usually a node has fewer properties than its binding defines (supports), literally
len(node._binding.prop2specs) > len(node.props).If the above reasoning is correct, then the API documentation seems confusing to me: the additional commit,
edtlib: amend Node.props API documentation, is about that.Thanks
Fixes #65135.