From 9b57a85f02bc4c99a6fdb5f1f5c88e9de524ebfc Mon Sep 17 00:00:00 2001 From: BlackHoleFox Date: Tue, 19 Dec 2023 14:25:58 -0600 Subject: [PATCH] Document platform support policy --- README.md | 8 ++++++++ src/lib.rs | 7 +++++++ 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index c43ad42e..a297ae0d 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 plugable 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..07613d91 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -105,6 +105,13 @@ //! globalThis.crypto = webcrypto //! ``` //! 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 plugable 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 //!