Skip to content

Commit

Permalink
docs: Explicitly demarcate platform support
Browse files Browse the repository at this point in the history
As discussed in today's meeting, this commit creates two tiers of
support. Tier 1, which is what we actively test, and Tier 2, what we
hope compiles.

Signed-off-by: John Nunley <dev@notgull.net>
  • Loading branch information
notgull committed Aug 23, 2024
1 parent e716adc commit c5abd0c
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 1 deletion.
52 changes: 52 additions & 0 deletions PLATFORM_SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Platform/Architecture Support

Platform support on `winit` has two tiers: Tier 1 and Tier 2.

- Tier 1 is **guaranteed to work**. Targets in this tier are actively tested
both in CI and by maintainers.
- Tier 2 is **guaranteed to build**. Code compilation is tested in CI, but deeper
testing is not done.

Please open an issue if you would like to add a Tier 2 target, or if you would
like a Tier 2 target moved to Tier 1.

## Tier 1 Targets

|Target Name |Target Triple |APIs |
|-------------------------------|------------------------------------|---------------|
|32-Bit x86 Windows with MSVC |`i686-pc-windows-msvc` |Win32 |
|64-Bit x86 Windows with MSVC |`x86_64-pc-windows-msvc` |Win32 |
|32-Bit x86 Windows with glibc |`i686-pc-windows-gnu` |Win32 |
|64-Bit x86 Windows with glibc |`x86_64-pc-windows-gnu` |Win32 |
|32-Bit x86 Linux with glibc |`i686-unknown-linux-gnu` |X11, Wayland |
|64-Bit x86 Linux with glibc |`x86_64-unknown-linux-gnu` |X11, Wayland |
|64-Bit ARM Android |`aarch64-linux-android` |Android |
|64-Bit x86 Redox OS |`x86_64-unknown-redox` |Orbital |
|64-bit x64 macOS |`x86_64-apple-darwin` |AppKit |
|64-bit ARM macOS |`aarch64-apple-darwin` |AppKit |
|64-bit x64 iOS |`x86_64-apple-ios` |UIKit |
|64-bit ARM iOS |`aarch64-apple-ios` |UIKit |
|32-bit WASM web browser |`wasm32-unknown-unknown` |DOM |

## Tier 2 Targets

|Target Name |Target Triple |APIs |
|------------------------------------|------------------------------------|---------------|
|64-Bit ARM Windows with MSVC |`aarch64-pc-windows-msvc` |Win32 |
|32-Bit x86 Windows 7 with MSVC |`i686-win7-windows-msvc` |Win32 |
|64-Bit x86 Windows 7 with MSVC |`x86_64-win7-windows-msvc` |Win32 |
|64-bit x86 Linux with Musl |`x86_64-unknown-linux-musl` |X11, Wayland |
|64-bit x86 Linux with 32-bit glibc |`x86_64-unknown-linux-gnux32` |X11, Wayland |
|64-bit x86 Android |`x86_64-linux-android` |Android |
|32-bit x86 Android |`i686-linux-android` |Android |
|64-bit x86 FreeBSD |`x86_64-unknown-freebsd` |X11, Wayland |
|64-bit x86 NetBSD |`x86_64-unknown-netbsd` |X11 |
|32-bit x86 Linux with Musl |`i686-unknown-linux-musl` |X11, Wayland |
|64-bit RISC-V Linux with glibc |`riscv64gc-unknown-linux-gnu` |X11, Wayland |
|64-bit ARM Linux with glibc |`aarch64-unknown-linux-gnu` |X11, Wayland |
|64-bit ARM Linux with Musl |`aarch64-unknown-linux-musl` |X11, Wayland |
|64-bit PowerPC Linux with glibc |`powerpc64le-unknown-linux-gnu` |X11, Wayland |
|32-Bit ARM Linux with glibc |`armv5te-unknown-linux-gnueabi` |X11, Wayland |
|64-Bit Linux on IBM Supercomputers |`s390x-unknown-linux-gnu` |X11, Wayland |
|32-bit ARM Android |`arm-linux-androideabi` |Android |
|64-bit SPARC Linux with glibc |`sparc64-unknown-linux-gnu` |X11, Wayland |
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@
//!
//! See the [`platform`] module for documentation on platform-specific cargo
//! features.
//!
#![doc = include_str!("../PLATFORM_SUPPORT.md")]
//! [`EventLoop`]: event_loop::EventLoop
//! [`EventLoop::new()`]: event_loop::EventLoop::new
//! [`EventLoop::run_app()`]: event_loop::EventLoop::run_app
Expand Down

0 comments on commit c5abd0c

Please sign in to comment.