From f7d9c26b9a8f3bb2e6a48e5166b2fd3bc3417cb2 Mon Sep 17 00:00:00 2001 From: DrPeterVanNostrand Date: Mon, 3 Sep 2018 18:41:28 +0000 Subject: [PATCH] Added 'Testing' section to readme. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index b23e21b..4d5d5dc 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,20 @@ fn main() { } ``` +### Testing + +Run tests using the following command: + +``` +$ MLOCK_SECRETS=false cargo test +``` + +The test suite runs quickly without setting the envvar `MLOCK_SECRETS=false`, +but runs even faster when it is set. Setting this envvar also ensures that +tests won't fail if we reach the testing system's locked memory limit (which +we won't hit unless the system's locked memory limit is set unreasonably low, +i.e. 1-2 pages or the equivalent, 4-8 kilobytes). + ### Examples Run examples from the [`examples`](examples) directory using: