mirror of
https://github.com/restic/restic.git
synced 2025-12-11 18:47:50 +00:00
docs: sync compatibility section with website
This is no change in policy, just a more precise description of the status quo.
This commit is contained in:
@@ -130,14 +130,17 @@ Backward compatibility for backups is important so that our users are
|
|||||||
always able to restore saved data. Therefore restic follows `Semantic
|
always able to restore saved data. Therefore restic follows `Semantic
|
||||||
Versioning <https://semver.org>`__ to clearly define which versions are
|
Versioning <https://semver.org>`__ to clearly define which versions are
|
||||||
compatible. The repository and data structures contained therein are
|
compatible. The repository and data structures contained therein are
|
||||||
considered the "Public API" in the sense of Semantic Versioning. This
|
considered the "Public API" in the sense of Semantic Versioning.
|
||||||
goes for all released versions of restic, this may not be the case for
|
|
||||||
the master branch.
|
|
||||||
|
|
||||||
We guarantee backward compatibility of all repositories within one major
|
Once version 1.0.0 is released, we guarantee backward compatibility of
|
||||||
version; as long as we do not increment the major version, data can be
|
all repositories within one major version; as long as we do not
|
||||||
read and restored. We strive to be fully backward compatible to all
|
increment the major version, data can be read and restored. We strive
|
||||||
prior versions.
|
to be fully backward compatible to all prior versions.
|
||||||
|
|
||||||
|
During initial development (versions prior to 1.0.0), maintainers and
|
||||||
|
developers will do their utmost to keep backwards compatibility and
|
||||||
|
stability, although there might be breaking changes without increasing
|
||||||
|
the major version.
|
||||||
|
|
||||||
**********************
|
**********************
|
||||||
Building documentation
|
Building documentation
|
||||||
|
|||||||
Reference in New Issue
Block a user