docs/supported-platforms.md

   1 Supported platforms
   2 ===
   3
   4 GLib’s approach to portability is that we only support systems that we can test.
   5 That means that either a large number of GLib developers are regularly using
   6 GLib on a particular system, or we have regular builds of GLib on that system.
   7
   8 Minimum versions
   9 ---
  10
  11 This list is authoritative, and documents what this version of GLib targets to
  12 support. The list will be periodically updated for the development branch,
  13 with versions typically being updated as they lapse from receiving support from
  14 their vendor.
  15
  16  * macOS: minimum version OS X 10.7 (we
  17    [don’t support universal binaries](https://bugzilla.gnome.org/show_bug.cgi?id=780238);
  18    some features (like notification support)
  19    [require OS X 10.9](https://bugzilla.gnome.org/show_bug.cgi?id=747146)
  20    * Note that older versions of macOS than what’s currently officially
  21      supported by Apple are supported by GLib on a best-effort basis due to
  22      still having significant user bases
  23  * Windows:
  24    [minimum version is Windows 8](https://gitlab.gnome.org/GNOME/glib/-/merge_requests/1970),
  25    minimum build chain is Visual Studio 2012
  26    * Static builds are only supported with MinGW-based toolchains (cf
  27      [this comment](https://gitlab.gnome.org/GNOME/glib/-/merge_requests/2384#note_1336662))
  28  * Android: [minimum NDK version 15](https://gitlab.gnome.org/GNOME/glib/issues/1113)
  29  * Linux: glibc newer than 2.5 (if using glibc; other forms of libc are supported)
  30
  31 Tested platforms
  32 ---
  33
  34 GLib is regularly built on at least the following systems:
  35
  36  * GNOME OS Nightly: https://os.gnome.org/
  37  * Fedora: http://koji.fedoraproject.org/koji/packageinfo?packageID=382
  38  * Ubuntu: http://packages.ubuntu.com/source/glib2.0
  39  * Debian: https://packages.debian.org/experimental/libglib2.0-0
  40  * FreeBSD: https://wiki.gnome.org/Projects/Jhbuild/FreeBSD
  41  * openSUSE: https://build.opensuse.org/package/show/GNOME:Factory/glib2
  42  * CI runners, https://gitlab.gnome.org/GNOME/glib/blob/main/.gitlab-ci.yml:
  43    - Fedora (34, https://gitlab.gnome.org/GNOME/glib/-/blob/main/.gitlab-ci/fedora.Dockerfile)
  44    - Debian (Bullseye, https://gitlab.gnome.org/GNOME/glib/-/blob/main/.gitlab-ci/debian-stable.Dockerfile)
  45    - Windows (MinGW64)
  46    - Windows (msys2-mingw32)
  47    - Windows (Visual Studio 2017, and a static linking version)
  48    - Android (NDK r23b, API 31, arm64, https://gitlab.gnome.org/GNOME/glib/-/blob/main/.gitlab-ci/android-ndk.sh)
  49    - FreeBSD (12 and 13)
  50    - macOS
  51
  52 If other platforms are to be supported, we need to set up regular CI testing for
  53 them. Please contact us if you want to help.
  54
  55 Policy and rationale
  56 ---
  57
  58 Due to their position in the market, we consider supporting GNU/Linux, Windows
  59 and macOS to be the highest priorities and we will go out of our way to
  60 accommodate these systems, even in places that they are contravening standards.
  61
  62 In general, we are open to the idea of supporting any Free Software UNIX-like
  63 system with good POSIX compliance.  We are always interested in receiving
  64 patches that improve our POSIX compliance — if there is a good POSIX equivalent
  65 for a platform-specific API that we’re using, then all other things equal, we
  66 prefer the POSIX one.
  67
  68 We may use a non-POSIX API available on one or more of our supported systems in
  69 the case that it provides some advantage over the POSIX equivalent (such as the
  70 case with `pipe2()` solving the `O_CLOEXEC` race).  In these cases, we will try
  71 to provide a fallback to the pure POSIX approach.  If we’ve used a
  72 system-specific API without providing a fallback to a largely-equivalent POSIX
  73 API then it is likely a mistake, and we’re happy to receive a patch to fix it.
  74
  75 We are not interested in supporting other systems if it involves adding code
  76 paths that we cannot test.  Specifically, this means that we will reject patches
  77 that introduce platform-specific `#ifdef` sections in the code unless we are
  78 actively doing builds of GLib on this platform (ie: see the lists above).  We’ve
  79 historically accepted such patches from users of these systems on an ad hoc
  80 basis, but it created an unsustainable situation.  Patches that fix
  81 platform-specific build issues in such a way that the code is improved in the
  82 general case are of course welcome.
  83
  84 Although we aim to support all systems with good POSIX compliance, we are not
  85 interested in adhering to “pure POSIX and nothing else”.  If we need to add a
  86 feature and we can provide good support on all of the platforms that we support
  87 (above), we will not hold back for other systems.  We will always try to provide
  88 a fallback to a POSIX-specified approach, if possible, or to simply replace a
  89 given functionality with a no-op, but even this may not be possible in cases of
  90 critical functionality.
  91
  92 Specific notes
  93 ---
  94
  95 Note that we currently depend on a number of features specified in POSIX, but
  96 listed as optional:
  97
  98  * [`CLOCK_MONOTONIC`](http://pubs.opengroup.org/onlinepubs/009695399/functions/clock_gettime.html)
  99    is expected to be present and working
 100  * [`pthread_condattr_setclock()`](http://pubs.opengroup.org/onlinepubs/7999959899/functions/pthread_condattr_setclock.html)
 101    is expected to be present and working
 102
 103 Also see [toolchain requirements](./toolchain-requirements.md).