Skip to content

Commit d04a0f9

Browse files
committed
contribute: Add section on ABI change field annotation
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>
1 parent fb587f2 commit d04a0f9

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

contribute/process/abiprocess.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,26 @@ kernel side shall include code that deals with older firmware and
4141
topology files. See :ref:`development_tree` for kernel side
4242
documentation.
4343

44+
Documenting modified fields
45+
***************************
46+
47+
When the interface is extended with a backwards compatible (MINOR) interface
48+
change, each added or modified interface field must be documented
49+
with a reference to the interface version, where the change was
50+
first implemented. Some code examples:
51+
52+
.. code-block:: c
53+
54+
struct foo {
55+
uint8_t group_id; /**< group ID, 0 means no group (ABI3.17) */
56+
} __attribute__((packed));
57+
58+
.. code-block:: c
59+
60+
enum bar {
61+
EXT_MAN_ELEM_FOO_DATA = 7, /**< ABI3.18 */
62+
};
63+
4464
ABI change approvers
4565
********************
4666

0 commit comments

Comments
 (0)