mirror of
https://github.com/nodejs/node.git
synced 2024-11-21 10:59:27 +00:00
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>
This commit is contained in:
Rich Trott
parent
055311ae18
commit
88e82b890b
44
BUILDING.md
44
BUILDING.md
@ -99,29 +99,29 @@ Node.js does not support a platform version if a vendor has expired support
|
||||
for it. In other words, Node.js does not support running on End-of-Life (EoL)
|
||||
platforms. This is true regardless of entries in the table below.
|
||||
|
||||
| Operating System | Architectures | Versions | Support Type | Notes |
|
||||
| ---------------- | ---------------- | ------------------------------- | ------------ | --------------------------------- |
|
||||
| GNU/Linux | x64 | kernel >= 3.10, glibc >= 2.17 | Tier 1 | e.g. Ubuntu 16.04 <sup>[1](#fn1)</sup>, Debian 9, EL 7 <sup>[2](#fn2)</sup> |
|
||||
| GNU/Linux | x64 | kernel >= 3.10, musl >= 1.1.19 | Experimental | e.g. Alpine 3.8 |
|
||||
| GNU/Linux | x86 | kernel >= 3.10, glibc >= 2.17 | Experimental | Downgraded as of Node.js 10 |
|
||||
| GNU/Linux | arm64 | kernel >= 4.5, glibc >= 2.17 | Tier 1 | e.g. Ubuntu 16.04, Debian 9, EL 7 <sup>[3](#fn3)</sup> |
|
||||
| GNU/Linux | armv7 | kernel >= 4.14, glibc >= 2.24 | Tier 1 | e.g. Ubuntu 18.04, Debian 9 |
|
||||
| GNU/Linux | armv6 | kernel >= 4.14, glibc >= 2.24 | Experimental | Downgraded as of Node.js 12 |
|
||||
| GNU/Linux | ppc64le >=power8 | kernel >= 3.10.0, glibc >= 2.17 | Tier 2 | e.g. Ubuntu 16.04 <sup>[1](#fn1)</sup>, EL 7 <sup>[2](#fn2)</sup> |
|
||||
| GNU/Linux | s390x | kernel >= 3.10.0, glibc >= 2.17 | Tier 2 | e.g. EL 7 <sup>[2](#fn2)</sup> |
|
||||
| Windows | x64, x86 (WoW64) | >= Windows 8.1/2012 R2 | Tier 1 | <sup>[4](#fn4),[5](#fn5)</sup> |
|
||||
| Windows | x86 (native) | >= Windows 8.1/2012 R2 | Tier 1 (running) / Experimental (compiling) <sup>[6](#fn6)</sup> | |
|
||||
| Windows | x64, x86 | Windows Server 2012 (not R2) | Experimental | |
|
||||
| Windows | arm64 | >= Windows 10 | Tier 2 (compiling) / Experimental (running) | |
|
||||
| macOS | x64 | >= 10.13 | Tier 1 | For notes about compilation see <sup>[7](#fn7)</sup> |
|
||||
| macOS | arm64 | >= 11 | Tier 1 | |
|
||||
| SmartOS | x64 | >= 18 | Tier 2 | |
|
||||
| AIX | ppc64be >=power7 | >= 7.2 TL04 | Tier 2 | |
|
||||
| FreeBSD | x64 | >= 12.2 | Experimental | |
|
||||
| Operating System | Architectures | Versions | Support Type | Notes |
|
||||
| ---------------- | ---------------- | ------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
||||
| GNU/Linux | x64 | kernel >= 3.10, glibc >= 2.17 | Tier 1 | e.g. Ubuntu 16.04 <sup>[1](#fn1)</sup>, Debian 9, EL 7 <sup>[2](#fn2)</sup> |
|
||||
| GNU/Linux | x64 | kernel >= 3.10, musl >= 1.1.19 | Experimental | e.g. Alpine 3.8 |
|
||||
| GNU/Linux | x86 | kernel >= 3.10, glibc >= 2.17 | Experimental | Downgraded as of Node.js 10 |
|
||||
| GNU/Linux | arm64 | kernel >= 4.5, glibc >= 2.17 | Tier 1 | e.g. Ubuntu 16.04, Debian 9, EL 7 <sup>[3](#fn3)</sup> |
|
||||
| GNU/Linux | armv7 | kernel >= 4.14, glibc >= 2.24 | Tier 1 | e.g. Ubuntu 18.04, Debian 9 |
|
||||
| GNU/Linux | armv6 | kernel >= 4.14, glibc >= 2.24 | Experimental | Downgraded as of Node.js 12 |
|
||||
| GNU/Linux | ppc64le >=power8 | kernel >= 3.10.0, glibc >= 2.17 | Tier 2 | e.g. Ubuntu 16.04 <sup>[1](#fn1)</sup>, EL 7 <sup>[2](#fn2)</sup> |
|
||||
| GNU/Linux | s390x | kernel >= 3.10.0, glibc >= 2.17 | Tier 2 | e.g. EL 7 <sup>[2](#fn2)</sup> |
|
||||
| Windows | x64, x86 (WoW64) | >= Windows 8.1/2012 R2 | Tier 1 | <sup>[4](#fn4),[5](#fn5)</sup> |
|
||||
| Windows | x86 (native) | >= Windows 8.1/2012 R2 | Tier 1 (running) / Experimental (compiling) <sup>[6](#fn6)</sup> | |
|
||||
| Windows | x64, x86 | Windows Server 2012 (not R2) | Experimental | |
|
||||
| Windows | arm64 | >= Windows 10 | Tier 2 (compiling) / Experimental (running) | |
|
||||
| macOS | x64 | >= 10.13 | Tier 1 | For notes about compilation see <sup>[7](#fn7)</sup> |
|
||||
| macOS | arm64 | >= 11 | Tier 1 | |
|
||||
| SmartOS | x64 | >= 18 | Tier 2 | |
|
||||
| AIX | ppc64be >=power7 | >= 7.2 TL04 | Tier 2 | |
|
||||
| FreeBSD | x64 | >= 12.2 | Experimental | |
|
||||
|
||||
<em id="fn1">1</em>: GCC 8 is not provided on the base platform. Users will
|
||||
need the
|
||||
[Toolchain test builds PPA](https://launchpad.net/~ubuntu-toolchain-r/+archive/ubuntu/test?field.series_filter=xenial)
|
||||
[Toolchain test builds PPA](https://launchpad.net/\~ubuntu-toolchain-r/+archive/ubuntu/test?field.series\_filter=xenial)
|
||||
or similar to source a newer compiler.
|
||||
|
||||
<em id="fn2">2</em>: GCC 8 is not provided on the base platform. Users will
|
||||
@ -170,7 +170,7 @@ Depending on the host platform, the selection of toolchains may vary.
|
||||
Binaries at <https://nodejs.org/download/release/> are produced on:
|
||||
|
||||
| Binary package | Platform and Toolchain |
|
||||
| --------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| ----------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| aix-ppc64 | AIX 7.2 TL04 on PPC64BE with GCC 8 |
|
||||
| darwin-x64 | macOS 10.15, Xcode Command Line Tools 11 with -mmacosx-version-min=10.13 |
|
||||
| darwin-arm64 (and .pkg) | macOS 11 (arm64), Xcode Command Line Tools 12 with -mmacosx-version-min=10.13 |
|
||||
@ -272,7 +272,7 @@ $ make -j4
|
||||
|
||||
The `-j4` option will cause `make` to run 4 simultaneous compilation jobs which
|
||||
may reduce build time. For more information, see the
|
||||
[GNU Make Documentation](https://www.gnu.org/software/make/manual/html_node/Parallel.html).
|
||||
[GNU Make Documentation](https://www.gnu.org/software/make/manual/html\_node/Parallel.html).
|
||||
|
||||
The above requires that `python` resolves to a supported version of
|
||||
Python. See [Prerequisites](#prerequisites).
|
||||
|
||||
660
CHANGELOG.md
660
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
@ -1,4 +1,4 @@
|
||||
# Code of Conduct
|
||||
|
||||
* [Node.js Code of Conduct](https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md)
|
||||
* [Node.js Code of Conduct](https://github.com/nodejs/admin/blob/HEAD/CODE\_OF\_CONDUCT.md)
|
||||
* [Node.js Moderation Policy](https://github.com/nodejs/admin/blob/HEAD/Moderation-Policy.md)
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
## [Code of Conduct](./doc/guides/contributing/code-of-conduct.md)
|
||||
|
||||
The Node.js project has a
|
||||
[Code of Conduct](https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md)
|
||||
[Code of Conduct](https://github.com/nodejs/admin/blob/HEAD/CODE\_OF\_CONDUCT.md)
|
||||
to which all contributors must adhere.
|
||||
|
||||
See [details on our policy on Code of Conduct](./doc/guides/contributing/code-of-conduct.md).
|
||||
|
||||
@ -26,7 +26,7 @@ maintainers and should also be coordinated through the Node.js Ecosystem
|
||||
Security Team via [HackerOne](https://hackerone.com/nodejs-ecosystem).
|
||||
|
||||
Details regarding this process can be found in the
|
||||
[Security Working Group repository](https://github.com/nodejs/security-wg/blob/HEAD/processes/third_party_vuln_process.md).
|
||||
[Security Working Group repository](https://github.com/nodejs/security-wg/blob/HEAD/processes/third\_party\_vuln\_process.md).
|
||||
|
||||
Thank you for improving the security of Node.js and its ecosystem. Your efforts
|
||||
and responsible disclosure are greatly appreciated and will be acknowledged.
|
||||
|
||||
@ -31,26 +31,26 @@ throughout the rest of the code.
|
||||
The rest of the files are structured by their function, as detailed in the
|
||||
following table:
|
||||
|
||||
| File (\*.h/\*.cc) | Description |
|
||||
| -------------------- | ----------- |
|
||||
| `crypto_aes` | AES Cipher support. |
|
||||
| `crypto_cipher` | General Encryption/Decryption utilities. |
|
||||
| File (\*.h/\*.cc) | Description |
|
||||
| -------------------- | -------------------------------------------------------------------------- |
|
||||
| `crypto_aes` | AES Cipher support. |
|
||||
| `crypto_cipher` | General Encryption/Decryption utilities. |
|
||||
| `crypto_clienthello` | TLS/SSL client hello parser implementation. Used during SSL/TLS handshake. |
|
||||
| `crypto_context` | Implementation of the `SecureContext` object. |
|
||||
| `crypto_dh` | Diffie-Hellman Key Agreement implementation. |
|
||||
| `crypto_dsa` | DSA (Digital Signature) Key Generation functions. |
|
||||
| `crypto_ec` | Elliptic-curve cryptography implementation. |
|
||||
| `crypto_hash` | Basic hash (e.g. SHA-256) functions. |
|
||||
| `crypto_hkdf` | HKDF (Key derivation) implementation. |
|
||||
| `crypto_hmac` | HMAC implementations. |
|
||||
| `crypto_keys` | Utilities for using and generating secret, private, and public keys. |
|
||||
| `crypto_pbkdf2` | PBKDF2 key / bit generation implementation. |
|
||||
| `crypto_rsa` | RSA Key Generation functions. |
|
||||
| `crypto_scrypt` | Scrypt key / bit generation implementation. |
|
||||
| `crypto_sig` | General digital signature and verification utilities. |
|
||||
| `crypto_spkac` | Netscape SPKAC certificate utilities. |
|
||||
| `crypto_ssl` | Implementation of the `SSLWrap` object. |
|
||||
| `crypto_timing` | Implementation of the TimingSafeEqual. |
|
||||
| `crypto_context` | Implementation of the `SecureContext` object. |
|
||||
| `crypto_dh` | Diffie-Hellman Key Agreement implementation. |
|
||||
| `crypto_dsa` | DSA (Digital Signature) Key Generation functions. |
|
||||
| `crypto_ec` | Elliptic-curve cryptography implementation. |
|
||||
| `crypto_hash` | Basic hash (e.g. SHA-256) functions. |
|
||||
| `crypto_hkdf` | HKDF (Key derivation) implementation. |
|
||||
| `crypto_hmac` | HMAC implementations. |
|
||||
| `crypto_keys` | Utilities for using and generating secret, private, and public keys. |
|
||||
| `crypto_pbkdf2` | PBKDF2 key / bit generation implementation. |
|
||||
| `crypto_rsa` | RSA Key Generation functions. |
|
||||
| `crypto_scrypt` | Scrypt key / bit generation implementation. |
|
||||
| `crypto_sig` | General digital signature and verification utilities. |
|
||||
| `crypto_spkac` | Netscape SPKAC certificate utilities. |
|
||||
| `crypto_ssl` | Implementation of the `SSLWrap` object. |
|
||||
| `crypto_timing` | Implementation of the TimingSafeEqual. |
|
||||
|
||||
When new crypto protocols are added, they will be added into their own
|
||||
`crypto_` `*.h` and `*.cc` files.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user