Skip to content

Commit 30dbc9d

Browse files
committed
doc: update BUILDING.md
* General copy-editing * Move `[sudo] make install` step from general Unix build to own step * Remove `make test-addons` as that is now covered by `make test` * Standardize on `/path/to/foo` as used elsewhere in the doc * Change `node -e` to `./node -e` to avoid using different node binary PR-URL: nodejs#8398 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent a945244 commit 30dbc9d

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

BUILDING.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Building Node.js
22

3-
Depending on what platform or features you require the build process may
3+
Depending on what platform or features you require, the build process may
44
differ slightly. After you've successfully built a binary, running the
55
test suite to validate that the binary works as intended is a good next step.
66

@@ -25,13 +25,13 @@ On OS X, you will also need:
2525
* This step will install `gcc` and the related toolchain containing `make`
2626

2727
On FreeBSD and OpenBSD, you may also need:
28-
* libexecinfo (FreeBSD and OpenBSD only)
28+
* libexecinfo
2929

30+
To build Node.js:
3031

3132
```console
3233
$ ./configure
3334
$ make
34-
$ [sudo] make install
3535
```
3636

3737
If your Python binary is in a non-standard location or has a
@@ -41,7 +41,6 @@ non-standard name, run the following instead:
4141
$ export PYTHON=/path/to/python
4242
$ $PYTHON ./configure
4343
$ make
44-
$ [sudo] make install
4544
```
4645

4746
To run the tests:
@@ -50,12 +49,6 @@ To run the tests:
5049
$ make test
5150
```
5251

53-
To run the native module tests:
54-
55-
```console
56-
$ make test-addons
57-
```
58-
5952
To run the npm test suite:
6053

6154
*note: to run the suite on node v4 or earlier you must first*
@@ -76,11 +69,9 @@ $ make doc
7669
If you have an existing Node.js you can build just the docs with:
7770

7871
```console
79-
$ NODE=node make doc-only
72+
$ NODE=/path/to/node make doc-only
8073
```
8174

82-
(Where `node` is the path to your executable.)
83-
8475
To read the documentation:
8576

8677
```console
@@ -90,7 +81,13 @@ $ man doc/node.1
9081
To test if Node.js was built correctly:
9182

9283
```console
93-
$ node -e "console.log('Hello from Node.js ' + process.version)"
84+
$ ./node -e "console.log('Hello from Node.js ' + process.version)"
85+
```
86+
87+
To install this version of Node.js into a system directory:
88+
89+
```console
90+
$ [sudo] make install
9491
```
9592

9693

0 commit comments

Comments
 (0)