diff options
| author | Drew DeVault <sir@cmpwn.com> | 2018-07-29 19:33:09 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-07-29 19:33:09 -0400 |
| commit | 1c7957cdc1b9bc395510ab7decc1394c1bcd1206 (patch) | |
| tree | 01980ec58ae327d782db99d263a822676e226d7e /include/wlr/util | |
| parent | e67cb8c07ced35be9dc009effb75af05dc4403e4 (diff) | |
| parent | 211ae764fdbf585d1cf3d17dddad346b42a93f98 (diff) | |
Merge pull request #1131 from swaywm/initial-stable
Initial pass on API stability guarantees
Diffstat (limited to 'include/wlr/util')
| -rw-r--r-- | include/wlr/util/edges.h | 16 | ||||
| -rw-r--r-- | include/wlr/util/log.h | 16 | ||||
| -rw-r--r-- | include/wlr/util/region.h | 17 |
3 files changed, 48 insertions, 1 deletions
diff --git a/include/wlr/util/edges.h b/include/wlr/util/edges.h index 53268323..bf1eb1e7 100644 --- a/include/wlr/util/edges.h +++ b/include/wlr/util/edges.h @@ -1,3 +1,19 @@ +/* + * This is a stable interface of wlroots. Future changes will be limited to: + * + * - New functions + * - New struct members + * - New enum members + * + * Note that wlroots does not make an ABI compatibility promise - in the future, + * the layout and size of structs used by wlroots may change, requiring code + * depending on this header to be recompiled (but not edited). + * + * Breaking changes are announced by email and follow a 1-year deprecation + * schedule. Send an email to ~sircmpwn/wlroots-announce+subscribe@lists.sr.ht + * to receive these announcements. + */ + #ifndef WLR_UTIL_EDGES_H #define WLR_UTIL_EDGES_H diff --git a/include/wlr/util/log.h b/include/wlr/util/log.h index 098a020d..7b0070bb 100644 --- a/include/wlr/util/log.h +++ b/include/wlr/util/log.h @@ -1,3 +1,19 @@ +/* + * This is a stable interface of wlroots. Future changes will be limited to: + * + * - New functions + * - New struct members + * - New enum members + * + * Note that wlroots does not make an ABI compatibility promise - in the future, + * the layout and size of structs used by wlroots may change, requiring code + * depending on this header to be recompiled (but not edited). + * + * Breaking changes are announced by email and follow a 1-year deprecation + * schedule. Send an email to ~sircmpwn/wlroots-announce+subscribe@lists.sr.ht + * to receive these announcements. + */ + #ifndef WLR_UTIL_LOG_H #define WLR_UTIL_LOG_H diff --git a/include/wlr/util/region.h b/include/wlr/util/region.h index c0fe6063..32387bfb 100644 --- a/include/wlr/util/region.h +++ b/include/wlr/util/region.h @@ -1,6 +1,21 @@ +/* + * This is a stable interface of wlroots. Future changes will be limited to: + * + * - New functions + * - New struct members + * - New enum members + * + * Note that wlroots does not make an ABI compatibility promise - in the future, + * the layout and size of structs used by wlroots may change, requiring code + * depending on this header to be recompiled (but not edited). + * + * Breaking changes are announced by email and follow a 1-year deprecation + * schedule. Send an email to ~sircmpwn/wlroots-announce+subscribe@lists.sr.ht + * to receive these announcements. + */ + #ifndef WLR_UTIL_REGION_H #define WLR_UTIL_REGION_H - #include <pixman.h> #include <wayland-server.h> |