Skip to content

Commit 8aa4efb

Browse files
authored
Document platform support policy (#387)
1 parent 7249e6e commit 8aa4efb

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,14 @@ crate features, WASM support and Custom RNGs see the
5454

5555
This crate requires Rust 1.36.0 or later.
5656

57+
## Platform Support
58+
59+
This crate generally supports the same operating system and platform versions that the Rust standard library does.
60+
Additional targets may be supported using pluggable custom implementations.
61+
62+
This means that as Rust drops support for old versions of operating systems (such as old Linux kernel versions, Android API levels, etc)
63+
in stable releases, `getrandom` may create new patch releases (`0.N.x`) that remove support for outdated platform versions.
64+
5765
# License
5866

5967
The `getrandom` library is distributed under either of

src/lib.rs

+7
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,13 @@
106106
//! ```
107107
//! This crate will then use the provided `webcrypto` implementation.
108108
//!
109+
//! ### Platform Support
110+
//! This crate generally supports the same operating system and platform versions that the Rust standard library does.
111+
//! Additional targets may be supported using pluggable custom implementations.
112+
//!
113+
//! This means that as Rust drops support for old versions of operating systems (such as old Linux kernel versions, Android API levels, etc)
114+
//! in stable releases, `getrandom` may create new patch releases (`0.N.x`) that remove support for outdated platform versions.
115+
//!
109116
//! ### Custom implementations
110117
//!
111118
//! The [`register_custom_getrandom!`] macro allows a user to mark their own

0 commit comments

Comments
 (0)