From 15c10a78f7b8175f61870c53d97dbed892b023a3 Mon Sep 17 00:00:00 2001 From: Avril Date: Tue, 23 Mar 2021 02:45:17 +0000 Subject: [PATCH] update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 93d6907..357e78d 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ To enable explicit buffer clearing, compile with the option `--features explicit The `explicit_clear` feature forces any temporary work buffers to be zeroed out in memory when the corresponding stream is flushed itself. Unless being built with the Rust nightly toolchain, it requires the nonstandard glibc extension `explicit_bzero(void*, size_t)` to build. -On x86 targets with the Rust nightly toolchain installed, it will also force a cache flush of the corresponding memory address when the stream is flushed. +On x86 targets with the Rust nightly toolchain, it will also force a cache flush of the corresponding memory address after the zeroing. This is *usually not needed*, and can cause a slowdown; but it prevents any lingering data being left in the buffer. The unit test `remainder()` checks the process' memory map for leftover data in the working buffer when testing with this feature enabled. It is still unlikely data will remain even without this feature, depending on your system; you should only use it if you are very paranoid.