Commit Graph

271 Commits

Author SHA1 Message Date
Dima Demakov
62fc950e96
doc: make theme consistent across api and other docs
Since website based on 2 different repos, there was an inconsistency
in theme selection, so we had 2 independant theme props.
Now only one stored in local storage is a single source of truth

PR-URL: https://github.com/nodejs/node/pull/50877
Reviewed-By: Claudio Wunder <cwunder@gnome.org>
Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io>
2023-11-27 09:03:27 +00:00
Luigi Pinca
a037b88561
doc: recommend supported Python versions
Refs: https://github.com/nodejs/node/pull/50209#issuecomment-1781016950
PR-URL: https://github.com/nodejs/node/pull/50407
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2023-11-01 13:41:03 +00:00
Shi Pujin
7dc74a0451
doc: add loong64 info into platform list
PR-URL: https://github.com/nodejs/node/pull/50086
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2023-10-22 10:07:13 +00:00
Chengzhong Wu
8609915951
doc: improve ccache explanation
ccache improves the build speed significantly only when the branch was
built before. Building fresh branches with major changes are not
benefited from ccache.

PR-URL: https://github.com/nodejs/node/pull/50133
Fixes: https://github.com/nodejs/node/issues/49967
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2023-10-15 10:55:36 +00:00
Michaël Zasso
ac2a68c76b
build: drop support for Visual Studio 2019
V8 and Chromium are starting to use C++20 features.
Only Visual Studio 2022 17.6 includes a version of MSVC
with sufficient C++20 support to compile V8.

Refs: https://bugs.chromium.org/p/chromium/issues/detail?id=1284275
Refs: https://github.com/nodejs/node/pull/45427
PR-URL: https://github.com/nodejs/node/pull/49051
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2023-10-09 16:25:32 +00:00
Claudio W
47b2883673
doc: updated building docs for windows
PR-URL: https://github.com/nodejs/node/pull/49767
Reviewed-By: Jacob Smith <jacob@frende.me>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
2023-10-01 14:22:58 +00:00
Michaël Zasso
4e3983031a build: bump supported macOS and Xcode versions
- Bump macOS deployment target to 11.0
- Bump Xcode to 13

This is to ensure some level of support for C++20 features.
macOS 10.15 is no longer supported by Apple since September 2022.
Xcode 13 is the most recent version that can run on macOS 11, which
is the version we currently use to build releases.

Refs: https://developer.apple.com/xcode/cpp/#c++20

PR-URL: https://github.com/nodejs/node/pull/49164
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
2023-09-12 15:14:13 -04:00
Richard Lau
8aa02e81d0
doc: update documentation for FIPS support
When using OpenSSL 3, Node.js supports FIPS 140-2 when used with an
appropriate OpenSSL 3 provider. It is no longer necessary to rebuild
Node.js with different build time options.

Add a section on how to configure Node.js to use an OpenSSL 3 FIPS
provider to the documentation for the `crypto` module.

PR-URL: https://github.com/nodejs/node/pull/48194
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2023-05-30 11:40:25 +00:00
Antoine du Hamel
260092eca3
doc: harmonize fenced code snippet flags
We had a few code snippets that were using a non-descriptive tag (e.g.
`console` or `text`), whereas the actual language it's using describes
it better, and improves the syntax highlighting. This commit also
removes non-necessary leading chars (e.g. `$`, `>`, or `%`) to make it
easier for readers to copy and paste to try the command themselves.

PR-URL: https://github.com/nodejs/node/pull/48082
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2023-05-21 09:36:57 +02:00
Michaël Zasso
41b1e54db2
doc: update supported version of FreeBSD to 12.4
Refs: https://github.com/nodejs/build/issues/3134
PR-URL: https://github.com/nodejs/node/pull/47838
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2023-05-06 19:41:49 +00:00
Tobias Nießen
f68ff9fe88
doc: update BUILDING.md previous versions links
Remove EOL release lines and add missing supported release
lines.

PR-URL: https://github.com/nodejs/node/pull/47835
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
2023-05-03 11:33:23 +00:00
Mohammed Keyvanzadeh
dbf71e509c
doc: fix capitalization of ASan
PR-URL: https://github.com/nodejs/node/pull/47676
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
2023-04-23 08:21:51 +00:00
Michaël Zasso
503d838b1e
doc: update darwin-x64 toolchain used for Node.js 20 releases
Refs: https://github.com/nodejs/node/issues/47067
PR-URL: https://github.com/nodejs/node/pull/47546
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2023-04-14 12:40:45 +00:00
Richard Lau
6473f5e7f7
doc: update toolchains used for Node.js 20 releases
Update the table describing the platform and toolchain used to build
the official Node.js 20 binaries.

PR-URL: https://github.com/nodejs/node/pull/47352
Refs: https://github.com/orgs/nodejs/discussions/45892
Refs: https://github.com/nodejs/node/issues/47067
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
2023-04-03 14:48:11 +00:00
Stefan Stojanovic
dad0b072c5
doc: make win arm64 tier 2 platform
Refs: https://github.com/nodejs/build/issues/3046
Refs: https://github.com/nodejs/build/issues/2540
Fixes: https://github.com/nodejs/node/issues/25998
PR-URL: https://github.com/nodejs/node/pull/47233
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2023-03-30 15:16:12 +00:00
Stefan Stojanovic
0b66df61ef
msi: migrate to WiX4
To be able to build x86, x64, and ARM64 MSI installers with the same WiX
version, migration to WiX4 is required.

PR-URL: https://github.com/nodejs/node/pull/45943
Refs: https://github.com/nodejs/build/issues/2540
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
2023-03-22 22:16:57 +00:00
Richard Lau
c1bcdbcf79
build: warn for gcc versions earlier than 10.1
Update the warning threshold for gcc to 10.1 starting from Node.js 20.
Builds can still proceed with earlier versions of gcc, but are not
guaranteed to work.

PR-URL: https://github.com/nodejs/node/pull/46806
Refs: https://github.com/nodejs/node/discussions/45892
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Stewart X Addison <sxa@redhat.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2023-02-25 18:38:43 +00:00
Tony Gorez
2dacd0708a
doc: enrich test command with executable
PR-URL: https://github.com/nodejs/node/pull/44347
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
2023-02-06 07:50:07 +00:00
Luigi Pinca
cf748ad2b7 build: support Python 3.11
PR-URL: https://github.com/nodejs/node/pull/45191
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
2022-10-28 18:35:49 +00:00
Michael Dawson
ca5be26b31 src: add support for externally shared js builtins
Refs: https://github.com/nodejs/node/issues/44000

- add infra to support externally shared js builtins in
  support of distos that want to externalize deps that
  include JS/WASM instead of native code
- add support for externalizing
  - cjs_module_lexer/lexer
  - cjs_module_lexer/dist/lexer
  - undici/undici

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: https://github.com/nodejs/node/pull/44376
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
2022-10-11 09:44:48 -04:00
BuShe Pie
1124558b65
doc: improve building doc for Android
PR-URL: https://github.com/nodejs/node/pull/44888
Refs: https://github.com/nodejs/node/pull/44207
Reviewed-By: Feng Yu <F3n67u@outlook.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2022-10-10 23:27:07 +00:00
Brian Muenzenmeyer
ccd4c31360 doc: improve building doc for Windows Powershell
PR-URL: https://github.com/nodejs/node/pull/44625
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2022-09-16 20:40:37 -07:00
BuShe
8689c6a6d7
doc: improved building doc for Android
PR-URL: https://github.com/nodejs/node/pull/44166
Reviewed-By: Feng Yu <F3n67u@outlook.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
2022-08-12 10:29:23 +00:00
Feng Yu
08d6a82f62
doc: fix Visual Studio 2019 download link
PR-URL: https://github.com/nodejs/node/pull/43236
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2022-06-21 08:02:56 +01:00
Feng Yu
8f39f51cbb
doc: fix 404 link of BUILDING.md
PR-URL: https://github.com/nodejs/node/pull/43234
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2022-06-02 17:34:01 +01:00
Daniel Bevenius
f5a5df4802 src,deps,build,test: add OpenSSL config appname
This commit adds the setting of an appname (configuration section
name), 'nodejs_conf', to be used when reading OpenSSL configuration
files.

The motivation for this is that currently the default OpenSSL
configuration, 'openssl_conf', element will be used which may be
undesirable as it might configure OpenSSL in unwanted ways. With this
commit it is still possible to use a default openssl.cnf file but the
only section that Node.js will read from is a section named
'nodejs_conf'.

PR-URL: https://github.com/nodejs/node/pull/43124
Refs: https://github.com/nodejs/node/issues/40366
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
2022-05-31 13:41:30 +02:00
Livia Medeiros
38a39143d2
doc: make minor adjustments
PR-URL: https://github.com/nodejs/node/pull/43175
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>
2022-05-24 10:27:17 +01:00
LiviaMedeiros
b7cd49fdd5 doc: reword "test directory"
PR-URL: https://github.com/nodejs/node/pull/42817
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2022-04-28 18:58:48 +00:00
LiviaMedeiros
85a77b0cbf doc: remove legacy -J test.py option from BUILDING.md
PR-URL: https://github.com/nodejs/node/pull/42817
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2022-04-28 18:58:47 +00:00
Michaël Zasso
fe85cf70a2
Revert "build: make x86 Windows support temporarily experimental"
This reverts commit 35d72bf4ec.

PR-URL: https://github.com/nodejs/node/pull/42740
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
2022-04-21 11:56:01 +02:00
Richard Lau
3671cc0432
doc: update minimum glibc requirements for Linux
Starting with Node.js 18 we have moved building the release binaries
from being built on CentOS 7/RHEL 7 to being built on RHEL 8 as the
End-of-Life date of CentOS 7/RHEL 7 is before the End-of-Life date
of Node.js 18 and we do not want to have to make a disruptive change
towards the end of Node.js 18's life cycle.

Moving to RHEL 8 has raised the glibc version being linked against
(2.28). The official Node.js Linux release binaries will only run on
Linux distributions with a matching or higher version of glibc.

PR-URL: https://github.com/nodejs/node/pull/42659
Refs: https://github.com/nodejs/build/issues/2815
Refs: https://github.com/nodejs/build/issues/2741
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Stewart X Addison <sxa@redhat.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2022-04-13 07:36:08 +01:00
Michaël Zasso
35d72bf4ec
build: make x86 Windows support temporarily experimental
We currently have no solution to build Node.js for x86 Windows with
V8 10.1. V8 10.2 seems fixed, but that version won't stable enough by
the time we release Node.js 18.0.0 (it only has canary coverage).
The goal is to revert this commit as soon as the issue is fixed.

PR-URL: https://github.com/nodejs/node/pull/42666
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
2022-04-12 10:10:13 +01:00
Richard Lau
646e057680
doc: update AIX minimum supported arch
Raise the minimum supported arch for AIX to Power 8 in line with the
existing minimum supported Power arch for Linux. We do not have anything
earlier than Power 8 in our CI so are unable to test on it, and have
reached out to IBM who have no concerns over baselining on Power 8 for
Node.js 18.

PR-URL: https://github.com/nodejs/node/pull/42604
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2022-04-07 11:43:12 +01:00
Richard Lau
1134d8faf8
build: bump macOS deployment target to 10.15
Update the macOS deployment target for Node.js 18 onwards.

PR-URL: https://github.com/nodejs/node/pull/42292
Refs: https://github.com/nodejs/build/issues/2815
Refs: https://github.com/libuv/libuv/pull/3406
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Ash Cripps <acripps@redhat.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2022-03-18 16:53:27 +00:00
Michaël Zasso
27eb91d378 build: downgrade Windows 8.1 and server 2012 R2 to experimental
Both versions will be end of life in 2023, before the end of Node.js 18.

Refs: https://docs.microsoft.com/en-us/lifecycle/products/windows-81
Refs: https://docs.microsoft.com/en-us/lifecycle/products/windows-server-2012-r2

PR-URL: https://github.com/nodejs/node/pull/42105
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2022-03-07 17:47:31 -05:00
Balakrishna Avulapati
d5e94fa712
doc: make building with ninja more discoverable
Building with ninja would speed up the build
We have the documenation about building with ninja,
but not easily discoverable.
And present this early to the contributors.

PR-URL: https://github.com/nodejs/node/pull/41840
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2022-02-25 03:20:41 +00:00
Antoine du Hamel
a96549af4f
doc: add 16 and 17 to previous versions
PR-URL: https://github.com/nodejs/node/pull/41646
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2022-01-22 19:09:01 +00:00
Christian Clauss
91c9ccc06b doc: document support building with Python 3.10 on Windows
PR-URL: https://github.com/nodejs/node/pull/41098
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
2021-12-10 11:21:37 +01:00
Piotr Rybak
c4aed2fc83 doc: add note about pip being required
Clean install requires pip to make coverage but instructions didn't
mention it.

PR-URL: https://github.com/nodejs/node/pull/40669
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-12-10 10:55:07 +01:00
Rich Trott
506816891b doc: remove legacy -J test.py option from BUILDING.md
PR-URL: https://github.com/nodejs/node/pull/40945
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
2021-11-27 05:45:02 +00:00
Rich Trott
a5d3449f20
doc: update BUILDING.md section on running tests
Refs: https://github.com/nodejs/node/issues/40920

PR-URL: https://github.com/nodejs/node/pull/40933
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-11-25 21:13:17 +00:00
Rich Trott
86099a375a tools: avoid unnecessary escaping in markdown formatter
Update mdast-util-to-markdown to 1.2.4 which reduces unnecessary
escaping of `_` and some other characters. Re-run markdown formatter.

PR-URL: https://github.com/nodejs/node/pull/40645
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2021-10-31 09:36:05 -07:00
Rich Trott
31d7d6c994 doc: simplify ccache instructions
`ccache` has reasonable defaults for `max_size` and `cache_dir` so
remove instructions to set those things explicitly.

Change fenced code from `console` to `bash` for easier copy/paste.

PR-URL: https://github.com/nodejs/node/pull/40550
Fixes: https://github.com/nodejs/node/issues/40542
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-10-24 06:59:22 -07:00
Rich Trott
edd716beb1 doc: fix macOS environment variables for ccache
macOS requires `cc` and `c++` rather than `gcc` and `g++`.

Closes: https://github.com/nodejs/node/issues/40542

PR-URL: https://github.com/nodejs/node/pull/40550
Fixes: https://github.com/nodejs/node/issues/40542
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-10-24 06:59:20 -07:00
Rich Trott
3577f6dc48 doc: use GFM footnotes in BUILDING.md
PR-URL: https://github.com/nodejs/node/pull/40474
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-10-22 20:19:54 -07:00
Daniel Bevenius
66da32c045 deps,test,src,doc,tools: update to OpenSSL 3.0
This pull request updates the OpenSSL version that is statically
linked with Node.js from OpenSSl 1.1.1 to quictls OpenSSL 3.0.0+quic.

This pull request will replace the OpenSSL version that is currently
in the deps directory and when performing a normal build
OpenSSL 3.0+quic will be statically linked to the Node.js executable.
We will still be able to dynamically link to OpenSSL 1.1.1 and we have
a CI job which dynamically links to OpenSSL 1.1.1 which is run for
every pull request to make sure that we maintain backward compatibility.

PR-URL: https://github.com/nodejs/node/pull/38512
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-10-11 06:28:08 +02:00
Rich Trott
88e82b890b doc: format general markdown files
Use `make format-md` to format general markdown files.

PR-URL: https://github.com/nodejs/node/pull/40322
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-10-06 21:20:55 -07:00
FrankQiu
7752088ef6 build: support Python 3.10.0
PR-URL: https://github.com/nodejs/node/pull/40296
Fixes: https://github.com/nodejs/node/issues/40294
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2021-10-06 17:07:07 -07:00
Michaël Zasso
ae876d420c
doc: update minimum supported FreeBSD to 12.2
FreeBSD 11 goes out of support on 2021-09-30.
FreeBSD 12.1 is not supported since 2021-01-31.

PR-URL: https://github.com/nodejs/node/pull/40179
Refs: https://en.wikipedia.org/wiki/FreeBSD_version_history#Version_history
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-09-25 08:14:55 -07:00
Rich Trott
549f96889a doc: update markdown formatting for *.md files
Fix formatting that will change when run through upcoming remark preset.

PR-URL: https://github.com/nodejs/node/pull/40154
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2021-09-21 15:37:19 +00:00
Ash Cripps
4d60ee8d1c doc: update min mac ver + move mac arm64 to tier 1
Update the minimum macos version that can compile to match the
xcode requirements.

Also move mac arm64 to tier 1.

refs: https://github.com/nodejs/node/issues/39584#issuecomment-889701855

PR-URL: https://github.com/nodejs/node/pull/39586
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2021-08-01 12:59:28 +00:00
Benjamin Mayr
71b2df253d doc: improve node.js+fips instructions
Improves the documentation for building Node.js with openssl-3.0.0+quic
with enabled FIPS support. Adds missing but necesary steps to the
documentation and makes it complete.

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/39390
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
2021-07-22 06:49:29 +02:00
Rich Trott
7dbc0f74d0 doc: standardize on _pull request_
Sometimes we capitalize _pull request_ and sometimes we don't.
Standardize on lowercase based on Microsoft Style Guide, Chicago Manual
of Style, and GitHub's own docs and UI.

Refs: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
Refs: https://docs.github.com/en/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request
Refs: https://docs.microsoft.com/en-us/style-guide/capitalization

PR-URL: https://github.com/nodejs/node/pull/39384
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
2021-07-16 10:36:30 -07:00
bl-ue
864195bac9 doc: clarify that only one Python version is required to build
PR-URL: https://github.com/nodejs/node/pull/38894
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
2021-06-11 14:17:48 +08:00
Daniel Bevenius
0d7644fdda build,src,test,doc: enable FIPS for OpenSSL 3.0
This commit enables FIPS when Node.js is dynamically linking against
quictls/openssl-3.0.

BUILDING.md has been updated with instructions to configure and build
quictls/openssl 3.0.0-alpha-15 and includes a couple of work-arounds
which I believe are fixed in alpha-16 and can be removed when alpha-16
is available. The information might be a little too detailed/verbose
but I thought it would be helpful to at least initially include all the
steps.

PR-URL: https://github.com/nodejs/node/pull/38633
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2021-05-14 16:15:19 -04:00
Richard Lau
16982b6c4d
build: remove dependency on distutils.spawn
Debian based packages of Python 3 do not include `distutils.spawn` and
require an additional apt package to be installed (`python3-distutils`).
Replace use of `distutils.spawn` with `shutil.which`, available in all
versions of Python currently allowed by our configure scripts.

For the `configure` script only, fall back to `distutils.spawn` to allow
friendlier error messages when run on older unsupported versions of
Python (e.g. 2.7).

`configure.py` also uses `distutils.version` -- this appears to be
available in Debian packaged Python 3 without installing
`python3-distutils` so has been left as-is.

PR-URL: https://github.com/nodejs/node/pull/38600
Refs: https://github.com/nodejs/node/issues/30189
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-05-10 10:34:12 -04:00
Antoine du Hamel
26e318a321
doc: use HEAD instead of master for links
PR-URL: https://github.com/nodejs/node/pull/38518
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-05-05 10:45:30 +02:00
MrJithil
9df904b222
doc: corrected workload name as per the latest VS Installer
PR-URL: https://github.com/nodejs/node/pull/38500
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-05-04 13:14:08 -07:00
Richard Lau
767643fc19
doc: restore minimum Xcode version for macOS
https://github.com/nodejs/node/pull/36691 accidentally reverted the
change to the minimum version of Xcode for macOS.

PR-URL: https://github.com/nodejs/node/pull/38266
Refs: 4268fae04a (r49622017)
Refs: https://github.com/nodejs/node/pull/37872
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-04-18 18:53:56 -04:00
Christian Clauss
4268fae04a
build: remove support for Python 2
PR-URL: https://github.com/nodejs/node/pull/36691
Fixes: https://github.com/nodejs/node/issues/25789
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2021-04-16 15:47:02 -04:00
Ash Cripps
98c2067f13 doc: update BUILDING.md for Apple Silicon
PR-URL: https://github.com/nodejs/node/pull/38227
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2021-04-14 16:42:36 +01:00
Michaël Zasso
290c158018 doc: update minimum supported Xcode to 11
The last version of Xcode 10 was released in 2019.

Refs: https://github.com/nodejs/build/issues/2445

PR-URL: https://github.com/nodejs/node/pull/37872
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Ash Cripps <acripps@redhat.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2021-03-26 01:23:21 +00:00
Michaël Zasso
1ff2918d80 doc: update minimum supported GCC to 8.3
Refs: https://github.com/nodejs/build/issues/2445

PR-URL: https://github.com/nodejs/node/pull/37871
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Ash Cripps <acripps@redhat.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2021-03-26 01:22:19 +00:00
Ash Cripps
2706e67116 doc: update AIX to GCC8 for v16.x
PR-URL: https://github.com/nodejs/node/pull/37677
Refs: https://github.com/nodejs/build/issues/2445
Reviewed-By: Stewart X Addison <sxa@redhat.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2021-03-15 16:27:52 +00:00
Michael Dawson
7a4c2c8d86 doc: change links to use HEAD in top level docs
Change the top level docs to use HEAD in links

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: https://github.com/nodejs/node/pull/37494
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-02-27 12:03:22 -08:00
Rich Trott
e0ac501b92 doc: use sentence case for headers in BUILDING.md
Be consistent with the rest of the file and our doc style guide.

PR-URL: https://github.com/nodejs/node/pull/37250
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Pooja D P <Pooja.D.P@ibm.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
2021-02-08 09:54:47 -08:00
Richard Lau
b9dfda9b46 doc: update BUILDING.md previous versions links
Remove links to End-of-Life versions of the BUILDING.md document.
Add a link to the version for Node.js 14.x.

PR-URL: https://github.com/nodejs/node/pull/37082
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2021-01-28 18:48:34 +01:00
Momtchil Momtchev
36581f1d4e doc: add two tips for speeding the dev builds
Add two important tips for novice Node.js contributors

PR-URL: https://github.com/nodejs/node/pull/36452
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2020-12-18 11:46:06 -08:00
Richard Lau
62a56264f6 doc: add arm64 macOS as experimental
PR-URL: https://github.com/nodejs/node/pull/36189
Refs: https://github.com/nodejs/build/issues/2474
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Ash Cripps <acripps@redhat.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2020-11-22 04:59:27 -08:00
Nick Schonning
dbdd234e4b doc: adjust table alignment for remark v13
Addresses table-cell-padding rule issues

PR-URL: https://github.com/nodejs/node/pull/35647
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-11-02 16:56:31 -08:00
raisinten
ed5e5395c7 doc: fix typo in BUILDING.md
PR-URL: https://github.com/nodejs/node/pull/35807
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2020-10-27 01:13:20 +00:00
bcoe
ba907ff750
test: refactor coverage logic
Cleanup logic in Makefile for coverage. Update BUILDING.md
accordingly.

PR-URL: https://github.com/nodejs/node/pull/35767
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2020-10-25 07:22:57 -07:00
Pooja D.P
1ba932b183 doc: add Installing Node.js header in BUILDING.md
PR-URL: https://github.com/nodejs/node/pull/35710
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-10-22 05:29:31 -07:00
Derek Lewis
ff0aad0f74
doc: spruce up user journey to local docs browsing
This patch improves the means by which the docs are viewed locally.

* Remove extraneous code in the `docserve` Makefile target
* Document the `docserve` task for all to know
* Bring all code snippets in this section up to speed
* Clarify the purpose of each documentation browsing method

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

PR-URL: https://github.com/nodejs/node/pull/34986
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2020-09-06 16:25:49 -04:00
AshCripps
8bf37ee496 doc: update support macos version for 15.x
with our minimum target already set to 10.13 for 14.x
it doesn't make sense to claim to support anything lower.

PR-URL: https://github.com/nodejs/node/pull/35022
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
2020-09-04 16:19:07 +00:00
Rich Trott
9fd71a9964 doc: fix bulleted list punctuation in BUILDING.md
Remove/add periods as appropriate in bulleted lists in BUILDING.md.

PR-URL: https://github.com/nodejs/node/pull/34849
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ricky Zhou <0x19951125@gmail.com>
2020-08-20 10:29:22 -07:00
Dennis Ameling
03293aa3a1 build,win: use x64 Node when building for ARM64
Uses x64 node executable for running .js files in arm64
cross-compilation scenarios. MSI can now be created by
running `vcbuild.bat release msi arm64`

Refs: https://github.com/nodejs/node/issues/25998
Refs: https://github.com/nodejs/node/issues/32582
PR-URL: https://github.com/nodejs/node/pull/34009
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: João Reis <reis@janeasystems.com>
2020-08-20 00:41:54 +01:00
João Reis
c2771dc07c build: move compiling for Windows ARM64 to Tier 2
PR-URL: https://github.com/nodejs/node/pull/34721
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Ash Cripps <ashley.cripps@ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-08-14 15:33:52 -07:00
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