Skip to content

Commit 3f6ee3d

Browse files
jgross1jbeulich
authored andcommitted
xen/public: add comments regarding interface version bumps
domctl.h and sysctl.h have an interface version, which needs to be bumped in case of incompatible modifications of the interface. In order to avoid misunderstandings, add a comment to both headers specifying in which cases a bump is needed. Signed-off-by: Juergen Gross <[email protected]> Reviewed-by: Jan Beulich <[email protected]> Acked-by: Julien Grall <[email protected]>
1 parent 93af5cc commit 3f6ee3d

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

xen/include/public/domctl.h

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,16 @@
2121
#include "hvm/save.h"
2222
#include "memory.h"
2323

24+
/*
25+
* The interface version needs to be incremented by 1 in case the interface
26+
* is modified in an incompatible way AND if the version hasn't been
27+
* incremented in the current development cycle already.
28+
* Pure additions (e.g. new sub-commands) or compatible interface changes
29+
* (e.g. adding semantics to 0-checked input fields or data to zeroed output
30+
* fields) don't require a change of the version.
31+
*
32+
* Last version bump: Xen 4.19
33+
*/
2434
#define XEN_DOMCTL_INTERFACE_VERSION 0x00000017
2535

2636
/*

xen/include/public/sysctl.h

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@
1818
#include "domctl.h"
1919
#include "physdev.h"
2020

21+
/*
22+
* The interface version needs to be incremented by 1 in case the interface
23+
* is modified in an incompatible way AND if the version hasn't been
24+
* incremented in the current development cycle already.
25+
* Pure additions (e.g. new sub-commands) or compatible interface changes
26+
* (e.g. adding semantics to 0-checked input fields or data to zeroed output
27+
* fields) don't require a change of the version.
28+
*
29+
* Last version bump: Xen 4.17
30+
*/
2131
#define XEN_SYSCTL_INTERFACE_VERSION 0x00000015
2232

2333
/*

0 commit comments

Comments
 (0)