From 8bb67a1fb920fed004cd635361a1bf8255e66ef9 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 29 Oct 2018 22:04:25 -0700 Subject: [PATCH] doc: use Node.js instead of Node Per branding guidelines from the Foundation, use Node.js and not Node. PR-URL: https://github.com/nodejs/node/pull/23967 Reviewed-By: Richard Lau Reviewed-By: Trivikram Kamat Reviewed-By: Matheus Marchini Reviewed-By: Colin Ihrig Reviewed-By: James M Snell Reviewed-By: Franziska Hinkelmann Reviewed-By: Vse Mozhet Byt Reviewed-By: Luigi Pinca --- doc/api/cli.md | 2 +- doc/api/documentation.md | 2 +- doc/api/inspector.md | 2 +- doc/api/modules.md | 5 +++-- doc/guides/node-postmortem-support.md | 6 +++--- doc/node.1 | 6 +++--- 6 files changed, 12 insertions(+), 11 deletions(-) diff --git a/doc/api/cli.md b/doc/api/cli.md index 2586d6fd2054bd..28668703f0672d 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -465,7 +465,7 @@ if they had been specified on the command line before the actual command line (so they can be overridden). Node will exit with an error if an option that is not allowed in the environment is used, such as `-p` or a script file. -Node options that are allowed are: +Node.js options that are allowed are: - `--enable-fips` - `--force-fips` - `--icu-data-dir` diff --git a/doc/api/documentation.md b/doc/api/documentation.md index f78d7c1f40b572..8fcefedeb79753 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -90,7 +90,7 @@ and is not available on Linux. Most Unix syscalls have Windows equivalents, but behavior may differ on Windows relative to Linux and macOS. For an example of the subtle ways in which it's -sometimes impossible to replace Unix syscall semantics on Windows, see [Node +sometimes impossible to replace Unix syscall semantics on Windows, see [Node.js issue 4760](https://github.com/nodejs/node/issues/4760). [submit an issue]: https://github.com/nodejs/node/issues/new diff --git a/doc/api/inspector.md b/doc/api/inspector.md index bd277ff0a8f090..d1dde14c850300 100644 --- a/doc/api/inspector.md +++ b/doc/api/inspector.md @@ -121,7 +121,7 @@ session.post('Runtime.evaluate', { expression: '2 + 2' }, The latest version of the V8 inspector protocol is published on the [Chrome DevTools Protocol Viewer][]. -Node inspector supports all the Chrome DevTools Protocol domains declared +Node.js inspector supports all the Chrome DevTools Protocol domains declared by V8. Chrome DevTools Protocol domain provides an interface for interacting with one of the runtime agents used to inspect the application state and listen to the run-time events. diff --git a/doc/api/modules.md b/doc/api/modules.md index 95890f773e9958..49bd25f40a8b06 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -375,8 +375,9 @@ example, then `require('./some-library')` would attempt to load: If the module identifier passed to `require()` is not a [core](#modules_core_modules) module, and does not begin with `'/'`, `'../'`, or `'./'`, then Node.js starts at the parent directory of the current module, and -adds `/node_modules`, and attempts to load the module from that location. Node -will not append `node_modules` to a path already ending in `node_modules`. +adds `/node_modules`, and attempts to load the module from that location. +Node.js will not append `node_modules` to a path already ending in +`node_modules`. If it is not found there, then it moves to the parent directory, and so on, until the root of the file system is reached. diff --git a/doc/guides/node-postmortem-support.md b/doc/guides/node-postmortem-support.md index e29d9ca3a1fdf0..b3c493bb04eeaa 100644 --- a/doc/guides/node-postmortem-support.md +++ b/doc/guides/node-postmortem-support.md @@ -15,8 +15,8 @@ Node always includes these constants in the final build. ### Node Debug Symbols -Node prefixes all postmortem constants with `nodedbg_`, and they complement V8 -constants by providing ways to inspect Node-specific structures, like +Node.js prefixes all postmortem constants with `nodedbg_`, and they complement +V8 constants by providing ways to inspect Node.js-specific structures, like `node::Environment`, `node::BaseObject` and its descendants, classes from `src/utils.h` and others. Those constants are declared in `src/node_postmortem_metadata.cc`, and most of them are calculated at compile @@ -62,7 +62,7 @@ class ReqWrap : public AsyncWrap { ``` There are also tests on `test/cctest/test_node_postmortem_metadata.cc` to make -sure all Node postmortem metadata are calculated correctly. +sure all Node.js postmortem metadata are calculated correctly. ## Tools and References diff --git a/doc/node.1 b/doc/node.1 index f83dcf6a254bc5..76b7455953d5af 100644 --- a/doc/node.1 +++ b/doc/node.1 @@ -71,7 +71,7 @@ Print node's version. .TP .BR \-h ", " \-\-help -Print node command line options. +Print Node.js command line options. The output of this option is less detailed than this document. .TP @@ -93,7 +93,7 @@ Open the REPL even if stdin does not appear to be a terminal. .TP .BR \-r ", " \-\-require " " \fImodule\fR Preload the specified module at startup. Follows `require()`'s module resolution -rules. \fImodule\fR may be either a path to a file, or a node module name. +rules. \fImodule\fR may be either a path to a file, or a Node.js module name. .TP .BR \-\-inspect \fI[=[host:]port]\fR @@ -294,7 +294,7 @@ When set to \fI1\fR, the http2 module is suppressed. .BR NODE_OPTIONS =\fIoptions...\fR A space-separated list of command line options. \fBoptions...\fR are interpreted as if they had been specified on the command line before the actual command line -(so they can be overridden). Node will exit with an error if an option that is +(so they can be overridden). Node.js will exit with an error if an option that is not allowed in the environment is used, such as \fB-p\fR or a script file. .TP