Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuta Hiroto <git@about-hiroppy.com>2018-03-04 16:46:49 +0300
committerLeko <leko.noor@gmail.com>2018-03-05 18:46:30 +0300
commit35c7238bb793ee6c6aa9f5f4f3577e94ea2b9837 (patch)
treeed7dd64b71ba39d8e7cfd015f5cdc3ce2fb50391 /doc/guides
parent3ed363cb36a9fb686956c0b8b2953ff08a6f0ee8 (diff)
doc: replace to Node.js
PR-URL: https://github.com/nodejs/node/pull/19056 Reviewed-By: Matheus Marchini <matheus@sthima.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
Diffstat (limited to 'doc/guides')
-rw-r--r--doc/guides/building-node-with-ninja.md6
-rw-r--r--doc/guides/node-postmortem-support.md13
-rw-r--r--doc/guides/writing-tests.md2
3 files changed, 11 insertions, 10 deletions
diff --git a/doc/guides/building-node-with-ninja.md b/doc/guides/building-node-with-ninja.md
index a70d78fd7aa..4391d56bdbc 100644
--- a/doc/guides/building-node-with-ninja.md
+++ b/doc/guides/building-node-with-ninja.md
@@ -1,10 +1,10 @@
-# Building Node with Ninja
+# Building Node.js with Ninja
The purpose of this guide is to show how to build Node.js using [Ninja][], as
doing so can be significantly quicker than using `make`. Please see
[Ninja's site][Ninja] for installation instructions (unix only).
-To build Node with ninja, there are 3 steps that must be taken:
+To build Node.js with ninja, there are 3 steps that must be taken:
1. Configure the project's OS-based build rules via `./configure --ninja`.
2. Run `ninja -C out/Release` to produce a compiled release binary.
@@ -27,7 +27,7 @@ compile much faster than even `make -j4` (or
## Considerations
Ninja builds vary slightly from `make` builds. If you wish to run `make test`
-after, `make` will likely still need to rebuild some amount of Node.
+after, `make` will likely still need to rebuild some amount of Node.js.
As such, if you wish to run the tests, it can be helpful to invoke the test
runner directly, like so:
diff --git a/doc/guides/node-postmortem-support.md b/doc/guides/node-postmortem-support.md
index e29d9ca3a1f..07897482fa2 100644
--- a/doc/guides/node-postmortem-support.md
+++ b/doc/guides/node-postmortem-support.md
@@ -2,8 +2,8 @@
Postmortem metadata are constants present in the final build which can be used
by debuggers and other tools to navigate through internal structures of software
-when analyzing its memory (either on a running process or a core dump). Node
-provides this metadata in its builds for V8 and Node internal structures.
+when analyzing its memory (either on a running process or a core dump). Node.js
+provides this metadata in its builds for V8 and Node.js internal structures.
### V8 Postmortem metadata
@@ -11,9 +11,9 @@ provides this metadata in its builds for V8 and Node internal structures.
V8 prefixes all postmortem constants with `v8dbg_`, and they allow inspection of
objects on the heap as well as object properties and references. V8 generates
those symbols with a script (`deps/v8/tools/gen-postmortem-metadata.py`), and
-Node always includes these constants in the final build.
+Node.js always includes these constants in the final build.
-### Node Debug Symbols
+### Node.js Debug Symbols
Node prefixes all postmortem constants with `nodedbg_`, and they complement V8
constants by providing ways to inspect Node-specific structures, like
@@ -24,8 +24,9 @@ time.
#### Calculating offset of class members
-Node constants referring to the offset of class members in memory are calculated
-at compile time. Because of that, those class members must be at a fixed offset
+Node.js constants referring to the offset of class members in memory
+are calculated at compile time.
+Because of that, those class members must be at a fixed offset
from the start of the class. That's not a problem in most cases, but it also
means that those members should always come after any templated member on the
class definition.
diff --git a/doc/guides/writing-tests.md b/doc/guides/writing-tests.md
index 28a062d8b79..4dbc8163d1b 100644
--- a/doc/guides/writing-tests.md
+++ b/doc/guides/writing-tests.md
@@ -365,7 +365,7 @@ The test can be executed by running the `cctest` target:
$ make cctest
```
-### Node test fixture
+### Node.js test fixture
There is a [test fixture][] named `node_test_fixture.h` which can be included by
unit tests. The fixture takes care of setting up the Node.js environment
and tearing it down after the tests have finished.