From 8aa4efb1781cd4bef823a73f0f5b2f764fdd9248 Mon Sep 17 00:00:00 2001 From: BlackHoleFox Date: Thu, 4 Jan 2024 14:55:54 -0600 Subject: [PATCH] Document platform support policy (#387) --- README.md | 8 ++++++++ src/lib.rs | 7 +++++++ 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index c43ad42e..f1512260 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,14 @@ crate features, WASM support and Custom RNGs see the This crate requires Rust 1.36.0 or later. +## Platform Support + +This crate generally supports the same operating system and platform versions that the Rust standard library does. +Additional targets may be supported using pluggable custom implementations. + +This means that as Rust drops support for old versions of operating systems (such as old Linux kernel versions, Android API levels, etc) +in stable releases, `getrandom` may create new patch releases (`0.N.x`) that remove support for outdated platform versions. + # License The `getrandom` library is distributed under either of diff --git a/src/lib.rs b/src/lib.rs index fffa4cb2..ffcdf6a3 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -106,6 +106,13 @@ //! ``` //! This crate will then use the provided `webcrypto` implementation. //! +//! ### Platform Support +//! This crate generally supports the same operating system and platform versions that the Rust standard library does. +//! Additional targets may be supported using pluggable custom implementations. +//! +//! This means that as Rust drops support for old versions of operating systems (such as old Linux kernel versions, Android API levels, etc) +//! in stable releases, `getrandom` may create new patch releases (`0.N.x`) that remove support for outdated platform versions. +//! //! ### Custom implementations //! //! The [`register_custom_getrandom!`] macro allows a user to mark their own