1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: edit BUILDING.md

Browse Source 
Minor edits to BUILDING.md to keep sentences short and clear.

PR-URL: https://github.com/nodejs/node/pull/24243
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
This commit is contained in:
Rich Trott 2018-11-07 22:43:45 -08:00
parent 53d424a328
commit c17fef7ffb
1 changed files with 10 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
BUILDING.md
View File

@ -70,8 +70,7 @@ There are three support tiers:
### Supported platforms ### Supported platforms
The community does not build or test against end-of-life distributions (EoL). The community does not build or test against end-of-life distributions (EoL).
Thus, we do not recommend that you use Node.js on end-of-life or unsupported For production applications, run Node.js on supported platforms only.
platforms in production.
| System | Support type | Version | Architectures | Notes | | System | Support type | Version | Architectures | Notes |
| ------------ | ------------ | ------------------------------- | ---------------- | ----------------------------- | | ------------ | ------------ | ------------------------------- | ---------------- | ----------------------------- |
@ -135,21 +134,20 @@ OpenSSL-1.1.0 requires the following assembler version for use of asm
support on x86_64 and ia32. support on x86_64 and ia32.
* gas (GNU assembler) version 2.23 or higher * gas (GNU assembler) version 2.23 or higher
* xcode version 5.0 or higher * Xcode version 5.0 or higher
* llvm version 3.3 or higher * llvm version 3.3 or higher
* nasm version 2.10 or higher in Windows * nasm version 2.10 or higher in Windows
Otherwise `configure` will fail with an error. This can be avoided by If compiling without one of the above, use `configure` with the
either providing a newer assembler as per the list above or by `--openssl-no-asm` flag. Otherwise, `configure` will fail.
using the `--openssl-no-asm` flag.
The forthcoming OpenSSL-1.1.1 will have different requirements. Please refer to The forthcoming OpenSSL-1.1.1 will have different requirements. Please refer to
https://www.openssl.org/docs/man1.1.1/man3/OPENSSL_ia32cap.html for details. https://www.openssl.org/docs/man1.1.1/man3/OPENSSL_ia32cap.html for details.
## Building Node.js on supported platforms ## Building Node.js on supported platforms
*Note:* All prerequisites can be easily installed by following The [bootstrapping guide](https://github.com/nodejs/node/blob/master/tools/bootstrap/README.md)
[this bootstrapping guide](https://github.com/nodejs/node/blob/master/tools/bootstrap/README.md). explains how to install all prerequisites.
### Unix/macOS ### Unix/macOS
@ -160,7 +158,7 @@ The forthcoming OpenSSL-1.1.1 will have different requirements. Please refer to
* Python 2.6 or 2.7 * Python 2.6 or 2.7
* GNU Make 3.81 or newer * GNU Make 3.81 or newer
On macOS, you will need to install the `Xcode Command Line Tools` by running On macOS, install the `Xcode Command Line Tools` by running
`xcode-select --install`. Alternatively, if you already have the full Xcode `xcode-select --install`. Alternatively, if you already have the full Xcode
installed, you can find them under the menu `Xcode -> Open Developer Tool -> installed, you can find them under the menu `Xcode -> Open Developer Tool ->
More Developer Tools...`. This step will install `clang`, `clang++`, and More Developer Tools...`. This step will install `clang`, `clang++`, and
@ -181,13 +179,9 @@ $ ./configure
$ make -j4 $ make -j4
``` ```
Running `make` with the `-j4` flag will cause it to run 4 compilation jobs The `-j4` option will cause `make` to run 4 simultaneous compilation jobs which
concurrently which may significantly reduce build time. The number after `-j` may reduce build time. For more information, see the
can be changed to best suit the number of processor cores on your machine. If [GNU Make Documentation](https://www.gnu.org/software/make/manual/html_node/Parallel.html).
you run into problems running `make` with concurrency, try running it without
the `-j4` flag. See the
[GNU Make Documentation](https://www.gnu.org/software/make/manual/html_node/Parallel.html)
for more information.
Note that the above requires that `python` resolve to Python 2.6 or 2.7 Note that the above requires that `python` resolve to Python 2.6 or 2.7
and not a newer version. and not a newer version.