diff options
| author | Daiki Ueno <ueno@gnu.org> | 2021-10-30 15:28:47 +0000 |
|---|---|---|
| committer | Daiki Ueno <ueno@gnu.org> | 2021-10-30 15:28:47 +0000 |
| commit | fe9d2be0d251bc7a3e1fd7d7b59e1dbf23bae8a1 (patch) | |
| tree | 4a54ae34e11cd22dd9a8e01b44b8996ca3f11832 /CONTRIBUTING.md | |
| parent | 8fda070adaeaff47e5b73f1e54a1bde3a2f49bee (diff) | |
| parent | bd3c78b9d10937adb1855b85bca1864972a1c986 (diff) | |
| download | gnutls-fe9d2be0d251bc7a3e1fd7d7b59e1dbf23bae8a1.tar.gz | |
Merge branch 'wip/dueno/abi-dump-release' into 'master'
devel: update release procedure taking into account of abi-dump
See merge request gnutls/gnutls!1481
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5441e54600..2773b3ffca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -157,8 +157,13 @@ As such, some questions to answer before adding a new API: 13.0 is made available? Would it harm the addition of a new protocol? -The make rule 'abi-check' verifies that the ABI remained compatible since -the last tagged release. It relies on the git tree and libabigail. +The make rule 'abi-check' verifies that the ABI remained compatible +since the last tagged release, which is maintained in a separate +[abi-dump](https://gitlab.com/gnutls/abi-dump) repository. During +development, the new APIs should be explicitly ignored with the last +section of [devel/libgnutls.abignore](devel/libgnutls.abignore). When +a new version is released and the abi-dump repository is updated, the +section will be cleared. The above do not apply to the C++ library; this library's ABI should not be considered stable. |