From 68100db1e33f531e47e8467e965ecbdf71607073 Mon Sep 17 00:00:00 2001 From: BlackHoleFox Date: Tue, 19 Dec 2023 14:25:58 -0600 Subject: [PATCH 1/3] 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..aa895a96 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 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 //! //! The [`register_custom_getrandom!`] macro allows a user to mark their own From f5669ae3cb28808b76c8c784ed4c0bf8f33a885e Mon Sep 17 00:00:00 2001 From: Artyom Pavlov Date: Thu, 4 Jan 2024 23:40:57 +0300 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a297ae0d..f1512260 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ 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. +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. From bf8184c0397667b22865ab8bc40679e65dcbb31a Mon Sep 17 00:00:00 2001 From: Artyom Pavlov Date: Thu, 4 Jan 2024 23:41:04 +0300 Subject: [PATCH 3/3] Update src/lib.rs --- src/lib.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index aa895a96..ffcdf6a3 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -108,7 +108,7 @@ //! //! ### 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. +//! 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.