From 443db663bbeaeae9847dbd6a3f0f85f04ea7c44f Mon Sep 17 00:00:00 2001 From: pancake Date: Mon, 9 Jan 2023 00:53:18 +0100 Subject: [PATCH] Reference abidiff's ci usage in doc/abi.md ##doc --- doc/abi.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/abi.md b/doc/abi.md index 13f2b1ad6b..fbb20afbfc 100644 --- a/doc/abi.md +++ b/doc/abi.md @@ -15,6 +15,8 @@ the next big release, the .9 versions are always the most unstable as they focus on quick development in order to make all the breaking changes needed to introduce new features or simplify the usage of some apis. +## Development rules + What you **CANNOT** do between X.Y.0 and X.Y.8: * Add, Remove or rename public functions, structs or enums @@ -40,3 +42,9 @@ What you **MUST** do in X.Y.9: * Remove everything marked as `R_DEPRECATE` or `R2_XY0`. Use `git grep` to find them out * Anything that was forbidden + +## CI + +All this is checked in the CI with the `abidiff` utility. + +[.github/workflows/build.yml#L522](.github/workflows/build.yml#L522)