Skip to content

Commit 9b57a85

Browse files
committed
Document platform support policy
1 parent 7249e6e commit 9b57a85

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
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 plugable 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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,13 @@
105105
//! globalThis.crypto = webcrypto
106106
//! ```
107107
//! This crate will then use the provided `webcrypto` implementation.
108+
//!
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 plugable 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.
108115
//!
109116
//! ### Custom implementations
110117
//!

0 commit comments

Comments
 (0)