Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v10.x backport] doc: sort markdown refs in errors #24678

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
61 commits
Select commit Hold shift + click to select a range
24dd67f
build: configure default v8_optimized_debug
refack Oct 16, 2018
c9ecaef
deps,v8: fix gypfile bug
refack Oct 15, 2018
a1b5643
build: add -Werror=undefined-inline to clang builds
refack Oct 29, 2018
6f249bc
src: fix fully-static & large-pages combination
suresh-srinivas Oct 29, 2018
cc72b2a
build: make benchmark/napi all prereq order-only
danbev Oct 29, 2018
9be73ea
doc: add types and their corresponding return values
oyyd Oct 31, 2018
f1f1ae4
doc: improve BUILDING.md
Oct 30, 2018
00c0539
doc: improve COLLABORATOR_GUIDE
Oct 30, 2018
0ca3646
test: fix test-fs-watch-system-limit
ofrobots Oct 30, 2018
db4f92d
child_process: handle undefined/null for fork() args
shobhitchittora Aug 20, 2018
0ed9aaa
test: add property for RangeError in test-buffer-copy
mritunjayz Oct 30, 2018
e0902c8
test: fix strictEqual arguments order
Westixy Oct 29, 2018
3c314d1
test: assert that invalidcmd throws error code
jeromecovington Oct 28, 2018
add267b
tools: update alternative docs versions
richardlau Oct 30, 2018
559ce1c
doc: revise CHANGELOG.md text
Trott Oct 31, 2018
1956800
doc: simplify CODE_OF_CONDUCT.md
Trott Oct 31, 2018
e8e5926
doc: revise COLLABORATOR_GUIDE.md
Trott Oct 31, 2018
0c923cf
doc: address bits of proof reading work
Oct 30, 2018
579bcd1
doc: fix dublication in net.createServer() docs
prog1dev Nov 1, 2018
24a5c56
deps: cherry-pick 2987946 from upstream V8
refack Nov 21, 2018
d9e10fb
build: only check REPLACEME & DEP...X for releases
rvagg May 11, 2017
17eaf1b
test: increase --stack_size test-async-wrap-pop
danbev Oct 31, 2018
00badcb
fs: handle result of access binding directly in fs.existsSync
joyeecheung Nov 1, 2018
06844e8
n-api: add missing handle scopes
danbev Oct 31, 2018
e5177e9
repl: use promise#finally
starkwang Oct 30, 2018
7f0c3bb
doc: edit man page for superfluous "node" usage
Trott Nov 2, 2018
4fb93d1
doc: add SECURITY.md to readme.md
warnerp18 Nov 2, 2018
40c3752
doc: fix socket.connecting description
addaleax Nov 3, 2018
0ad9103
tools: add script to lint first PR commit message
richardlau Nov 2, 2018
f6a48d6
doc: correct link to test coverage command
mritunjayz Nov 2, 2018
aebd6d9
doc: add missing comma in net documentation
Trott Nov 4, 2018
9b55b90
build: do not lint on non-PR Travis builds
addaleax Nov 4, 2018
b09f94c
build: fix Travis non-PR builds
richardlau Nov 5, 2018
a23ab00
doc: add table of contents to release guide
targos Nov 2, 2018
3afde80
doc: streamline CONTRIBUTING.md
Trott Nov 1, 2018
a93a1df
meta,doc: ping community about new release
refack Nov 3, 2018
4cb822e
lib: move module exports proxy into a separate method
joyeecheung Nov 3, 2018
cc82efa
net: `net.Server.listen()` avoid operations on `null` when fail
oyyd Oct 27, 2018
bb4c086
lib:fix grammar error and make it clearer for comments
Oct 21, 2018
d30e573
test: add crypto check to test-benchmark-http2
danbev Nov 5, 2018
290796f
doc: fix minor text issues in stream.md
Trott Nov 6, 2018
a77dc9a
doc: inspector security warning for changing host
ChALkeR Oct 13, 2018
3999710
vm: clarify timeout option in vm
vdeturckheim Oct 12, 2018
45a3278
doc: implement minor text fixes to path.md
Trott Nov 6, 2018
4eaab7c
deps: remove old c-ares configure files
bnoordhuis Oct 24, 2018
209b1d5
deps: upgrade to c-ares v1.15.0
bnoordhuis Oct 24, 2018
d89bae8
deps: c-ares float, version number patch
bnoordhuis Oct 24, 2018
61458c4
build,meta: don't fail Travis for commit message
refack Oct 18, 2018
f80423b
doc: add shisama to collaborators
Nov 6, 2018
2983df8
build: use latest node on travis
cjihrig Nov 6, 2018
d242a66
doc: add psmarshall to collaborators
psmarshall Nov 6, 2018
f20bf8c
test: disable color formating for test-internal-errors.js
refack Nov 6, 2018
3102bce
doc: update System Errors documentation
Trott Nov 4, 2018
c4e34cc
doc: add text about error.code stability
Trott Nov 4, 2018
0e121bf
doc: wrap GOVERNANCE.md at 80 characters
Trott Nov 5, 2018
2015712
tools: enable 80-char line length markdown linting
Trott Nov 5, 2018
219040d
doc: fix linting errors
cjihrig Nov 7, 2018
a273da9
src: prefer param function check over args length
codebytere Nov 6, 2018
6936060
build: change repo to https protocol in Makefile
mritunjayz Nov 4, 2018
4cc8ec2
doc: sort markdown refs in errors
sam-github Oct 29, 2018
2a9f701
fixup! doc: sort markdown refs in errors
sam-github Nov 30, 2018
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,16 @@ os: linux
matrix:
include:
- name: "Linter"
node_js: "latest"
language: node_js
node_js: "node"
env:
- NODE=$(which node)
script:
- make lint
# Lint the first commit in the PR.
- \[ -z "$TRAVIS_COMMIT_RANGE" \] || (echo -e '\nLinting the commit message according to the guidelines at https://goo.gl/p2fr5Q\n' && git log $TRAVIS_COMMIT_RANGE --pretty=format:'%h' --no-merges | tail -1 | xargs npx -q core-validate-commit --no-validate-metadata)
- if [ "${TRAVIS_PULL_REQUEST}" != "false" ]; then
bash tools/lint-pr-commit-message.sh ${TRAVIS_PULL_REQUEST} || true;
fi
- name: "Test Suite"
addons:
apt:
Expand Down
16 changes: 8 additions & 8 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ platforms in production.
by Joyent. SmartOS images >= 16.4 are not supported because
GCC 4.8 runtime libraries are not available in their pkgsrc repository

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

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

### Supported toolchains

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

#### Unix

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

#### Windows

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

#### OpenSSL asm support

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

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

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

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

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

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

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

### Unix/macOS

Expand Down
14 changes: 4 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
# Node.js Changelog

<!--lint disable maximum-line-length-->

To make the changelog easier to both use and manage, it has been split into
multiple files organized according to significant major and minor Node.js
release lines.

Select a Node.js version below to view the changelog history:

* [Node.js 10](doc/changelogs/CHANGELOG_V10.md) — **Long Term Support**
Expand All @@ -23,6 +17,7 @@ Select a Node.js version below to view the changelog history:
Please use the following table to find the changelog for a specific Node.js
release.

<!--lint disable maximum-line-length-->
<table>
<tr>
<th title="Current"><a href="doc/changelogs/CHANGELOG_V10.md">10</a><sup>Current</sup></th>
Expand Down Expand Up @@ -119,10 +114,9 @@ release.

### Notes

* Release streams marked with `LTS` are currently covered by the
[Node.js Long Term Support plan](https://github.com/nodejs/Release).
* Release versions displayed in **bold** text represent the most
recent actively supported release.
* The [Node.js Long Term Support plan](https://github.com/nodejs/Release) covers
LTS releases.
* Release versions in **bold** text are the most recent supported releases.

----
----
Expand Down
8 changes: 2 additions & 6 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
# Code of Conduct

The Node.js Code of Conduct document has moved to
https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md. Please update
links to this document accordingly.

The Node.js Moderation policy can be found at
https://github.com/nodejs/admin/blob/master/Moderation-Policy.md
* [Node.js Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md)
* [Node.js Moderation Policy](https://github.com/nodejs/admin/blob/master/Moderation-Policy.md)
19 changes: 8 additions & 11 deletions COLLABORATOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
- [Using `git-node`](#using-git-node)
- [Technical HOWTO](#technical-howto)
- [Troubleshooting](#troubleshooting)
- [I Just Made a Mistake](#i-just-made-a-mistake)
- [I Made a Mistake](#i-made-a-mistake)
- [Long Term Support](#long-term-support)
- [What is LTS?](#what-is-lts)
- [How does LTS work?](#how-does-lts-work)
Expand All @@ -38,13 +38,10 @@
- [How is an LTS release cut?](#how-is-an-lts-release-cut)
* [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker)

This document contains information for Collaborators of the Node.js
project regarding managing the project's code, documentation, and issue tracker.

Collaborators should be familiar with the guidelines for new
contributors in [CONTRIBUTING.md](./CONTRIBUTING.md) and also
understand the project governance model as outlined in
[GOVERNANCE.md](./GOVERNANCE.md).
This document explains how Collaborators manage the Node.js project.
Collaborators should understand the
[guidelines for new contributors](CONTRIBUTING.md) and the
[project governance model](GOVERNANCE.md).

## Issues and Pull Requests

Expand Down Expand Up @@ -497,7 +494,7 @@ This should be done where a pull request:

Assign the `tsc-review` label or @-mention the
`@nodejs/tsc` GitHub team if you want to elevate an issue to the [TSC][].
Do not use the GitHub UI on the right hand side to assign to
Do not use the GitHub UI on the right-hand side to assign to
`@nodejs/tsc` or request a review from `@nodejs/tsc`.

The TSC should serve as the final arbiter where required.
Expand Down Expand Up @@ -528,7 +525,7 @@ The TSC should serve as the final arbiter where required.
you are unsure exactly how to format the commit messages, use the commit log
as a reference. See [this commit][commit-example] as an example.

For PRs from first time contributors, be [welcoming](#welcoming-first-time-contributors).
For PRs from first-time contributors, be [welcoming](#welcoming-first-time-contributors).
Also, verify that their git settings are to their liking.

All commits should be self-contained, meaning every commit should pass all
Expand Down Expand Up @@ -747,7 +744,7 @@ make -j4 test
git push upstream master
```

### I Just Made a Mistake
### I Made a Mistake

* Ping a TSC member.
* `#node-dev` on freenode
Expand Down
24 changes: 2 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,5 @@
# Contributing to Node.js

Contributions to Node.js include code, documentation, answering user questions,
running the project's infrastructure, and advocating for all types of Node.js
users.

The Node.js project welcomes all contributions from anyone willing to work in
good faith with other contributors and the community. No contribution is too
small and all contributions are valued.

This guide explains the process for contributing to the Node.js project's core
`nodejs/node` GitHub Repository and describes what to expect at each step.

## Contents

* [Code of Conduct](#code-of-conduct)
* [Issues](#issues)
* [Pull Requests](#pull-requests)
Expand All @@ -22,16 +9,12 @@ This guide explains the process for contributing to the Node.js project's core

The Node.js project has a
[Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md)
that *all* contributors are expected to follow. This code describes the
*minimum* behavior expectations for all contributors.
to which all contributors must adhere.

See [details on our policy on Code of Conduct](./doc/guides/contributing/coc.md).

## [Issues](./doc/guides/contributing/issues.md)

Issues in `nodejs/node` are the primary means by which bug reports and
general discussions are made.

* [How to Contribute in Issues](./doc/guides/contributing/issues.md#how-to-contribute-in-issues)
* [Asking for General Help](./doc/guides/contributing/issues.md#asking-for-general-help)
* [Discussing non-technical topics](./doc/guides/contributing/issues.md#discussing-non-technical-topics)
Expand All @@ -41,14 +24,11 @@ general discussions are made.

## [Pull Requests](./doc/guides/contributing/pull-requests.md)

Pull Requests are the way concrete changes are made to the code, documentation,
dependencies, and tools contained in the `nodejs/node` repository.

* [Dependencies](./doc/guides/contributing/pull-requests.md#dependencies)
* [Setting up your local environment](./doc/guides/contributing/pull-requests.md#setting-up-your-local-environment)
* [The Process of Making Changes](./doc/guides/contributing/pull-requests.md#the-process-of-making-changes)
* [Reviewing Pull Requests](./doc/guides/contributing/pull-requests.md#reviewing-pull-requests)
* [Additional Notes](./doc/guides/contributing/pull-requests.md#additional-notes)
* [Notes](./doc/guides/contributing/pull-requests.md#notes)

<a id="developers-certificate-of-origin"></a>
## Developer's Certificate of Origin 1.1
Expand Down
8 changes: 4 additions & 4 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ be accepted unless:

* Discussions and/or additional changes result in no Collaborators objecting to
the change. Previously-objecting Collaborators do not necessarily have to
sign-off on the change, but they should not be opposed to it.
sign off on the change, but they should not be opposed to it.
* The change is escalated to the TSC and the TSC votes to approve the change.
This should only happen if disagreements between Collaborators cannot be
resolved through discussion.
Expand Down Expand Up @@ -123,8 +123,8 @@ The meeting chair is responsible for ensuring that minutes are taken and that a
pull request with the minutes is submitted after the meeting.

Due to the challenges of scheduling a global meeting with participants in
several timezones, the TSC will seek to resolve as many agenda items as possible
outside of meetings using
several time zones, the TSC will seek to resolve as many agenda items as
possible outside of meetings using
[the TSC issue tracker](https://github.com/nodejs/TSC/issues). The process in
the issue tracker is:

Expand Down Expand Up @@ -196,7 +196,7 @@ completed within a month after the nomination is accepted.

## Consensus Seeking Process

The TSC follows a [Consensus Seeking][] decision making model as described by
The TSC follows a [Consensus Seeking][] decision-making model as described by
the [TSC Charter][].

[collaborators-discussions]: https://github.com/orgs/nodejs/teams/collaborators/discussions
Expand Down
15 changes: 7 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ coverage-build: all
if [ ! -d node_modules/nyc ]; then \
$(NODE) ./deps/npm install nyc@13 --no-save --no-package-lock; fi
if [ ! -d gcovr ]; then git clone -b 3.4 --depth=1 \
--single-branch git://github.com/gcovr/gcovr.git; fi
--single-branch https://github.com/gcovr/gcovr.git; fi
if [ ! -d build ]; then git clone --depth=1 \
--single-branch https://github.com/nodejs/build.git; fi
if [ ! -f gcovr/scripts/gcovr.orig ]; then \
Expand Down Expand Up @@ -308,19 +308,19 @@ test-valgrind: all
test-check-deopts: all
$(PYTHON) tools/test.py $(PARALLEL_ARGS) --mode=$(BUILDTYPE_LOWER) --check-deopts parallel sequential

benchmark/napi/function_call/build/Release/binding.node: all \
benchmark/napi/function_call/build/Release/binding.node: \
benchmark/napi/function_call/napi_binding.c \
benchmark/napi/function_call/binding.cc \
benchmark/napi/function_call/binding.gyp
benchmark/napi/function_call/binding.gyp | all
$(NODE) deps/npm/node_modules/node-gyp/bin/node-gyp rebuild \
--python="$(PYTHON)" \
--directory="$(shell pwd)/benchmark/napi/function_call" \
--nodedir="$(shell pwd)"

benchmark/napi/function_args/build/Release/binding.node: all \
benchmark/napi/function_args/build/Release/binding.node: \
benchmark/napi/function_args/napi_binding.c \
benchmark/napi/function_args/binding.cc \
benchmark/napi/function_args/binding.gyp
benchmark/napi/function_args/binding.gyp | all
$(NODE) deps/npm/node_modules/node-gyp/bin/node-gyp rebuild \
--python="$(PYTHON)" \
--directory="$(shell pwd)/benchmark/napi/function_args" \
Expand Down Expand Up @@ -810,12 +810,11 @@ MACOSOUTDIR=out/macos

.PHONY: release-only
release-only:
@if [ "$(DISTTYPE)" != "nightly" ] && [ "$(DISTTYPE)" != "next-nightly" ] && \
`grep -q REPLACEME doc/api/*.md`; then \
@if [ "$(DISTTYPE)" = "release" ] && `grep -q REPLACEME doc/api/*.md`; then \
echo 'Please update REPLACEME in Added: tags in doc/api/*.md (See doc/releases.md)' ; \
exit 1 ; \
fi
@if [ "$(DISTTYPE)" != "nightly" ] && [ "$(DISTTYPE)" != "next-nightly" ] && \
@if [ "$(DISTTYPE)" = "release" ] && \
`grep -q DEP...X doc/api/deprecations.md`; then \
echo 'Please update DEP...X in doc/api/deprecations.md (See doc/releases.md)' ; \
exit 1 ; \
Expand Down
43 changes: 6 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,43 +159,8 @@ source and a list of supported platforms.

## Security

If you find a security vulnerability in Node.js, please report it to
security@nodejs.org. Please withhold public disclosure until after the security
team has addressed the vulnerability.

The security team will acknowledge your email within 24 hours. You will receive
a more detailed response within 48 hours.

There are no hard and fast rules to determine if a bug is worth reporting as a
security issue. Here are some examples of past issues and what the Security
Response Team thinks of them. When in doubt, please do send us a report
nonetheless.


### Public disclosure preferred

- [#14519](https://github.com/nodejs/node/issues/14519): _Internal domain
function can be used to cause segfaults_. Requires the ability to execute
arbitrary JavaScript code. That is already the highest level of privilege
possible.

### Private disclosure preferred

- [CVE-2016-7099](https://nodejs.org/en/blog/vulnerability/september-2016-security-releases/):
_Fix invalid wildcard certificate validation check_. This was a high-severity
defect. It caused Node.js TLS clients to accept invalid wildcard certificates.

- [#5507](https://github.com/nodejs/node/pull/5507): _Fix a defect that makes
the CacheBleed Attack possible_. Many, though not all, OpenSSL vulnerabilities
in the TLS/SSL protocols also affect Node.js.

- [CVE-2016-2216](https://nodejs.org/en/blog/vulnerability/february-2016-security-releases/):
_Fix defects in HTTP header parsing for requests and responses that can allow
response splitting_. This was a remotely-exploitable defect in the Node.js
HTTP implementation.

When in doubt, please do send us a report.

For information on reporting security vulnerabilities in Node.js, see
[SECURITY.md](./SECURITY.md).

## Current Project Team Members

Expand Down Expand Up @@ -440,6 +405,8 @@ For information about the governance of the Node.js project, see
**Minqi Pan** &lt;pmq2001@gmail.com&gt;
* [princejwesley](https://github.com/princejwesley) -
**Prince John Wesley** &lt;princejohnwesley@gmail.com&gt;
* [psmarshall](https://github.com/psmarshall) -
**Peter Marshall** &lt;petermarshall@chromium.org&gt; (he/him)
* [Qard](https://github.com/Qard) -
**Stephen Belanger** &lt;admin@stephenbelanger.com&gt; (he/him)
* [refack](https://github.com/refack) -
Expand Down Expand Up @@ -468,6 +435,8 @@ For information about the governance of the Node.js project, see
**Nikolai Vavilov** &lt;vvnicholas@gmail.com&gt;
* [shigeki](https://github.com/shigeki) -
**Shigeki Ohtsu** &lt;ohtsu@ohtsu.org&gt; (he/him)
* [shisama](https://github.com/shisama) -
**Masashi Hirano** &lt;shisama07@gmail.com&gt; (he/him)
* [silverwind](https://github.com/silverwind) -
**Roman Reiss** &lt;me@silverwind.io&gt;
* [srl295](https://github.com/srl295) -
Expand Down