contribute: Add section on ABI change field annotation #283
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
marc-hb
reviewed
Sep 7, 2020
lgirdwood
reviewed
Sep 9, 2020
Member
lgirdwood
left a comment
lgirdwood
left a comment
There was a problem hiding this comment.
I like the idea here, this is useful info.
Member
|
In this way we can't fully track deleted ABI members, imho it's perhaps the least pressing way of documenting ABI changes, and convenient in usage - ABI version is near field which I handle, so I can give a like 👍🏼 |
Add a new section and guidance on how new and/or modified ABI fields and enumerations must be documented in the header files. Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
kv2019i
force-pushed
the
topic/abi-field-documentation
branch
from
edf9034 to
d04a0f9
Compare
marc-hb
approved these changes
Sep 11, 2020
lgirdwood
approved these changes
Sep 14, 2020
Collaborator
|
@lgirdwood Is this PR ready to be merged? |
Member
|
@deb-intel yes. |
deb-intel
approved these changes
Sep 16, 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.
Add a new section and guidance on how new and/or modified ABI
fields and enumerations must be documented in the header files.
Signed-off-by: Kai Vehmanen kai.vehmanen@linux.intel.com