From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Wed, 11 May 2022 22:33:22 +0000 (+0100)
Subject: Document that we need Nightly Rust for the full tests
X-Git-Tag: otter-1.1.0~230
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=81fce47a9615661131cbf83de8d26ffdbd260841;p=otter.git

Document that we need Nightly Rust for the full tests

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/docs/build.rst b/docs/build.rst
index 13c1a22c..1386e80f 100644
--- a/docs/build.rst
+++ b/docs/build.rst
@@ -57,6 +57,12 @@ Setup
 
    and just dump the resulting ``geckodriver`` binary on your ``PATH``.
 
+5. The tests also use Nightly Rust because we use Miri to test the
+   small amount of ``unsafe`` in the Otter codebase::
+
+     rustup toolchain add nightly
+     rustup +nightly component add miri
+
 
 Full build
 ----------