diff options
| author | David Horstmann <david.horstmann@arm.com> | 2022-11-08 19:13:15 +0000 |
|---|---|---|
| committer | Gilles Peskine <Gilles.Peskine@arm.com> | 2022-12-13 10:36:01 +0100 |
| commit | c9dcb4e83e375e5e1cc0c3905410eec75f9effb0 (patch) | |
| tree | 4c14927e54c8aff3247f6b3a6be0f1e1b0e0b76e | |
| parent | bbe8f66bb4ff9771760fa1df3877d867e9e1082c (diff) | |
| download | mbedtls-c9dcb4e83e375e5e1cc0c3905410eec75f9effb0.zip mbedtls-c9dcb4e83e375e5e1cc0c3905410eec75f9effb0.tar.gz mbedtls-c9dcb4e83e375e5e1cc0c3905410eec75f9effb0.tar.bz2 | |
Merge and reorder paragraphs for clarity
Signed-off-by: David Horstmann <david.horstmann@arm.com>
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 1 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9fea52c..9fee0cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,9 +34,7 @@ The project aims to minimise the impact on users upgrading to newer versions of To minimise such disruption to users, where a change to the interface is required, all changes to the ABI or API, even on the main development branch where new features are added, need to be justifiable by either being a significant enhancement, new feature or bug fix which is best resolved by an interface change. If there is an API change, the contribution, if accepted, will be merged only when there will be a major release. -Where changes to an existing interface are necessary, functions in the public interface which need to be changed are marked as 'deprecated'. If there is a strong reason to replace an existing function with one that has a slightly different interface (different prototype, or different documented behavior), create a new function with a new name with the desired interface. Keep the old function, but mark it as deprecated. - -No changes are permitted to the definition of functions in the public interface which will change the API. Instead the interface can only be changed by its extension. As described above, if a function needs to be changed, a new function needs to be created alongside it, with a new name, and whatever change is necessary, such as a new parameter or the addition of a return value. +No changes are permitted to the definition of functions in the public interface which will change the API. Instead the interface can only be changed by its extension. Where changes to an existing interface are necessary, functions in the public interface which need to be changed are marked as 'deprecated'. If there is a strong reason to replace an existing function with one that has a slightly different interface (different prototype, or different documented behavior), create a new function with a new name with the desired interface. Keep the old function, but mark it as deprecated. Periodically, the library will remove deprecated functions from the library which will be a breaking change in the API, but such changes will be made only in a planned, structured way that gives sufficient notice to users of the library. |