Skip to content

contribute: Add section on ABI change field annotation #283

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.

Sign up for GitHub

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

Merged
deb-intel merged 1 commit into from
Sep 16, 2020
Merged

contribute: Add section on ABI change field annotation #283

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions contribute/process/abiprocess.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,26 @@ kernel side shall include code that deals with older firmware and
topology files. See :ref:`development_tree` for kernel side
documentation.

Documenting modified fields
***************************

When the interface is extended with a backwards compatible (MINOR) interface
change, each added or modified interface field must be documented
with a reference to the interface version, where the change was
first implemented. Some code examples:

.. code-block:: c

struct foo {
uint8_t group_id; /**< group ID, 0 means no group (ABI3.17) */
} __attribute__((packed));

.. code-block:: c

enum bar {
EXT_MAN_ELEM_FOO_DATA = 7, /**< ABI3.18 */
};

ABI change approvers
********************

Expand Down