Skip to content

Commit

Permalink
Clarify "between major version changes"
Browse files Browse the repository at this point in the history
This was diversely interpreted as "compatibility in the period between
two major version changes" (as intended) or "compatibility between two
versions whose major version is different" (unintended).

Signed-off-by: Gilles Peskine <[email protected]>
  • Loading branch information
gilles-peskine-arm committed Jun 8, 2021
1 parent 6dd92c3 commit 73876cf
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions BRANCHES.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ At any point in time, we have a number of maintained branches consisting of:
these only get bug fixes and security fixes.

We use [Semantic Versioning](https://semver.org/). In particular, we maintain
API compatibility in the `master` branch between major version changes. We
also maintain ABI compatibility within LTS branches; see the next section for
details.
API compatibility in the `master` branch across minor version changes (e.g.
the API of 3.(x+1) is backward compatible with 3.x). We only break API
compatibility on major version changes (e.g. from 3.x to 4.0). We also maintain
ABI compatibility within LTS branches; see the next section for details.

## Backwards Compatibility

Expand Down

0 comments on commit 73876cf

Please sign in to comment.