From a5ae37ded65d73a9b58aa348279d25d185d203b3 Mon Sep 17 00:00:00 2001 From: Aaron Feickert <66188213+AaronFeickert@users.noreply.github.com> Date: Tue, 6 Feb 2024 12:33:25 -0600 Subject: [PATCH] Update documentation for nightly compiler warning --- README.md | 5 +++-- src/lib.rs | 7 ++++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 31962eb..01af25b 100644 --- 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 index a27f631..331a010 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -41,11 +41,12 @@ //! //! 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 //!