diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/NEWS.rst | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/NEWS.rst b/doc/NEWS.rst new file mode 100644 index 0000000..596484a --- /dev/null +++ b/doc/NEWS.rst @@ -0,0 +1,36 @@ +.. SPDX-License-Identifier: GPL-3.0-or-later + +.. _release_notes: + +************* +Release notes +************* + +Version numbering +================= +Version number format is ``major.minor.patch``. +Knot Resolver does not use semantic versioning even though the version number looks similar. + +Leftmost number which was changed signalizes what to expect when upgrading: + +Major version + * Manual upgrade steps might be necessary, please follow instructions in :ref:`Upgrading` section. + * Major releases may contain significant changes including changes to configuration format. + * We might release a new major also when internal implementation details change significantly. + +Minor version + * Configuration stays compatible with the previous version, except for undocumented or very obscure options. + * Upgrade should be seamless for users who use modules shipped as part of Knot Resolver distribution. + * Incompatible changes in internal APIs are allowed in minor versions. Users who develop or use custom modules + (i.e. modules not distributed together with Knot Resolver) need to double check their modules for incompatibilities. + :ref:`Upgrading` section should contain hints for module authors. + +Patch version + * Everything should be compatible with the previous version. + * API for modules should be stable on best effort basis, i.e. API is very unlikely to break in patch releases. + * Custom modules might need to be recompiled, i.e. ABI compatibility is not guaranteed. + +This definition is not applicable to versions older than 5.2.0. + +.. include:: ../NEWS + |