Skip to content

Commit 35c7238

Browse files
hiroppyLeko
authored andcommitted
doc: replace to Node.js
PR-URL: #19056 Reviewed-By: Matheus Marchini <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Shingo Inoue <[email protected]>
1 parent 3ed363c commit 35c7238

13 files changed

+36
-32
lines changed

doc/api/cli.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -452,8 +452,8 @@ added: v8.0.0
452452

453453
A space-separated list of command line options. `options...` are interpreted as
454454
if they had been specified on the command line before the actual command line
455-
(so they can be overridden). Node will exit with an error if an option that is
456-
not allowed in the environment is used, such as `-p` or a script file.
455+
(so they can be overridden). Node.js will exit with an error if an option
456+
that is not allowed in the environment is used, such as `-p` or a script file.
457457

458458
Node options that are allowed are:
459459
- `--enable-fips`

doc/api/deprecations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -610,7 +610,7 @@ a V8-inspector based CLI debugger available through `node inspect`.
610610

611611
Type: End-of-Life
612612

613-
DebugContext has been removed in V8 and is not available in Node 10+.
613+
DebugContext has been removed in V8 and is not available in Node.js 10+.
614614

615615
DebugContext was an experimental API.
616616

doc/api/documentation.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ wish to do programmatic things with the documentation.
8080
## Syscalls and man pages
8181

8282
System calls like open(2) and read(2) define the interface between user programs
83-
and the underlying operating system. Node functions which simply wrap a syscall,
83+
and the underlying operating system. Node.js functions
84+
which simply wrap a syscall,
8485
like [`fs.open()`][], will document that. The docs link to the corresponding man
8586
pages (short for manual pages) which describe how the syscalls work.
8687

doc/api/domain.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ than crashing the program.
443443

444444
## Domains and Promises
445445

446-
As of Node 8.0.0, the handlers of Promises are run inside the domain in
446+
As of Node.js 8.0.0, the handlers of Promises are run inside the domain in
447447
which the call to `.then` or `.catch` itself was made:
448448

449449
```js

doc/api/esm.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ fs.readFile('./foo.txt', (err, body) => {
106106
<!-- type=misc -->
107107

108108
To customize the default module resolution, loader hooks can optionally be
109-
provided via a `--loader ./loader-name.mjs` argument to Node.
109+
provided via a `--loader ./loader-name.mjs` argument to Node.js.
110110

111111
When hooks are used they only apply to ES module loading and not to any
112112
CommonJS modules loaded.
@@ -150,7 +150,7 @@ module. This can be one of the following:
150150
| `"dynamic"` | Use a [dynamic instantiate hook][] |
151151

152152
For example, a dummy loader to load JavaScript restricted to browser resolution
153-
rules with only JS file extension and Node builtin modules support could
153+
rules with only JS file extension and Node.js builtin modules support could
154154
be written:
155155

156156
```js

doc/api/fs.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -600,7 +600,7 @@ The times in the stat object have the following semantics:
600600
set to an earlier value than the current `birthtime` using the
601601
utimes(2) system call.
602602

603-
Prior to Node v0.12, the `ctime` held the `birthtime` on Windows
603+
Prior to Node.js v0.12, the `ctime` held the `birthtime` on Windows
604604
systems. Note that as of v0.12, `ctime` is not "creation time", and
605605
on Unix systems, it never was.
606606

@@ -657,7 +657,8 @@ changes:
657657
pr-url: https://github.com/nodejs/node/pull/6534
658658
description: The constants like `fs.R_OK`, etc which were present directly
659659
on `fs` were moved into `fs.constants` as a soft deprecation.
660-
Thus for Node `< v6.3.0` use `fs` to access those constants, or
660+
Thus for Node.js `< v6.3.0` use `fs`
661+
to access those constants, or
661662
do something like `(fs.constants || fs).R_OK` to work with all
662663
versions.
663664
-->

doc/api/n-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3489,7 +3489,7 @@ napi_status napi_get_node_version(napi_env env,
34893489
```
34903490

34913491
- `[in] env`: The environment that the API is invoked under.
3492-
- `[out] version`: A pointer to version information for Node itself.
3492+
- `[out] version`: A pointer to version information for Node.js itself.
34933493

34943494
Returns `napi_ok` if the API succeeded.
34953495

doc/api/tracing.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!--introduced_in=v7.7.0-->
44

55
Trace Event provides a mechanism to centralize tracing information generated by
6-
V8, Node core, and userspace code.
6+
V8, Node.js core, and userspace code.
77

88
Tracing can be enabled by passing the `--trace-events-enabled` flag when
99
starting a Node.js application.
@@ -42,8 +42,9 @@ string that supports `${rotation}` and `${pid}`. For example:
4242
node --trace-events-enabled --trace-event-file-pattern '${pid}-${rotation}.log' server.js
4343
```
4444

45-
Starting with Node 10.0.0, the tracing system uses the same time source as the
46-
one used by `process.hrtime()` however the trace-event timestamps are expressed
47-
in microseconds, unlike `process.hrtime()` which returns nanoseconds.
45+
Starting with Node.js 10.0.0, the tracing system uses the same time source
46+
as the one used by `process.hrtime()`
47+
however the trace-event timestamps are expressed in microseconds,
48+
unlike `process.hrtime()` which returns nanoseconds.
4849

4950
[Performance API]: perf_hooks.html

doc/api/zlib.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ decompressed result is valid.
156156

157157
<!--type=misc-->
158158

159-
From `zlib/zconf.h`, modified to node.js's usage:
159+
From `zlib/zconf.h`, modified to Node.js's usage:
160160

161161
The memory requirements for deflate are (in bytes):
162162

doc/guides/building-node-with-ninja.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Building Node with Ninja
1+
# Building Node.js with Ninja
22

33
The purpose of this guide is to show how to build Node.js using [Ninja][], as
44
doing so can be significantly quicker than using `make`. Please see
55
[Ninja's site][Ninja] for installation instructions (unix only).
66

7-
To build Node with ninja, there are 3 steps that must be taken:
7+
To build Node.js with ninja, there are 3 steps that must be taken:
88

99
1. Configure the project's OS-based build rules via `./configure --ninja`.
1010
2. Run `ninja -C out/Release` to produce a compiled release binary.
@@ -27,7 +27,7 @@ compile much faster than even `make -j4` (or
2727
## Considerations
2828

2929
Ninja builds vary slightly from `make` builds. If you wish to run `make test`
30-
after, `make` will likely still need to rebuild some amount of Node.
30+
after, `make` will likely still need to rebuild some amount of Node.js.
3131

3232
As such, if you wish to run the tests, it can be helpful to invoke the test
3333
runner directly, like so:

doc/guides/node-postmortem-support.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
Postmortem metadata are constants present in the final build which can be used
44
by debuggers and other tools to navigate through internal structures of software
5-
when analyzing its memory (either on a running process or a core dump). Node
6-
provides this metadata in its builds for V8 and Node internal structures.
5+
when analyzing its memory (either on a running process or a core dump). Node.js
6+
provides this metadata in its builds for V8 and Node.js internal structures.
77

88

99
### V8 Postmortem metadata
1010

1111
V8 prefixes all postmortem constants with `v8dbg_`, and they allow inspection of
1212
objects on the heap as well as object properties and references. V8 generates
1313
those symbols with a script (`deps/v8/tools/gen-postmortem-metadata.py`), and
14-
Node always includes these constants in the final build.
14+
Node.js always includes these constants in the final build.
1515

16-
### Node Debug Symbols
16+
### Node.js Debug Symbols
1717

1818
Node prefixes all postmortem constants with `nodedbg_`, and they complement V8
1919
constants by providing ways to inspect Node-specific structures, like
@@ -24,8 +24,9 @@ time.
2424

2525
#### Calculating offset of class members
2626

27-
Node constants referring to the offset of class members in memory are calculated
28-
at compile time. Because of that, those class members must be at a fixed offset
27+
Node.js constants referring to the offset of class members in memory
28+
are calculated at compile time.
29+
Because of that, those class members must be at a fixed offset
2930
from the start of the class. That's not a problem in most cases, but it also
3031
means that those members should always come after any templated member on the
3132
class definition.

doc/guides/writing-tests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ The test can be executed by running the `cctest` target:
365365
$ make cctest
366366
```
367367

368-
### Node test fixture
368+
### Node.js test fixture
369369
There is a [test fixture][] named `node_test_fixture.h` which can be included by
370370
unit tests. The fixture takes care of setting up the Node.js environment
371371
and tearing it down after the tests have finished.

tools/icu/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ internationalization functionality.
2020

2121
## How to upgrade ICU
2222

23-
- Make sure your node workspace is clean (clean `git status`) should be
23+
- Make sure your Node.js workspace is clean (clean `git status`) should be
2424
sufficient.
25-
- Configure Node with the specific [ICU version](http://icu-project.org/download)
25+
- Configure Node.js with the specific [ICU version](http://icu-project.org/download)
2626
you want to upgrade to, for example:
2727

2828
```shell
@@ -40,7 +40,7 @@ make
4040
- Specifically, look for the lists in `sources!` in the `icu-generic.gyp` for
4141
files to exclude.
4242

43-
- Verify the node build works:
43+
- Verify the Node.js build works:
4444

4545
```shell
4646
make test-ci
@@ -62,7 +62,7 @@ new Intl.DateTimeFormat('es', {month: 'long'}).format(new Date(9E8));
6262
python tools/icu/shrink-icu-src.py
6363
```
6464

65-
- Now, do a clean rebuild of node to test:
65+
- Now, do a clean rebuild of Node.js to test:
6666

6767
```shell
6868
make -k distclean
@@ -84,7 +84,7 @@ new Intl.DateTimeFormat('es', {month: 'long'}).format(new Date(9E8));
8484
You are ready to check in the updated `deps/small-icu`. This is a big commit,
8585
so make this a separate commit from the smaller changes.
8686

87-
- Now, rebuild the Node license.
87+
- Now, rebuild the Node.js license.
8888

8989
```shell
9090
# clean up - remove deps/icu
@@ -116,7 +116,7 @@ make test-ci
116116

117117
## Postscript about the tools
118118

119-
The files in this directory were written for the node.js effort.
119+
The files in this directory were written for the Node.js effort.
120120
It was the intent of their author (Steven R. Loomis / srl295) to
121121
merge them upstream into ICU, pending much discussion within the
122122
ICU-TC.
@@ -125,7 +125,7 @@ ICU-TC.
125125
configuration file for the `icutrim.py` script. `icutrim.py` and
126126
`iculslocs.cpp` may themselves be superseded by components built into
127127
ICU in the future. As of this writing, however, the tools are separate
128-
entities within Node, although theyare being scrutinized by interested
128+
entities within Node.js, although theyare being scrutinized by interested
129129
members of the ICU-TC. The “upstream” ICU bugs are given below.
130130

131131
* [#10919](http://bugs.icu-project.org/trac/ticket/10919)

0 commit comments

Comments
 (0)