Update documentation for nightly compiler warning

AaronFeickert · Feb 6, 2024 · 55f472e · 55f472e
1 parent 0948a87
commit 55f472e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -37,10 +37,11 @@ There are several features that are enabled by default:
 
 The underlying [curve library](https://crates.io/crates/curve25519-dalek) chooses an arithmetic backend based on CPU feature detection.
 Using a nightly compiler broadens the backend set, and may provide better performance.
-You can examine performance using the benchmarks: either `cargo bench` or `cargo +nightly bench`.
+Note that nightly compilers after `nightly-2024-02-04` will [not work](https://github.com/dalek-cryptography/curve25519-dalek/issues/618).
+You can examine performance using the benchmarks: either `cargo bench` or `cargo +nightly-2024-02-04 bench`.
 
 Proofs support a custom serialization format designed to be efficient and canonical.
-This functionality has an associated fuzzer that can be run using a nightly compiler: `cargo +nightly fuzz run proofs`
+This functionality has an associated fuzzer that can be run using a nightly compiler: `cargo +nightly-2024-02-04 fuzz run proofs`
 
 ## Warning
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -41,10 +41,11 @@
 //!
 //! The underlying [curve library](https://crates.io/crates/curve25519-dalek) chooses an arithmetic backend based on CPU feature detection.
 //! Using a nightly compiler broadens the backend set, and may provide better performance.
-//! You can examine performance using the benchmarks: either `cargo bench` or `cargo +nightly bench`.
+//! Note that nightly compilers after `nightly-2024-02-04` will [not work](https://github.com/dalek-cryptography/curve25519-dalek/issues/618).
+//! You can examine performance using the benchmarks: either `cargo bench` or `cargo +nightly-2024-02-04 bench`.
 //!
 //! Proofs support a custom serialization format designed to be efficient and canonical.
-//! This functionality has an associated fuzzer that can be run using a nightly compiler: `cargo +nightly fuzz run
+//! This functionality has an associated fuzzer that can be run using a nightly compiler: `cargo +nightly-2024-02-04 fuzz run
 //! proofs`
 //!
 //! # Warning