luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-10 03:16:17 +01:00
Code Issues Packages Projects Releases Wiki Activity
eae5c49085
glib/docs/supported-platforms.md
Philip Withnall 05b861db8b docs: Expand supported platforms documentation a little 
Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2023-06-29 15:51:44 +01:00

5.1 KiB
Raw Blame History

Supported platforms

GLib’s approach to portability is that we only support systems that we can test. That means that either a large number of GLib developers are regularly using GLib on a particular system, or we have regular builds of GLib on that system.

Minimum versions

This list is authoritative, and documents what this version of GLib targets to support. The list will be periodically updated for the development branch, with versions typically being updated as they lapse from receiving support from their vendor.

  • macOS: minimum version OS X 10.7 (we don’t support universal binaries; some features (like notification support) require OS X 10.9
    • Note that older versions of macOS than what’s currently officially supported by Apple are supported by GLib on a best-effort basis due to still having significant user bases
  • Windows: minimum version is Windows 8, minimum build chain is Visual Studio 2012
    • Static builds are only supported with MinGW-based toolchains (cf this comment)
  • Android: minimum NDK version 15
  • Linux: glibc newer than 2.5 (if using glibc; other forms of libc are supported)

Tested platforms

GLib is regularly built on at least the following systems:

If other platforms are to be supported, we need to set up regular CI testing for them. Please contact us if you want to help.

Policy and rationale

Due to their position in the market, we consider supporting GNU/Linux, Windows and macOS to be the highest priorities and we will go out of our way to accommodate these systems, even in places that they are contravening standards.

In general, we are open to the idea of supporting any Free Software UNIX-like system with good POSIX compliance. We are always interested in receiving patches that improve our POSIX compliance — if there is a good POSIX equivalent for a platform-specific API that we’re using, then all other things equal, we prefer the POSIX one.

We may use a non-POSIX API available on one or more of our supported systems in the case that it provides some advantage over the POSIX equivalent (such as the case with pipe2() solving the O_CLOEXEC race). In these cases, we will try to provide a fallback to the pure POSIX approach. If we’ve used a system-specific API without providing a fallback to a largely-equivalent POSIX API then it is likely a mistake, and we’re happy to receive a patch to fix it.

We are not interested in supporting other systems if it involves adding code paths that we cannot test. Specifically, this means that we will reject patches that introduce platform-specific #ifdef sections in the code unless we are actively doing builds of GLib on this platform (ie: see the lists above). We’ve historically accepted such patches from users of these systems on an ad hoc basis, but it created an unsustainable situation. Patches that fix platform-specific build issues in such a way that the code is improved in the general case are of course welcome.

Although we aim to support all systems with good POSIX compliance, we are not interested in adhering to “pure POSIX and nothing else”. If we need to add a feature and we can provide good support on all of the platforms that we support (above), we will not hold back for other systems. We will always try to provide a fallback to a POSIX-specified approach, if possible, or to simply replace a given functionality with a no-op, but even this may not be possible in cases of critical functionality.

Specific notes

Note that we currently depend on a number of features specified in POSIX, but listed as optional:

Also see toolchain requirements.