From 333537a9503d9d4247237229162a6ae52e678215 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 16 Nov 2017 21:41:14 -0800 Subject: [PATCH] doc: change v8 to V8 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Google's V8 engine is styled "V8" and not "v8". Most Node.js docs style it correctly. This change fixes a few instances that are not styled correctly. PR-URL: https://github.com/nodejs/node/pull/17089 Reviewed-By: Michaël Zasso Reviewed-By: Anatoli Papirovski Reviewed-By: Daniel Bevenius Reviewed-By: Luigi Pinca Reviewed-By: Colin Ihrig Reviewed-By: Michael Dawson Reviewed-By: Anna Henningsen --- doc/api/buffer.md | 3 +-- doc/api/cli.md | 6 +++--- doc/api/synopsis.md | 2 +- doc/guides/writing-and-running-benchmarks.md | 2 +- doc/node.1 | 8 ++++---- 5 files changed, 10 insertions(+), 11 deletions(-) diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 4a54a25bfc990e..06fac34246dc4c 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -2624,8 +2624,7 @@ Returns an un-pooled `Buffer`. In order to avoid the garbage collection overhead of creating many individually allocated `Buffer` instances, by default allocations under 4KB are sliced from a -single larger allocated object. This approach improves both performance and memory -usage since v8 does not need to track and cleanup as many `Persistent` objects. +single larger allocated object. In the case where a developer may need to retain a small chunk of memory from a pool for an indeterminate amount of time, it may be appropriate to create an diff --git a/doc/api/cli.md b/doc/api/cli.md index 3d836b6a12efc6..805d24c40835bc 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -11,7 +11,7 @@ To view this documentation as a manual page in a terminal, run `man node`. ## Synopsis -`node [options] [v8 options] [script.js | -e "script" | -] [--] [arguments]` +`node [options] [V8 options] [script.js | -e "script" | -] [--] [arguments]` `node debug [script.js | -e "script" | :] …` @@ -300,7 +300,7 @@ Track heap object allocations for heap snapshots. added: v5.2.0 --> -Process v8 profiler output generated using the v8 option `--prof`. +Process V8 profiler output generated using the V8 option `--prof`. ### `--v8-options` @@ -308,7 +308,7 @@ Process v8 profiler output generated using the v8 option `--prof`. added: v0.1.3 --> -Print v8 command line options. +Print V8 command line options. *Note*: V8 options allow words to be separated by both dashes (`-`) or underscores (`_`). diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md index 3d680c33b554ba..7fddd6be3b9f09 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -3,7 +3,7 @@ -`node [options] [v8 options] [script.js | -e "script" | - ] [arguments]` +`node [options] [V8 options] [script.js | -e "script" | - ] [arguments]` Please see the [Command Line Options][] document for information about different options and ways to run scripts with Node.js. diff --git a/doc/guides/writing-and-running-benchmarks.md b/doc/guides/writing-and-running-benchmarks.md index 62df0af417c452..75435daf394898 100644 --- a/doc/guides/writing-and-running-benchmarks.md +++ b/doc/guides/writing-and-running-benchmarks.md @@ -104,7 +104,7 @@ buffers/buffer-tostring.js n=10000000 len=1024 arg=false: 4103857.0726124765 Each line represents a single benchmark with parameters specified as `${variable}=${value}`. Each configuration combination is executed in a separate process. This ensures that benchmark results aren't affected by the execution -order due to v8 optimizations. **The last number is the rate of operations +order due to V8 optimizations. **The last number is the rate of operations measured in ops/sec (higher is better).** Furthermore a subset of the configurations can be specified, by setting them in diff --git a/doc/node.1 b/doc/node.1 index 27357c2a6b79ec..3dfadc699c8749 100644 --- a/doc/node.1 +++ b/doc/node.1 @@ -181,13 +181,13 @@ Track heap object allocations for heap snapshots. .TP .BR \-\-prof\-process -Process v8 profiler output generated using the v8 option \fB\-\-prof\fR +Process V8 profiler output generated using the V8 option \fB\-\-prof\fR .TP .BR \-\-v8\-options -Print v8 command line options. +Print V8 command line options. -Note: v8 options allow words to be separated by both dashes (\fB-\fR) or +Note: V8 options allow words to be separated by both dashes (\fB-\fR) or underscores (\fB_\fR). For example, \fB\-\-stack\-trace\-limit\fR is equivalent to @@ -196,7 +196,7 @@ For example, \fB\-\-stack\-trace\-limit\fR is equivalent to .TP .BR \-\-v8\-pool\-size =\fInum\fR Set v8's thread pool size which will be used to allocate background jobs. -If set to 0 then v8 will choose an appropriate size of the thread pool based +If set to 0 then V8 will choose an appropriate size of the thread pool based on the number of online processors. If the value provided is larger than v8's max then the largest value will be chosen.