From d1a8cd5169d81308be85320ad39c80ea810970a7 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Mon, 7 Jun 2021 20:42:40 +0200 Subject: [PATCH] Minor clarifications Signed-off-by: Gilles Peskine --- BRANCHES.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/BRANCHES.md b/BRANCHES.md index dbdc1738e4..d9de6957d7 100644 --- a/BRANCHES.md +++ b/BRANCHES.md @@ -28,7 +28,7 @@ undocumented features, then you should be able to re-compile it without modification with any later release x.y'.z' with the same major version number, and your code will still build, be secure, and work. -Note that new releases of Mbed TLS may extend the API. Here are some example of changes that are common in minor releases of Mbed TLS, and are not considered compatibility breaks: +Note that new releases of Mbed TLS may extend the API. Here are some example of changes that are common in minor releases of Mbed TLS, and are not considered API compatibility breaks: * Adding or reordering fields in a structure or union. * Removing a field from a structure, unless the field is documented as public. @@ -37,11 +37,11 @@ Note that new releases of Mbed TLS may extend the API. Here are some example of * Changing which error code is returned in a case where multiple error conditions apply. * Changing the behavior of a function from failing to succeeding, when the change is a reasonable extension of the current behavior, i.e. the addition of a new feature. -There are rare exceptions: code that was relying on something that became -insecure in the meantime (for example, crypto that was found to be weak) may -need to be changed. In case security comes in conflict with backwards -compatibility, we will put security first, but always attempt to provide a -compatibility option. +There are rare exceptions where we break API compatibility: code that was +relying on something that became insecure in the meantime (for example, +crypto that was found to be weak) may need to be changed. In case security +comes in conflict with backwards compatibility, we will put security first, +but always attempt to provide a compatibility option. For the LTS branches, additionally we try very hard to also maintain ABI compatibility (same definition as API except with re-linking instead of