2022-06-08 21:24:23 +00:00
|
|
|
# API/ABI/CMD Stability in R2
|
|
|
|
|
|
|
|
|
|
Since r2-5.6.0 the development model has changed in order to provide a reliable
|
|
|
|
|
way to push updates without the need to recompile the plugins, tools and api
|
|
|
|
|
bindings.
|
|
|
|
|
|
|
|
|
|
In order to achieve this, the contributions need to follow some new rules in
|
|
|
|
|
order to be merged, so we ensure that binaries keep stable.
|
|
|
|
|
|
|
|
|
|
As it's said, odd version numbers are development versions that are only available
|
2022-06-10 15:46:36 +00:00
|
|
|
in `git` form. The releases are always an even number (0, 2, 4, 6, 8).
|
2022-06-08 21:24:23 +00:00
|
|
|
|
|
|
|
|
When `X.Y.9` is reached, it's time to merge all the pull requests tagged for
|
|
|
|
|
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.
|
|
|
|
|
|
2023-01-08 23:53:18 +00:00
|
|
|
## Development rules
|
|
|
|
|
|
2022-06-08 21:24:23 +00:00
|
|
|
What you **CANNOT** do between X.Y.0 and X.Y.8:
|
|
|
|
|
|
2022-06-08 23:17:16 +00:00
|
|
|
* Add, Remove or rename public functions, structs or enums
|
2022-06-08 21:24:23 +00:00
|
|
|
* Change function signature (adding or removing arguments)
|
|
|
|
|
* Add, remove or reorder fields in structs
|
|
|
|
|
* Remove or change r2 commands (must be documented in release)
|
|
|
|
|
|
|
|
|
|
What you **CAN** do between X.Y.0 and X.Y.8:
|
|
|
|
|
|
2023-01-15 15:08:49 +00:00
|
|
|
* Remove global symbols (they shouldn't be accessed directly anyway)
|
2022-06-08 21:24:23 +00:00
|
|
|
* Change internal structs or functions (static)
|
2022-06-08 23:17:16 +00:00
|
|
|
* Refactor the programs (those are not libraries and dont expose apis)
|
|
|
|
|
* If you really need to add a new public function use `R2_XY0 static inline`
|
|
|
|
|
* This way the function is inlined and no new symbols are exposed.
|
2022-06-08 21:24:23 +00:00
|
|
|
* Add new r2 commands
|
2022-06-08 23:17:16 +00:00
|
|
|
* Add, rename or remove plugins
|
2022-06-08 21:24:23 +00:00
|
|
|
* Extend r2 commands with new arguments, not breaking previous behaviour)
|
|
|
|
|
* Fix memleaks, race conditions, bugs, improve performance, usability, documentation, etc
|
|
|
|
|
* Add breaking code under `#if R2_XY0` to be removed when .9 arrives
|
|
|
|
|
* Use `R_DEPRECATE` to tag everything that will be removed when .9 is reached
|
|
|
|
|
|
|
|
|
|
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
|
2023-01-08 23:53:18 +00:00
|
|
|
|
|
|
|
|
## CI
|
|
|
|
|
|
|
|
|
|
All this is checked in the CI with the `abidiff` utility.
|
|
|
|
|
|
2023-09-10 11:04:23 +00:00
|
|
|
[.github/workflows/build.yml#L607](../../94a31e97b868ead86d27031280ead2f5c64fecbd/.github/workflows/build.yml#L607)
|
