Skip to content

contribute: Add section on ABI change field annotation - #283

Merged
deb-intel merged 1 commit into
thesofproject:masterfrom
kv2019i:topic/abi-field-documentation
Sep 16, 2020
Merged

contribute: Add section on ABI change field annotation#283
deb-intel merged 1 commit into
thesofproject:masterfrom
kv2019i:topic/abi-field-documentation

Conversation

@kv2019i

Copy link
Copy Markdown
Contributor

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

Comment threadcontribute/process/abiprocess.rst Outdated

@lgirdwoodlgirdwood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I like the idea here, this is useful info.

@ktrzcinx

Copy link
Copy Markdown
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
kv2019iforce-pushed the topic/abi-field-documentation branch from edf9034 to d04a0f9CompareSeptember 11, 2020 13:20
@deb-intel

Copy link
Copy Markdown
Collaborator

@lgirdwood Is this PR ready to be merged?

@lgirdwood

Copy link
Copy Markdown
Member

@deb-intel yes.

@deb-intel
deb-intel merged commit 95e0d7f into thesofproject:masterSep 16, 2020
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@kv2019i@ktrzcinx@deb-intel@lgirdwood@marc-hb