Commit Graph

243 Commits

Author SHA1 Message Date
Michaël Zasso
913d36d97d
build: recommend Python 3.8 to build on Windows
PR-URL: https://github.com/nodejs/node/pull/34182
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2020-07-13 11:52:04 +02:00
Michaël Zasso
89428c7a2d
build: drop support for VS2017
PR-URL: https://github.com/nodejs/node/pull/33694
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: João Reis <reis@janeasystems.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
2020-06-12 15:48:28 +02:00
sapics
a437a84f80 doc: fix urls to avoid redirection
Replace redirected urls with the final ones.
Replace http urls with https ones.

PR-URL: https://github.com/nodejs/node/pull/33614
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2020-05-30 10:01:57 -07:00
osher
d6913dc1f0
doc: mention python3-distutils dependency in BUILDING.md
Ran into #30189, solved by this comment:
https://github.com/nodejs/node/issues/30189#issuecomment-548250793

Refs: https://github.com/nodejs/node/issues/30189
PR-URL: https://github.com/nodejs/node/pull/33174
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Christian Clauss <cclauss@me.com>
2020-05-08 01:20:48 +02:00
Nick Schonning
7183d70273 doc: add angle brackets around implicit links
PR-URL: https://github.com/nodejs/node/pull/32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-04-23 21:48:17 -07:00
Richard Lau
f22a9cac36 doc: update cross compiler machine for Linux armv7
Update cross compiler machine for Linux armv7 to Ubuntu 18.04.

Signed-off-by: Richard Lau <riclau@uk.ibm.com>

PR-URL: https://github.com/nodejs/node/pull/32812
Refs: https://github.com/nodejs/build/issues/2168
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2020-04-15 12:04:52 -07:00
Richard Lau
76c74b38f2 doc: update Centos/RHEL releases use devtoolset-8
Releases built on Centos/RHEL have been updated to use devtoolset-8.

Signed-off-by: Richard Lau <riclau@uk.ibm.com>

PR-URL: https://github.com/nodejs/node/pull/32812
Refs: https://github.com/nodejs/build/issues/2168
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2020-04-15 12:04:49 -07:00
Richard Lau
ceca86740e doc: remove SmartOS from official binaries
Based on feedback from Joyent, the SmartOS builds are largely unusable
without bundling all of the libraries used to build the binary so are
being dropped starting from Node.js 14. We will still test SmartOS in
the CI.

Signed-off-by: Richard Lau <riclau@uk.ibm.com>

PR-URL: https://github.com/nodejs/node/pull/32812
Refs: https://github.com/nodejs/build/issues/2168
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2020-04-15 12:04:46 -07:00
himself65
4d59253bc3
tools: update Boxstarter script and document
PR-URL: https://github.com/nodejs/node/pull/32299
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2020-04-05 20:43:20 +02:00
gengjiawen
9c00af0716 doc: add ASAN build instructions
PR-URL: https://github.com/nodejs/node/pull/32436
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
2020-04-01 02:54:30 +00:00
AshCripps
a621608f12 build: update macos deployment target to 10.13 for 14.x
Update the macos deployment target to 10.13 (High Sierra) for Node 14

refs: https://github.com/nodejs/build/issues/2168

PR-URL: https://github.com/nodejs/node/pull/32454
Refs: https://github.com/nodejs/build/issues/2168
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: James M Snell <jasnell@gmail.com>
2020-03-26 09:41:06 -04:00
Rod Vagg
c933cbfd74
doc: official macOS builds now on 10.15 + Xcode 11
PR-URL: https://github.com/nodejs/node/pull/31459
Refs: https://github.com/nodejs/node/issues/29216
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Ash Cripps <ashley.cripps@ibm.com>
Signed-off-by: Rod Vagg <rod@vagg.org>
2020-03-10 20:15:28 +11:00
João Reis
cb8898c48f win: block running on EOL Windows versions
Windows 7 and Windows Server 2008 R2 EOL was January 14, 2020.
Windows 8 EOL was January 12, 2016.

Windows 2012 (not R2) is still supported and allowed to run. This
clarifies that support is experimental.

PR-URL: https://github.com/nodejs/node/pull/31954
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2020-03-05 03:06:17 +00:00
Ujjwal Sharma
9e805b1fbf
doc: add prerequisites information for Arch
Add prerequisites for Arch Linux and derivatives in BUILDING.md.

PR-URL: https://github.com/nodejs/node/pull/31669
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2020-02-13 21:34:05 +01:00
Swagat Konchada
a733c18e28 doc: add note in BUILDING.md about running make distclean
Fixes: https://github.com/nodejs/node/issues/28675

PR-URL: https://github.com/nodejs/node/pull/31542
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-02-07 08:01:27 -10:00
sutangu
359f590b8d
doc: fix anchors and subtitle in BUILDING.md
PR-URL: https://github.com/nodejs/node/pull/30296
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
2019-12-25 22:18:00 +01:00
Rich Trott
398790149d doc: implement minor improvements to BUILDING.md text
Fix comma splices. Remove unnecessary words. Minor text improvements.

PR-URL: https://github.com/nodejs/node/pull/31070
Reviewed-By: Masashi Hirano <shisama07@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-12-24 19:39:10 -08:00
Rich Trott
6143e0079a doc: clarify build support text
Revise compilation/execution support text to keep it shorter, simpler,
and hopefully easier to read/understand.

PR-URL: https://github.com/nodejs/node/pull/30899
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2019-12-13 10:25:44 -05:00
Rich Trott
76cbb6628c doc: clarify Tier 2 implications in BUILDING.md
Clarify the explanation of Tier 2 platforms and binary releases.

PR-URL: https://github.com/nodejs/node/pull/30866
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2019-12-11 09:43:52 -05:00
Rich Trott
ca11291a62 doc: remove imprecise and redundant testing text
Remove "All commits...are tested on these platforms." for the following
reasons:

* It's somewhat redundant. The surrounding text makes it clear that we
  test on these platforms.
* It's imprecise. Commits, such as those that only affect documentation
  or linting do not get tested on all the platforms. (Well, perhaps they
  do in an after-the-fact kind of way when a subsequent commit gets
  tested, but I think that's a stretch.)

PR-URL: https://github.com/nodejs/node/pull/30763
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2019-12-04 20:08:16 -08:00
Michael Dawson
7bee77f7e2 doc: update status of Python 3 support
Refs: https://github.com/nodejs/TSC/pull/781#issuecomment-559666380
Based on the completion of the Python 3 strategic
initiative, update statements around Python 3 support.

PR-URL: https://github.com/nodejs/node/pull/30722
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2019-12-03 13:43:02 -05:00
David Carlier
73c837b1ae
doc: documenting a bit more FreeBSD case
FreeBSD provides more up to date compilers than
the one provided by the system.

PR-URL: https://github.com/nodejs/node/pull/30325
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: James M Snell <jasnell@gmail.com>
2019-11-30 17:42:07 +01:00
Andrew Hughes
7f94fe0040
doc: add 13 and 12 to previous versions
Remove Node.js 6 and add Node.js 12 and Node.js 13 to the previous
versions of this document section

PR-URL: https://github.com/nodejs/node/pull/30590
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2019-11-27 01:23:58 -05:00
Luigi Pinca
f4b240f012 doc: fix overriding of prefix option
Make the example in the "Building a debug build" section work as
intended.

Fixes: https://github.com/nodejs/node/issues/30477

PR-URL: https://github.com/nodejs/node/pull/30518
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-11-20 16:51:48 -08:00
Rich Trott
c71b89eb06 doc: remove "multiple variants" from BUILDING.md
The statement that tests for tier 1 platforms are run on multiple
variants is not true. We usually only run on one variant of macOS.
Remove "multiple", which simplifies and clarifies the statements anyway.

PR-URL: https://github.com/nodejs/node/pull/30366
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-11-14 09:59:14 -08:00
Rich Trott
ed401236f6 doc: remove "maintenance is supported by" text in BUILDING.md
The "maintenance is supported by" stuff in BUILDING.md is unclear. It
seems unnecessary so I propose removing it.

I don't understand what it means to, in this context, support
maintenance. Does it mean that you simply do the maintenance? Does that
mean it really just means "maintain"? Do we really mean that we mantain
support, rather than support maintenance?

That information does not seem necessary to include. I'm not sure it's
meaningful. With (for example) Windows, is it accurate to say that the
Node.js core team maintains support for it? Or is it accurate to say
that support is maintaned by smaller groups or individuals within the
Node.js core team?  Both could be considered accurate. So is the
difference meaningful?

I think the more important elements of determinig tier support are the
other listed elements.

PR-URL: https://github.com/nodejs/node/pull/30365
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-11-13 21:17:07 -08:00
Kamat, Trivikram
e55d65384d doc: add link to node-code-ide-configs in testing
Refs: https://github.com/orgs/nodejs/teams/collaborators/discussions/58

This config will help contributors to run/debug tests on VSCode

PR-URL: https://github.com/nodejs/node/pull/24012
Reviewed-By: James M Snell <jasnell@gmail.com>
2019-11-11 13:56:32 -08:00
gengjiawen
ed2c3ca6e2 build: add workaround for WSL
Signed-off-by: gengjiawen <technicalcute@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/30221
Fixes: https://github.com/nodejs/node/issues/30189
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2019-11-04 18:04:12 +01:00
Michaël Zasso
3a076bae9c build: allow Python 3.8
PR-URL: https://github.com/nodejs/node/pull/30194
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2019-11-02 14:57:46 +01:00
Michaël Zasso
b554214249
build: default Windows build to Visual Studio 2019
Building and testing Node.js with Visual Studio 2019 is now working as
expected.
Fallback to VS 2017 if VS 2019 was not found.

Fixes: https://github.com/nodejs/node/issues/27214

PR-URL: https://github.com/nodejs/node/pull/30022
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
2019-10-20 16:08:15 +02:00
Steven R. Loomis
1a25e901b7 tools: support full-icu by default
Instead of an English-only icudt64l.dat in the repo,
we now have icudt64l.dat.gz with all locales.

- updated READMEs and docs
- shrinker now copies source, and compresses (bzip2) the ICU data file
- configure expects deps/icu-small to be full ICU with a full
compressed data file

Fixes: https://github.com/nodejs/node/issues/19214
Co-Authored-By: Richard Lau <riclau@uk.ibm.com>
Co-Authored-By: Jan Olaf Krems <jan.krems@gmail.com>
Co-Authored-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/29522

Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2019-10-03 15:21:26 -07:00
Michael Dawson
9f830f37da build: update minimum Xcode version for macOS
Update the minimum Xcode version for macOS to 10. We'll
need this level to incorporate future V8 versions.

Refs: https://github.com/nodejs/node/pull/29493

PR-URL: https://github.com/nodejs/node/pull/29622
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
2019-09-20 15:01:33 -04:00
Michael Dawson
70bc62eaf8 build: update minimum AIX OS level
Update minimum AIX OS level to 7.2 TL2. Looks like this
will be the version we can get into the CI so should be the
base level for 13.X and above and will be in support for the life
of 13.X.

PR-URL: https://github.com/nodejs/node/pull/29476
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2019-09-08 13:35:55 -07:00
Maledong
c6b7e748b0 doc: change urls directly from 'http' to 'https'
There're some URLs with old links, change them together from 'http' to
'https'.

Notice:
1. Since files of CHANGELOG may be generated through tools, I don't
intend to change them together as the history track.
2. All the files in the 'deps' are of 3-rd parties, they will be
overwritten for the next update, so avoid modifications for them.

PR-URL: https://github.com/nodejs/node/pull/29422
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2019-09-05 19:31:52 -07:00
Nick Schonning
a3307eac0e doc: use consistent indenting for unordered list items
Address Markdownlint MD007 rule.
Default suggestion is 2 space indenting for unordered list items.

PR-URL: https://github.com/nodejs/node/pull/29390
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2019-09-03 20:55:39 -07:00
Nick Schonning
9ab1e07774 doc: add blanks around code fences
Addresses Markdownlint MD031 rule warnings

PR-URL: https://github.com/nodejs/node/pull/29366
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: David Carlier <devnexen@gmail.com>
2019-08-31 15:31:13 -07:00
David Guttman
287c3abdc6 doc: improve example single-test command
Changes example command to refer to the full test directory:
`./test/parallel/` instead of `./parallel/`

PR-URL: https://github.com/nodejs/node/pull/29171
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-08-18 16:31:38 -07:00
Tariq Ramlall
7e50bb3dce doc: mention markdown linting in BUILDING.md
BUILDING.md mentioned JS and C++ linting were performed
in the 'make lint' command, but 'make lint' also
performs markdown linting. This commit updates the docs
to include markdown as one of the things being linted.

PR-URL: https://github.com/nodejs/node/pull/28578
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-07-08 15:47:03 -07:00
Gautham B A
d0e3c2346f doc: fix link in build instructions
The right one is #prerequisites.

PR-URL: https://github.com/nodejs/node/pull/28572
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2019-07-06 10:11:09 -07:00
Rod Vagg
b12528f349
doc: merge bootstrap/README.md into BUILDING.md
plus some minor tweaks

PR-URL: https://github.com/nodejs/node/pull/28465
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Sam Roberts <vieuxtech@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>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
2019-07-02 11:36:26 +10:00
Rich Trott
dc5eb64ac8 doc: remote "note that" from BUILDING.md
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/16

PR-URL: https://github.com/nodejs/node/pull/28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-06-23 07:07:06 -07:00
Michael Dawson
8cdc1bdad6 doc: update kernel and glibc reqs for PPCle
We've moved master to build on centos7 for PPCle, adjust
the glibc and kernel levels accordingly.

PR-URL: https://github.com/nodejs/node/pull/28162
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
2019-06-13 18:45:19 -04:00
Aditya Pratap Singh
fa3eefcb83 doc: add example to test doc for clarity
Update the documentation for test execution for tests in a single file

PR-URL: https://github.com/nodejs/node/pull/27561
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-05-07 07:31:58 +02:00
Rod Vagg
b581d59655 doc: update supported platforms for Node.js 12
PR-URL: https://github.com/nodejs/node/pull/26714
Reviewed-By: João Reis <reis@janeasystems.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2019-04-20 10:25:26 +10:00
Rod Vagg
c61c722c8c doc: add ABI version registry
PR-URL: https://github.com/nodejs/node/pull/24114
Refs: https://nodejs.org/en/download/releases/
Refs: https://github.com/lgeiger/node-abi/blob/master/index.js
Refs: https://github.com/nodejs/TSC/issues/621
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
2019-04-17 20:28:04 +10:00
Rich Trott
7ffbb4606f doc: standardize on End-of-Life capitalization
Use "End-of-Life" everywhere and not "End-of-life" or "End-Of-Life".

PR-URL: https://github.com/nodejs/node/pull/26442
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2019-03-06 15:50:43 -08:00
Jon Kunkee
26cfaf4c18 win,build: update Windows build documentation
PR-URL: https://github.com/nodejs/node/pull/25995
Reviewed-By: João Reis <reis@janeasystems.com>
2019-03-04 12:25:39 +00:00
Refael Ackermann
000788ec23
meta: update note about building on smartOS 16
PR-URL: https://github.com/nodejs/node/pull/25684
Refs: https://github.com/nodejs/node/pull/25683
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-03-04 02:16:57 +01:00
João Reis
8d2df41618 meta: clarify EoL platform support
PR-URL: https://github.com/nodejs/node/pull/25838
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2019-02-06 07:18:01 +01:00
cclauss
bb564a3688
build: update prerequisites on progress towards Python 3
As recommended at https://github.com/nodejs/node/pull/25759#issuecomment-458139766
* Python 2.6 end of life statement in 2013: https://www.python.org/dev/peps/pep-0361/#release-lifespan
* Python 2.7 end of life statement in 2019: https://www.python.org/dev/peps/pep-0373/#update
* Python 3.4 reaches it end of life in < 50 days so it should not be a target: https://devguide.python.org/#branchstatus

PR-URL: https://github.com/nodejs/node/pull/25766
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2019-01-31 00:13:58 +01:00
Benjamin Coe
e3f917ef65
doc: running coverage for individual suites
PR-URL: https://github.com/nodejs/node/pull/25622
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2019-01-22 17:24:52 -08:00
Shigeki Ohtsu
57119fbdb2 doc: fix assembler requirement for OpenSSL-1.1.1
Add new requirements of assembler version for AVX-512 support
in OpenSSL-1.1.1.

PR-URL: https://github.com/nodejs/node/pull/25381
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
2019-01-22 13:33:48 -08:00
Benjamin Coe
d1dee495db
test: switch to native v8 coverage
PR-URL: https://github.com/nodejs/node/pull/25157
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
2019-01-20 14:21:16 -08:00
Michael Dawson
6b4e413526 doc: add help on fixing IPv6 test failures
It took me a while to figure out the problem and
then some googling to find the right answer.  I think
it is worth adding this to help other people in the
future and to have an easy place to point people to
for the solution if their test run fails with IPv6
failures.

PR-URL: https://github.com/nodejs/node/pull/24372
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2018-11-16 17:23:14 -05:00
Rich Trott
c17fef7ffb doc: edit BUILDING.md
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>
2018-11-10 08:53:13 -08:00
Jagannath Bhat
ed8562517e doc: improve BUILDING.md
PR-URL: https://github.com/nodejs/node/pull/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>
2018-11-01 19:03:21 -07:00
Rich Trott
51294c897f doc: revise BUILDING.md
Copy-edit for clarity and brevity.

PR-URL: https://github.com/nodejs/node/pull/23966
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-10-31 22:02:28 -07:00
Kamat, Trivikram
8c244ddd98 doc: moved test instructions to BUILDING.md
Fixes: https://github.com/nodejs/node/issues/23491

Duplicate test instructions were present in pull-requests.md
Merged the instructions in BUILDING.md and provided a link from
pull-requests.md

PR-URL: https://github.com/nodejs/node/pull/23949
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2018-10-30 23:00:49 -07:00
Myles Borins
97d9ccdeb8
doc: add note about ABI compatibility
Building node against versions of the dependencies that differ from the
ones we vendor will result in a non ABI compatible version of Node.js

This patch adds a note to make it explicit that if individuals build
node against different versions of a dependency they should make a
custom NODE_MODULE_VERSION.

PR-URL: https://github.com/nodejs/node/pull/22237
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-10-29 15:36:30 -04:00
Steven R. Loomis
d8b6a1d4f6 doc: document and warn if the ICU version is too old
Fixes: https://github.com/nodejs/node/issues/19657

PR-URL: https://github.com/nodejs/node/pull/23766
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
2018-10-23 13:37:48 -07:00
ZYSzys
3e3ce22583 doc: fix index in table of contents in BUILDING.md
Also, a missing colon was added.

PR-URL: https://github.com/nodejs/node/pull/23777
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-10-20 11:10:16 +03:00
Felix Schlenkrich
5a30621d16
doc: add info how to run single tests to BUILDING.md
The information on how to run single tests was missing in
BUILDING.md.

PR-URL: https://github.com/nodejs/node/pull/23490
Fixes: https://github.com/nodejs/node/issues/23491
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-10-15 12:00:00 +02:00
Rich Trott
eeb2c8fcbb doc: edit BUILDING.md
I should have done this a few days ago so it could land in time for Code
& Learn, but oh well. Here are some revisions to BUILDING.md to try to
make it easier to read.

PR-URL: https://github.com/nodejs/node/pull/23435
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
2018-10-14 09:06:41 -07:00
Rich Trott
67130f3ab5 doc: edit building-node text
Simplifying some BUILDING.md and related text since a lot of people will
be reading it soon for Code & Learn. I'd prefer to delete much of this
text, but that risks controversy. These simplifications should be (I
hope) uncontroversial.

PR-URL: https://github.com/nodejs/node/pull/23335
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-10-08 12:35:29 -07:00
ZYSzys
a21af5b1f2 doc: add table of contents in BUILDING.md
PR-URL: https://github.com/nodejs/node/pull/23147
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-09-29 13:20:05 +03:00
Michaël Zasso
c0fb95d700
build: stop supporting FreeBSD 10
FreeBSD 10 is considered a Legacy Release by the FreeBSD project.
Its latest version 10.4 was released in October 2017 and support for it
is expected to EoL on October 31, 2018.

Refs: https://www.freebsd.org/security/security.html#sup

PR-URL: https://github.com/nodejs/node/pull/22617
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
2018-09-04 14:17:01 +02:00
Troels Liebe Bentsen
030ef35bf0
doc: add section on how to build debug build
PR-URL: https://github.com/nodejs/node/pull/22510
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-08-31 19:25:26 +02:00
ZYSzys
56e331a2a2 doc: tweak macOS-firewall note position
Move the macOS-firewall note to the end of "Building Node.js"
and above "Running Tests".

I think it's more reasonable when user prepare to build node
step by step. Just read and build from top to end in case ignore
the note.

PR-URL: https://github.com/nodejs/node/pull/22440
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2018-08-24 08:47:13 +03:00
Refael Ackermann
73b8ddee04 doc: Windows building supported on x64
Since we are CI testing on x64 hosts, we can only commit to x64 hosts.

PR-URL: https://github.com/nodejs/node/pull/21443
Refs: https://github.com/nodejs/node/issues/21402
Refs: https://github.com/nodejs/node/pull/21437
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matheus Marchini <matheus@sthima.com>
Reviewed-By: João Reis <reis@janeasystems.com>
2018-08-16 19:07:52 -04:00
Brandon Lee
05b3176022
doc: correct grammatical error in BUILDING.md
Grammatical error corrected.

PR-URL: https://github.com/nodejs/node/pull/22067
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-08-01 20:41:12 +02:00
Michaël Zasso
945324050b
build: increase macOS minimum supported version
Starting with V8 6.8, it will not be possible to build with macOS 10.10
and below. Those versions are already EoL.

PR-URL: https://github.com/nodejs/node/pull/21883
Refs: https://github.com/nodejs/build/issues/1358
Reviewed-By: Matheus Marchini <matheus@sthima.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2018-07-24 21:24:34 +02:00
XadillaX
d462f8cfe3
doc: add OS X to instead of only macOS
The last OS X version is 10.11 El Captian, and the first macOS version
is 10.12 Sierra. So >= 10.8 < 10.10 is called OS X and >= 10.10 is
called OS X or macOS.

Refs: https://en.wikipedia.org/wiki/MacOS#Release_history

PR-URL: https://github.com/nodejs/node/pull/21033
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-07-13 18:42:06 +02:00
Rich Trott
452d73df23
doc: remove obsolete wiki references from BUILDING
Remove obsolete wiki references from BUILDING.md.

PR-URL: https://github.com/nodejs/node/pull/21369
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-06-18 00:34:01 +05:30
Bartosz Sosnowski
30ad0793ec
doc: describe using multiple link-module on win
Current description seems to suggest that only one linked-module can be
provided. This modifies the example to show that multiple
inked-modules can be used.

PR-URL: https://github.com/nodejs/node/pull/20774
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-05-18 16:15:38 +02:00
Rich Trott
f145a53a78 tools: use macOS as operating system name
As of 2016, the operating system is macOS. Remove use of "macosx".

PR-URL: https://github.com/nodejs/node/pull/20579
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-05-10 14:46:51 -07:00
Shigeki Ohtsu
3bcd8576fc build: limit assembler version check on x86
The current openssl checks assembler version only x86_64 or ia32
target arch for use of AES-NI, AVX and AVX2.
This requires --openssl-no-asm option during configure when an older
assembler version is found only on x86_64 or ia32.

PR-URL: https://github.com/nodejs/node/pull/20226
Fixes: https://github.com/nodejs/node/issues/19944
Refs: https://github.com/nodejs/node/pull/20217
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2018-04-23 11:43:18 -07:00
Spencer Greene
a456775efa doc: fix inconsistency in documentation for building
Specifically, fix the inconsistency where the documentation
suggests running "$ make test" instead of "$ make -j4 test".
The "-j4" flag uses multiple processes, making the command
faster.

Fixes: https://github.com/nodejs/node/issues/19919

PR-URL: https://github.com/nodejs/node/pull/20091
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-04-19 22:45:22 -07:00
Michael Dawson
94596560c2 doc: update required compiler level for AIX
Compilers were updated for 10.X as per
discussion in: https://github.com/nodejs/build/issues/925

PR-URL: https://github.com/nodejs/node/pull/20153
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2018-04-19 15:27:52 -04:00
Beth Griggs
4a0dff785e
build: remove implied support for win 2012 not R2
PR-URL: https://github.com/nodejs/node/pull/19378
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-04-16 03:23:03 +02:00
Joseph Gordon
b003c86bf4 doc: improved flow for macOS firewall script
PR-URL: https://github.com/nodejs/node/pull/18689
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-04-14 20:18:03 -07:00
Shigeki Ohtsu
f3f1298980 build, win: opt-in openssl_no_asm if no nasm found
Instead of automatically falling back to openssl_no_asm with warning
if no nasm is found during build on Windows, this stops vcbuild.bat
and requires users to specify openssl_no_asm option explicitly.

Fixes: https://github.com/nodejs/node/issues/19918
PR-URL: https://github.com/nodejs/node/pull/19943
Refs: https://github.com/nodejs/node/pull/19930
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
2018-04-12 11:19:04 +09:00
João Reis
eec659c138 build, tools, win: add nasm detection for OpenSSL
OpenSSL-1.1.0 requires the nasm assembler for building asm files on
Windows. This finds nasm at \Program Files\NASM\nasm.exe or
\ProgramFiles(x86)\NASM\nasm.exe in vcbuild.bat for users who did not
add its path in their enviroments.

Fixes: https://github.com/nodejs/build/issues/1190
Fixes: https://github.com/nodejs/node/issues/4270
PR-URL: https://github.com/nodejs/node/pull/19794
Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2018-04-10 06:45:45 +09:00
Shigeki Ohtsu
08af7dba2a build: add OpenSSL-1.1.0 support
- For Windows, nasm is new build requirements and openssl_no_asm is
  set to 1 with warning if it is not installed.
- For use of openssl assemble codes, either gas_version >= 2.23,
  xcode_version >= 5.0 ,llvm_version >= 3.3 or nasm_version >= 2.10 is
  needed. Otherwise, openssl_no_asm is set to 1 with warning.
- FIPS is not supported in OpenSSL-1.1.0 so that it leads an error
  when openssl_fips options is enabled in configure.

Fixes: https://github.com/nodejs/node/issues/4270
PR-URL: https://github.com/nodejs/node/pull/19794
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2018-04-10 06:45:45 +09:00
Ayush Gupta
0d5720bf03 doc: document make docopen
Documented `make docopen` as a way to read documentation in the browser.

PR-URL: https://github.com/nodejs/node/pull/19321
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-03-25 22:56:38 -07:00
Gibson Fahnestock
099e621648
build: update arm64 minimum supported platform
This is already true in practice.

PR-URL: https://github.com/nodejs/node/pull/19164
Fixes: https://github.com/nodejs/build/issues/1164
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2018-03-09 17:25:45 +00:00
estrada9166
a29089d7c8
doc: add new documentation lint rule
Add 80 characters limit to docs.
Change docs to fit 80 characters per row.

PR-URL: https://github.com/nodejs/node/pull/18726
Fixes: https://github.com/nodejs/node/issues/18703
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
2018-02-23 16:26:29 +00:00
Suixinlei
f2e62b5238
doc: add builtin module in building.md
Fixes: https://github.com/nodejs/node/issues/12516
Refs: https://github.com/nodejs/node/pull/2497

PR-URL: https://github.com/nodejs/node/pull/17705
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-01-18 21:36:32 +08:00
Matheus Marchini
c134ff24f4
doc: warn users about non-ASCII paths on build
The build breaks if there's a non-ASCII character on
the path to the building directory.

PR-URL: https://github.com/nodejs/node/pull/16735
Refs: https://github.com/nodejs/node/issues/16278
Refs: https://github.com/nodejs/node/issues/14336
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2018-01-18 21:27:00 +08:00
Joyee Cheung
e8c491a801
doc: prefer make test-only when verifying the build
PR-URL: https://github.com/nodejs/node/pull/18061
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
2018-01-12 21:34:56 +08:00
Rich Trott
ec00ee89f5 doc: multiple updates to BUILDING.md
* remove spaces around slash in BUILDING.md
* hyphenate _end-of-life_ in BUILDING.md
* add missing comma in BUILDING.md
* add missing backticks in BUILDING.md
* add missing comma to BUILDING.md

PR-URL: https://github.com/nodejs/node/pull/17985
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2018-01-09 16:03:04 -08:00
Rich Trott
4426d75ede doc: simplify and clarify FIPS text in BUILDING.md
PR-URL: https://github.com/nodejs/node/pull/17538
Fixes: https://github.com/nodejs/node/issues/17536
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
2017-12-10 15:42:18 -08:00
Bartosz Sosnowski
61d46dd7e0 tools: add Boxstarter script
Adds a Boxstarter script for easy Node.js building prerequisites installation

PR-URL: https://github.com/nodejs/node/pull/17046
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: João Reis <reis@janeasystems.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-11-30 11:35:45 +01:00
João Reis
04566d3698 build,win,msi: support WiX with VS2017
PR-URL: https://github.com/nodejs/node/pull/17101
Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com>
2017-11-28 23:11:15 +00:00
João Reis
d8debd8448 doc,win: clarify WSL support
Fixes: https://github.com/nodejs/node/issues/13471
PR-URL: https://github.com/nodejs/node/pull/17008
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Hitesh Kanwathirtha <hiteshk@microsoft.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2017-11-17 17:41:20 +00:00
Refael Ackermann
dbb3c00d9d
meta: 32 bit linux is experimental
PR-URL: https://github.com/nodejs/node/pull/16723
Refs: https://github.com/nodejs/build/issues/885
Refs: https://github.com/nodejs/nodejs.org/pull/1446
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
2017-11-13 14:56:31 -05:00
Nikolai Vavilov
c5a49e148d doc: drop support for VS2015
PR-URL: https://github.com/nodejs/node/pull/16868
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2017-11-12 17:44:25 +02:00
Nikolai Vavilov
ff21851816 doc: clarify the prerequisites for building with VS2017
* "Edition" is ambiguous. For example, Visual Studio Team Explorer 2017
  is listed under "Visual Studio 2017", but Build Tools for Visual
  Studio 2017 is listed under "Other Tools and Frameworks".
* The listed required components are insufficient. VS2017 also needs
  "Visual Studio C++ core features", and Build Tools also needs
  "Visual C++ Build Tools core features".
* Installing the workload with the default optional components takes up
  only about 1GB more space than the minimal set of components, but
  saves scrolling through the long list of individual components.

PR-URL: https://github.com/nodejs/node/pull/16903
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: João Reis <reis@janeasystems.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2017-11-11 16:53:22 +02:00
Tim Ermilov
641ba5ecfa
doc: document windows shell support
explain that Git Bash and Cygwin require winpty to work correctly.
Added info on Git Bash running winpty automatically
when running node without .exe extension.

PR-URL: https://github.com/nodejs/node/pull/16104
Fixes: https://github.com/nodejs/node/issues/14100
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
2017-10-12 10:45:05 -04:00
suraiyah
e8bf4d5dea doc: fix macosx-firewall suggestion BUILDING
Adding back the changes made by commit# 791d560, that suggests running
macosx-firewall.sh script after bulid step. These changes were deleted
by commit# fc102d0, but they are still applicable.

PR-URL: https://github.com/nodejs/node/pull/15829
Reviewed-By: Ryan Graham <r.m.graham@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
2017-10-09 10:32:32 +02:00
Emily Platzer
3f263403e5
doc: add clearer setup description
Updated console example to follow style of rest of the examples

PR-URL: https://github.com/nodejs/node/pull/15962
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2017-10-08 15:12:54 -07:00
Simon Brewster
6e27fd7bde doc: instructions for generating coverage reports
Add instructions for generating code coverage reports to BUILDING.md

PR-URL: https://github.com/nodejs/node/pull/15190
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2017-09-06 22:13:00 -07:00
Refael Ackermann
0babb12494
doc: building - note on Windows SDK 15063
PR-URL: https://github.com/nodejs/node/pull/14394
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: João Reis <reis@janeasystems.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2017-08-27 11:00:49 -03:00
Kyle Lamse
43029da762 doc: add note for Windows build path
PR-URL: https://github.com/nodejs/node/pull/14354
Fixes: https://github.com/nodejs/node/issues/14337
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2017-08-24 08:11:08 -07:00
Jon Moss
0914880229 doc: add missing word
PR-URL: https://github.com/nodejs/node/pull/14924
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2017-08-18 14:25:22 -07:00
Michaël Zasso
2062a69879 build: stop support building addons with VS 2013
PR-URL: https://github.com/nodejs/node/pull/14764
Refs: https://github.com/nodejs/node/pull/14730#issuecomment-321609328
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2017-08-18 10:46:05 +02:00
Ben Noordhuis
d13a65ad68 doc: update minimum g++ version to 4.9.4
The 4.8.x releases don't fully support C++11.  Update the prerequisites
for node.js 8 so that we won't have to work around compiler bugs in the
future.

To be decided if we should also update the minimum clang version.
I believe clang 3.4.2 properly supports C++11 but am not 100% sure.

PR-URL: https://github.com/nodejs/node/pull/13466
Ref: https://github.com/nodejs/node/pull/11840
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com>
2017-06-15 11:04:17 -07:00
Gibson Fahnestock
6cc63797bc
doc: note that EoL platforms are not supported
Add a note to clarify that any platform that is EoL will not be
supported by Node.js.

PR-URL: https://github.com/nodejs/node/pull/12672
Fixes: https://github.com/nodejs/build/issues/688
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2017-06-14 14:25:19 +01:00
cjihrig
29b63a14db doc: update linux supported versions
The libuv 1.12.0 update bumped the minimum supported version
of linux + glibc. This commit updates BUILDING.md to reflect
the new values.

PR-URL: https://github.com/nodejs/node/pull/13306
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2017-06-07 09:32:33 -04:00
Gibson Fahnestock
fc102d0197
doc: suggest xcode-select --install
If you don't have the full Xcode installed, the command-line tools are
all you need.

PR-URL: https://github.com/nodejs/node/pull/13264
Fixes: https://github.com/nodejs/node/issues/6449
Refs: https://github.com/nodejs/node/pull/9215
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2017-06-03 19:40:43 +01:00
Daijiro Wachi
1d60fc3aa5 doc: fix doc styles
BUILDING.md
  + L122: Missing code-language flag
  + L170: Strong should use `*` as a marker

doc/changelogs/CHANGELOG_V6.md
  + L1494: Don't pad `emphasis` with inner spaces

doc/guides/maintaining-V8.md
  + L3: Don't use multiple top level headings
  + L16: Don't use multiple top level headings
  + L40: Don't use multiple top level headings
  + L124: Don't use multiple top level headings
  + L182: Missing code-language flag
  + L223: Don't use multiple top level headings
  + L288: Don't use multiple top level headings
  + L307: Don't use multiple top level headings

doc/guides/writing-tests.md
  + L322: Missing code-language flag
  + L329: Missing code-language flag

doc/releases.md
  + L299: Missing code-language flag

PR-URL: https://github.com/nodejs/node/pull/13270
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2017-05-30 19:18:48 +02:00
Rich Trott
a398516b4f
doc: remove test-npm from general build doc
`make test-npm` is not particularly robust (currently fails on Linux and
Windows, reportedly) and results in a fair number of requests for help
from people new to the project. It is used when upgrading npm in core,
which only a small number of mostly-predefined people do. Remove it from
the general build doc.

Refs: https://github.com/nodejs/node/issues/12836
PR-URL: https://github.com/nodejs/node/pull/12840
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2017-05-07 22:48:51 +02:00
Refael Ackermann
1c93e8c94b
win: make buildable on VS2017
* Set default to `vs2015` since `vs2017` is not CI-green yet
* changes vcbuild.bat arg from `vc2015` to `vs2015`/`vs2017`
  `vc` as in Visual C++ is actually versions 14.0 or 14.10
  `vs` as in Visual Studio is 2015 or 2017
  Ref: http://lists.boost.org/Archives/boost/2017/03/233597.php 🤦
* keep `vc2015` for backward compatibility but "undocumented"
* tools: transplant vswhere wrapper from `msvs-com-helper`
  Ref: https://github.com/node4good/msvs-com-helper

PR-URL: https://github.com/nodejs/node/pull/11852
Reviewed-By: João Reis <reis@janeasystems.com>
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-05-05 10:36:05 +02:00
Michael Dawson
71911be1de
doc: clarify arch support for power platforms
Add specifics as to the level of hardware supported for
power platforms.  Power 8 is the first processor level to
support ppc little endian.  Set the minimum level
for AIX to Power7 for Node version 8 and later.
This will allow the potential to leverage new instructions
and optimizations going forward.  We have spoken to the
AIX team and they agree this makes sense. Earlier processor
levels will continue to be supported for version 4.x and 6.x
on AIX.

PR-URL: https://github.com/nodejs/node/pull/12679
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2017-04-28 19:06:27 +01:00
Michaël Zasso
b4f59a7460 doc: upgrade Clang requirement to 3.4.2
Clang 3.4.1 has a bug that prevents compilation of V8.
As of Node.js 8.0.0 we stopped floating a workaround for this issue.

PR-URL: https://github.com/nodejs/node/pull/12388
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-04-18 11:50:00 -07:00
Michael Dawson
75c471a026 doc: drop PPC BE from supported platforms
We've discussed this with the Power team within IBM and have
agreement that we should drop Power Linux BE for Node version
8 as customers will be using Power Linux LE when using
Node.js going forward.

PR-URL: https://github.com/nodejs/node/pull/12309
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Reviewed-By: Jaideep Bajwa <bjaideep@ca.ibm.com>
2017-04-12 15:15:12 -04:00
Michael Dawson
c6e0ba31ec doc: update OS level support for AIX
Update OS level supprot for AIX.  Based on discussions
with the AIX team we've have decided that the minimum
support level should be 7.1. This is because support
for AIX 6.1 will likely end during the lifespan of
the upcoming Node version 8 release.

PR-URL: https://github.com/nodejs/node/pull/12235
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-04-07 12:35:08 -04:00
JR McEntee
7a5d07c7fb doc: change Mac OS X to macOS
This update changes references to "Mac OS X", "OS X", and "OSX" in
markdown files to "macOS".

PR-URL: https://github.com/nodejs/node/pull/12106
Fixes: https://github.com/nodejs/node/issues/12086
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2017-04-04 10:14:24 -07:00
Sakthipriyan Vairamani (thefourtheye)
ba0e3ac53d
doc: minor improvements in BUILDING.md
1. necessarily reliably => necessarily reliable
2. projects root directory => project's root directory
3. remove `console` highlighting, as `test` alone is highlighted
4. fix broken link for Android NDK
5. highlight the directory location `/usr/local/ssl/fips-2.0`
6. update expected output to an example for `process.versions.openssl` as the
   version displayed is not mentioned in the document

PR-URL: https://github.com/nodejs/node/pull/11963

Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-04-04 13:08:12 +05:30
Michael Dawson
ef4768754c doc: add supported platforms list
PR-URL: https://github.com/nodejs/node/pull/11872
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-03-20 13:43:15 -04:00
detailyang
746339ef6d doc: gcc version is at least 4.8.5 in BUILDING.md
>= 4.8.5 is required because of compiler bugs in earlier versions

PR-URL: https://github.com/nodejs/node/pull/11840
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2017-03-16 15:21:32 -07:00
Gibson Fahnestock
93c4820458 Revert "doc: correct vcbuild options for windows testing"
This reverts commit ed9b6c1264.

PR-URL: https://github.com/nodejs/node/pull/10839
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
2017-01-21 12:00:54 +00:00
Jonathan Boarman
ed9b6c1264 doc: correct vcbuild options for windows testing
Corrected parameter for running tests on Windows. Without the corrected
parameters, Windows users encounter an error about failing to sign the
build, "Failed to sign exe", which can be discouraging to new Windows
community members.

PR-URL: https://github.com/nodejs/node/pull/10686
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
2017-01-10 10:11:24 -08:00
Lukasz Gasior
c9b52aad0a doc: update BUILDING.md
Added a note about Visual Studio 2015 feature which should
be installed for building Node.js source code.

PR-URL: https://github.com/nodejs/node/pull/10669
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2017-01-09 23:28:02 -08:00
Chase Starr
791d560bb3 doc: clarify macosx-firewall suggestion BUILDING
`./tools/macosx-firewall.sh` fails if run before build step. Since the
suggestion comes before the build steps in the document, this change
clarifies that the script should be run after building.

PR-URL: https://github.com/nodejs/node/pull/10311
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Italo A. Casas <me@italoacasas.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-12-22 22:30:54 -08:00
Joe Doyle
92ed1ab450 build: change nosign flag to sign and flips logic
Makes the default build on Windows not try to sign the node.exe
binary after a build. Instead the 'sign' flag now indicates that the
binary should be signed. The 'nosign' flag is left as a noop.

Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: João Reis <reis@janeasystems.com>
PR-URL: https://github.com/nodejs/node/pull/10156
2016-12-18 01:19:34 +00:00
Jonathan Darling
cffbb326a2 doc: add note to parallelize make
Adds a note to the BUILDING doc to encourage parallelizing make. When I
first built node I didn't know this trick and thought that the build was
just stuck in an infinite loop after waiting for 10 minutes.

Refs: https://github.com/nodejs/node/issues/8286
Refs: https://github.com/nodejs/node/pull/9881

PR-URL: https://github.com/nodejs/node/pull/9961
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
2016-12-09 15:52:44 -05:00
Daniel Bevenius
a8137dd06d tools: add macosx-firwall script to avoid popups
Currently, there are a number of popups that get displayed when running
the tests asking to accept incoming network connections. Rules can be
added manually to the socket firewall on Mac OS X but getting this right
might not be obvious and quite a lot of time can be wasted trying to get
the rules right. This script hopes to simplify things a little so that
it can be re-run when needed.

The script should be runnable from both the projects root directory and
from the tools directory, for example:
$ sudo ./tools/macosx-firewall.sh

Fixes: https://github.com/nodejs/node/issues/8911
PR-URL: https://github.com/nodejs/node/pull/10114
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2016-12-09 08:31:08 +01:00
Sam Roberts
3cbb553df8 tools: disallow trailing whitespace for markdown
markdown had a dispensation because 2 or more trailing spaces triggers a
new paragraph. There are no examples of that usage in Node, all trailing
whitespace found were mistakes, and the dispensation is now removed.

See: https://github.com/nodejs/node/pull/9620
PR-URL: https://github.com/nodejs/node/pull/9676
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2016-11-21 09:04:29 -08:00
monkick
55cb280265
doc: fix typo in BUILDING.md
e.g., to e.g. at BUILDING.md line 116

PR-URL: https://github.com/nodejs/node/pull/9569
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-11-20 01:11:28 +01:00
kobelb
facd843fc5
doc: update OpenSSL links
PR-URL: https://github.com/nodejs/node/pull/9338
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
2016-11-01 19:42:56 +01:00
Christopher Fujino
7f7502d901 doc: remove failing workaround in BUILDING.md
Updated BUILDING.md, removing workaround for Python conflicts that
didn't work.

PR-URL: https://github.com/nodejs/node/pull/8763
Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Refs: https://github.com/nodejs/node/pull/8763
2016-09-28 10:27:54 -07:00
Сковорода Никита Андреевич
fcf7696bc1 doc: enable first-heading-level remark-lint rule
This makes sure that the first heading in all markdown files is h1.

Only three files needed to be changed to conform:
 1. BUILDING.md
 2. CODE_OF_CONDUCT.md
 3. doc/onboarding-extras.md

Also, .remarkrc is updated to include the `first-heading-level: 1`
rule in order to catch similar issues in the future.

PR-URL: https://github.com/nodejs/node/pull/8716
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2016-09-27 06:31:12 -07:00
rainabba
92c1d9622b doc: update BUILDING.md
Added note about vcbuild being included as batch to clarify
that it's not needed from msbuild tools or visual studio.

PR-URL: https://github.com/nodejs/node/pull/8704
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2016-09-24 02:07:56 +03:00
Rich Trott
30dbc9d961 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: https://github.com/nodejs/node/pull/8398
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-09-06 14:59:01 -07:00
Ben Noordhuis
b9487449e1 doc: update windows prerequisites
Visual Studio 2013 is no longer supported.  Update the Windows build
prerequisites.

Refs: https://github.com/nodejs/node/issues/7484
PR-URL: https://github.com/nodejs/node/pull/8049
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: João Reis <reis@janeasystems.com>
2016-08-12 10:49:01 -07:00
Сковорода Никита Андреевич
4aa8120aea doc: *.md formatting fixes in the top-level dir
Continuing what a58b48bc3b did for the
doc/ dir, this fixes some formatting issues in the *.md files that
are placed directly in the top-level directory.

README.md changes are excluded as they are covered by
https://github.com/nodejs/node/pull/7971

Refs: https://github.com/nodejs/node/pull/7637
PR-URL: https://github.com/nodejs/node/pull/7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-08-04 11:11:37 +03:00
João Reis
0a8f5a0f02 doc: update build instructions for Windows
The Visual C++ Build Tools are supported to build Node on Windows
and already used in CI, so they should be included in the build
instructions.

Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/7285
2016-06-23 14:00:00 +01:00
Jesse McCarthy
101dd1ed78 build: add Make doc-only target
Allows building just docs using existing Node instead of building Node
first.

PR-URL: https://github.com/nodejs/node/pull/3888
Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2016-05-10 10:38:28 -07:00
Myles Borins
10a60a17e5 doc: add steps for running addons + npm tests
Currently we do not document how to run the test suite for native
modules or for npm. This commit updates BUILDING.md with the
information needed to do so. It includes a caveat about Node v4
and earlier requiring `make install` to be run before running the npm
test suite.

PR-URL: https://github.com/nodejs/node/pull/6231
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2016-05-09 14:10:30 -07:00
Steven R. Loomis
03a8637f79
tools: Check in tools for shrinking ICU size, change default to small-icu
* Change configure default to "small-icu" (Intl on, English only)
* add "--without-intl" and "vcbuild without-intl" options, equivalent
to --with-intl=none
* update BUILDING.md with above changes
* Checks in tools that generate the deps/icu-small source directory
from ICU source
* Tools and process for updating ICU documented in tools/icu/README.md

Fixes: https://github.com/nodejs/node/issues/3476
PR-URL: https://github.com/nodejs/node/pull/6088
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-05-04 16:04:22 -07:00
Rich Trott
153b796d68 doc: update build instructions for OS X
Building Node.js on OS X requires XCode (because node-gyp requires
XCode). Add that information to BUILDING.md.

Additionally, this changes references to `Macintosh` in BUILDING.md to
refer to `OS X`. This is consistent with the way other references are to
operating system families (`Unix`, `Windows`) and not brand names or
hardware architectures.

PR-URL: https://github.com/nodejs/node/pull/6309
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
2016-04-28 10:09:59 -07:00
Rich Trott
0f3c3b4bdb doc: note about Android support
PR-URL: https://github.com/nodejs/node/pull/6040
Refs: https://github.com/nodejs/node/issues/6035
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
2016-04-06 10:57:24 -07:00
Johan Bergström
5d214961b2 doc: move build instructions to a new document
This makes README.md easier to consume and likely less
confusing for people that get it as part of a binary download.

PR-URL: https://github.com/nodejs/node/pull/5634
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-03-14 09:22:19 +11:00