0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 15:06:33 +01:00
Commit Graph

128 Commits

Author SHA1 Message Date
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