Skip to content

Commit

Permalink
doc: improve BUILDING.md
Browse files Browse the repository at this point in the history
PR-URL: #23976
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
  • Loading branch information
Jagannath Bhat authored and MylesBorins committed Nov 27, 2018
1 parent a35e8f1 commit a9dcf6f
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ platforms in production.
by Joyent. SmartOS images >= 16.4 are not supported because
GCC 4.8 runtime libraries are not available in their pkgsrc repository

<em id="fn2">2</em>: Tier 1 support for building on Windows is only on 64 bit
hosts. Support is experimental for 32 bit hosts.
<em id="fn2">2</em>: Tier 1 support for building on Windows is only on 64-bit
hosts. Support is experimental for 32-bit hosts.

<em id="fn3">3</em>: On Windows, running Node.js in Windows terminal emulators
like `mintty` requires the usage of [winpty](https://github.com/rprichard/winpty)
Expand All @@ -114,7 +114,7 @@ platforms in production.

### Supported toolchains

Depending on host platform, the selection of toolchains may vary.
Depending on the host platform, the selection of toolchains may vary.

#### Unix

Expand All @@ -126,11 +126,11 @@ Depending on host platform, the selection of toolchains may vary.

#### Windows

* Visual Studio 2017 with the Windows 10 SDK on a 64 bit host.
* Visual Studio 2017 with the Windows 10 SDK on a 64-bit host.

#### OpenSSL asm support

OpenSSL-1.1.0 requires the following asssembler version for use of asm
OpenSSL-1.1.0 requires the following assembler version for use of asm
support on x86_64 and ia32.

* gas (GNU assembler) version 2.23 or higher
Expand Down Expand Up @@ -314,7 +314,7 @@ These core dumps are useful for debugging when provided with the
corresponding original debug binary and system information.

Reading the core dump requires `gdb` built on the same platform the core dump
was captured on (i.e. 64 bit `gdb` for `node` built on a 64 bit system, Linux
was captured on (i.e. 64-bit `gdb` for `node` built on a 64-bit system, Linux
`gdb` for `node` built on Linux) otherwise you will get errors like
`not in executable format: File format not recognized`.

Expand Down Expand Up @@ -433,7 +433,7 @@ $ ./configure --without-intl
$ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu
```

If you are cross compiling, your `pkg-config` must be able to supply a path
If you are cross-compiling, your `pkg-config` must be able to supply a path
that works for both your host and target environments.

#### Build with a specific ICU:
Expand Down Expand Up @@ -481,7 +481,7 @@ This version of Node.js does not support FIPS.
## Building Node.js with external core modules

It is possible to specify one or more JavaScript text files to be bundled in
the binary as builtin modules when building Node.js.
the binary as built-in modules when building Node.js.

### Unix/macOS

Expand Down

0 comments on commit a9dcf6f

Please sign in to comment.