Codebase list libsdl2-net / fresh-snapshots/main README-versions.md
fresh-snapshots/main

Tree @fresh-snapshots/main (Download .tar.gz)

README-versions.md @fresh-snapshots/main — raw · history · blame 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# Versioning

## Since 2.1.0

`SDL_net` follows an "odd/even" versioning policy, similar to GLib, GTK, Flatpak
and older versions of the Linux kernel:

* The major version (first part) increases when backwards compatibility
    is broken, which will happen infrequently.

* If the minor version (second part) is divisible by 2
    (for example 2.2.x, 2.4.x), this indicates a version that
    is believed to be stable and suitable for production use.

    * In stable releases, the patchlevel or micro version (third part)
        indicates bugfix releases. Bugfix releases should not add or
        remove ABI, so the ".0" release (for example 2.2.0) should be
        forwards-compatible with all the bugfix releases from the
        same cycle (for example 2.2.1).

    * The minor version increases when new API or ABI is added, or when
        other significant changes are made. Newer minor versions are
        backwards-compatible, but not fully forwards-compatible.
        For example, programs built against `SDL_net` 2.2.x should work fine
        with 2.4.x, but programs built against 2.4.x will not necessarily
        work with 2.2.x.

* If the minor version (second part) is not divisible by 2
    (for example 2.1.x, 2.3.x), this indicates a development prerelease
    that is not suitable for stable software distributions.
    Use with caution.

    * The patchlevel or micro version (third part) increases with
        each prerelease.

    * Each prerelease might add new API and/or ABI.

    * Prereleases are backwards-compatible with older stable branches.
        For example, 2.3.x will be backwards-compatible with 2.2.x.

    * Prereleases are not guaranteed to be backwards-compatible with
        each other. For example, new API or ABI added in 2.1.1
        might be removed or changed in 2.1.2.
        If this would be a problem for you, please do not use prereleases.

    * Only upgrade to a prerelease if you can guarantee that you will
        promptly upgrade to the stable release that follows it.
        For example, do not upgrade to 2.1.x unless you will be able to
        upgrade to 2.2.0 when it becomes available.

    * Software distributions that have a freeze policy (in particular Linux
        distributions with a release cycle, such as Debian and Fedora)
        should usually only package stable releases, and not prereleases.

## Before 2.1.0

Older versions of `SDL_net` used the patchlevel (micro version,
third part) for feature releases, and did not distinguish between feature
and bugfix releases.