From a3efcfbcdc4d97ae43c9a7cc4f45b3976848ca0f Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 26 Mar 2018 16:34:35 -0700 Subject: [PATCH] doc: improve zero-fill-buffers text * improve text for easier comprehension * clarify that performance impact is *negative* * remove superfluous "either" (should only be used when there are 2 options anyway) * remove superfluous italics * line wrap at 80 chars --- doc/api/buffer.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/api/buffer.md b/doc/api/buffer.md index bcde11de66314b..b551f72ad98029 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -111,13 +111,13 @@ added: v5.10.0 --> Node.js can be started using the `--zero-fill-buffers` command line option to -force all newly allocated `Buffer` instances created using either -`new Buffer(size)`, [`Buffer.allocUnsafe()`], [`Buffer.allocUnsafeSlow()`] or -`new SlowBuffer(size)` to be *automatically zero-filled* upon creation. Use of -this flag *changes the default behavior* of these methods and *can have a significant -impact* on performance. Use of the `--zero-fill-buffers` option is recommended -only when necessary to enforce that newly allocated `Buffer` instances cannot -contain old data that is potentially sensitive. +cause all newly allocated `Buffer` instances to be zero-filled upon creation by +default, including buffers returned by `new Buffer(size)`, +[`Buffer.allocUnsafe()`], [`Buffer.allocUnsafeSlow()`], and `new +SlowBuffer(size)`. Use of this flag can have a significant negative impact on +performance. Use of the `--zero-fill-buffers` option is recommended only when +necessary to enforce that newly allocated `Buffer` instances cannot contain old +data that is potentially sensitive. ```txt $ node --zero-fill-buffers