doc: fix style inconsistencies in code examples

.eslintignore

@@ -2,7 +2,7 @@ lib/internal/v8_prof_polyfill.js
 lib/punycode.js
 test/addons/??_*/
 test/fixtures
-test/**/node_modules
 test/disabled
 test/tmp*/
-tools/doc/node_modules
+tools/eslint
+node_modules

.eslintrc

@@ -5,7 +5,7 @@ env:
 rules:
   # Possible Errors
   # http://eslint.org/docs/rules/#possible-errors
-  comma-dangle: [2, "only-multiline"]
+  comma-dangle: [2, only-multiline]
   no-control-regex: 2
   no-debugger: 2
   no-dupe-args: 2
@@ -14,7 +14,7 @@ rules:
   no-empty-character-class: 2
   no-ex-assign: 2
   no-extra-boolean-cast: 2
-  no-extra-parens: [2, "functions"]
+  no-extra-parens: [2, functions]
   no-extra-semi: 2
   no-func-assign: 2
   no-invalid-regexp: 2
@@ -38,46 +38,47 @@ rules:
 
   # Strict Mode
   # http://eslint.org/docs/rules/#strict-mode
-  strict: [2, "global"]
+  strict: [2, global]
 
   # Variables
   # http://eslint.org/docs/rules/#variables
   no-delete-var: 2
   no-undef: 2
-  no-unused-vars: [2, {"args": "none"}]
+  no-unused-vars: [2, {args: none}]
 
   # Node.js and CommonJS
   # http://eslint.org/docs/rules/#nodejs-and-commonjs
   no-mixed-requires: 2
   no-new-require: 2
   no-path-concat: 2
-  no-restricted-modules: [2, "sys", "_linklist"]
+  no-restricted-modules: [2, sys, _linklist]
 
   # Stylistic Issues
   # http://eslint.org/docs/rules/#stylistic-issues
+  brace-style: [2, 1tbs, {allowSingleLine: true}]
   comma-spacing: 2
   eol-last: 2
   indent: [2, 2, {SwitchCase: 1}]
-  key-spacing: [2, {mode: "minimum"}]
+  key-spacing: [2, {mode: minimum}]
   keyword-spacing: 2
-  linebreak-style: [2, "unix"]
+  linebreak-style: [2, unix]
   max-len: [2, 80, 2]
   new-parens: 2
   no-mixed-spaces-and-tabs: 2
   no-multiple-empty-lines: [2, {max: 2}]
   no-trailing-spaces: 2
-  quotes: [2, "single", "avoid-escape"]
+  quotes: [2, single, avoid-escape]
   semi: 2
-  space-before-blocks: [2, "always"]
-  space-before-function-paren: [2, "never"]
-  space-in-parens: [2, "never"]
+  space-before-blocks: [2, always]
+  space-before-function-paren: [2, never]
+  space-in-parens: [2, never]
   space-infix-ops: 2
   space-unary-ops: 2
 
   # ECMAScript 6
   # http://eslint.org/docs/rules/#ecmascript-6
-  arrow-parens: [2, "always"]
-  arrow-spacing: [2, {"before": true, "after": true}]
+  arrow-parens: [2, always]
+  arrow-spacing: [2, {before: true, after: true}]
   constructor-super: 2
   no-class-assign: 2
   no-confusing-arrow: 2
@@ -92,27 +93,27 @@ rules:
   align-function-arguments: 2
   align-multiline-assignment: 2
   assert-fail-single-argument: 2
-  new-with-error: [2, "Error", "RangeError", "TypeError", "SyntaxError", "ReferenceError"]
+  new-with-error: [2, Error, RangeError, TypeError, SyntaxError, ReferenceError]
   no-deepEqual: 2
   no-definegetter-definesetter: 2
 
 # Global scoped method and vars
 globals:
-  DTRACE_HTTP_CLIENT_REQUEST           : false
-  LTTNG_HTTP_CLIENT_REQUEST            : false
-  COUNTER_HTTP_CLIENT_REQUEST          : false
-  DTRACE_HTTP_CLIENT_RESPONSE          : false
-  LTTNG_HTTP_CLIENT_RESPONSE           : false
-  COUNTER_HTTP_CLIENT_RESPONSE         : false
-  DTRACE_HTTP_SERVER_REQUEST           : false
-  LTTNG_HTTP_SERVER_REQUEST            : false
-  COUNTER_HTTP_SERVER_REQUEST          : false
-  DTRACE_HTTP_SERVER_RESPONSE          : false
-  LTTNG_HTTP_SERVER_RESPONSE           : false
-  COUNTER_HTTP_SERVER_RESPONSE         : false
-  DTRACE_NET_STREAM_END                : false
-  LTTNG_NET_STREAM_END                 : false
-  COUNTER_NET_SERVER_CONNECTION_CLOSE  : false
-  DTRACE_NET_SERVER_CONNECTION         : false
-  LTTNG_NET_SERVER_CONNECTION          : false
-  COUNTER_NET_SERVER_CONNECTION        : false
+  COUNTER_HTTP_CLIENT_REQUEST: false
+  COUNTER_HTTP_CLIENT_RESPONSE: false
+  COUNTER_HTTP_SERVER_REQUEST: false
+  COUNTER_HTTP_SERVER_RESPONSE: false
+  COUNTER_NET_SERVER_CONNECTION: false
+  COUNTER_NET_SERVER_CONNECTION_CLOSE: false
+  DTRACE_HTTP_CLIENT_REQUEST: false
+  DTRACE_HTTP_CLIENT_RESPONSE: false
+  DTRACE_HTTP_SERVER_REQUEST: false
+  DTRACE_HTTP_SERVER_RESPONSE: false
+  DTRACE_NET_SERVER_CONNECTION: false
+  DTRACE_NET_STREAM_END: false
+  LTTNG_HTTP_CLIENT_REQUEST: false
+  LTTNG_HTTP_CLIENT_RESPONSE: false
+  LTTNG_HTTP_SERVER_REQUEST: false
+  LTTNG_HTTP_SERVER_RESPONSE: false
+  LTTNG_NET_SERVER_CONNECTION: false
+  LTTNG_NET_STREAM_END: false

.github/ISSUE_TEMPLATE.md

@@ -1,9 +1,9 @@
 <!--
-Thank you for reporting an issue. Please fill in the template below. If unsure
-about something, just do as best as you're able.
+Thank you for reporting an issue.
+Please fill in as much of the template below as you're able.
 
-Version: usually output of `node -v`
-Platform: either `uname -a` output, or if Windows, version and 32 or 64-bit
+Version: output of `node -v`
+Platform: output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows)
 Subsystem: if known, please specify affected core module name
 
 If possible, please provide code that demonstrates the problem, keeping it as

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,23 +1,22 @@
 <!--
 Thank you for your pull request. Please review below requirements.
 
-Bug fixes and new features should include tests and possibly a benchmark.
+Bug fixes and new features should include tests and possibly benchmarks.
 
 Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
 -->
 
 ##### Checklist
 <!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
 
-- [ ] `make -j4 test` (UNIX) or `vcbuild test nosign` (Windows) passes
-- [ ] a test and/or benchmark is included
+- [ ] `make -j4 test` (UNIX), or `vcbuild test nosign` (Windows) passes
+- [ ] tests and/or benchmarks are included
 - [ ] documentation is changed or added
-- [ ] the commit message follows commit guidelines
-
+- [ ] commit message follows commit guidelines
 
 ##### Affected core subsystem(s)
-<!-- provide affected core subsystem(s) (like doc, cluster, crypto, etc) -->
+<!-- Provide affected core subsystem(s) (like doc, cluster, crypto, etc). -->
 
 
 ##### Description of change
-<!-- provide a description of the change below this comment -->
+<!-- Provide a description of the change below this comment. -->

BUILDING.md

@@ -99,8 +99,10 @@ $ node -e "console.log('Hello from Node.js ' + process.version)"
 Prerequisites:
 
 * [Python 2.6 or 2.7](https://www.python.org/downloads/)
-* Visual Studio 2013 / 2015, all editions including the Community edition, or
-* Visual Studio Express 2013 / 2015 for Desktop
+* One of:
+  * [Visual C++ Build Tools](http://landinghub.visualstudio.com/visual-cpp-build-tools)
+  * [Visual Studio](https://www.visualstudio.com/) 2013 / 2015, all editions including the Community edition
+  * [Visual Studio](https://www.visualstudio.com/) Express 2013 / 2015 for Desktop
 * Basic Unix tools required for some tests,
   [Git for Windows](http://git-scm.com/download/win) includes Git Bash
   and tools which can be included in the global `PATH`.
@@ -117,8 +119,8 @@ To run the tests:
 
 To test if Node.js was built correctly:
 
-```
-$ node -e "console.log('Hello from Node.js ' + process.version)"
+```text
+> Release\node -e "console.log('Hello from Node.js', process.version)"
 ```
 
 ### Android / Android-based devices (e.g., Firefox OS)

CHANGELOG.md

@@ -26,7 +26,9 @@ release.
 </tr>
 <tr>
   <td valign="top">
-<b><a href="doc/changelogs/CHANGELOG_V6.md#6.2.1">6.2.1</a></b><br/>
+<b><a href="doc/changelogs/CHANGELOG_V6.md#6.3.0">6.3.0</a></b><br/>
+<a href="doc/changelogs/CHANGELOG_V6.md#6.2.2">6.2.2</a><br/>
+<a href="doc/changelogs/CHANGELOG_V6.md#6.2.1">6.2.1</a><br/>
 <a href="doc/changelogs/CHANGELOG_V6.md#6.2.0">6.2.0</a><br/>
 <a href="doc/changelogs/CHANGELOG_V6.md#6.1.0">6.1.0</a><br/>
 <a href="doc/changelogs/CHANGELOG_V6.md#6.0.0">6.0.0</a><br/>
@@ -52,7 +54,9 @@ release.
 <a href="doc/changelogs/CHANGELOG_V5.md#5.0.0">5.0.0</a><br/>
   </td>
   <td valign="top">
-<b><a href="doc/changelogs/CHANGELOG_V4.md#4.4.5">4.4.5</a></b><br/>
+<b><a href="doc/changelogs/CHANGELOG_V4.md#4.4.7">4.4.7</a></b><br/>
+<a href="doc/changelogs/CHANGELOG_V4.md#4.4.6">4.4.6</a></b>
+<a href="doc/changelogs/CHANGELOG_V4.md#4.4.5">4.4.5</a></b>
 <a href="doc/changelogs/CHANGELOG_V4.md#4.4.4">4.4.4</a><br/>
 <a href="doc/changelogs/CHANGELOG_V4.md#4.4.3">4.4.3</a><br/>
 <a href="doc/changelogs/CHANGELOG_V4.md#4.4.2">4.4.2</a><br/>
@@ -74,7 +78,8 @@ release.
 <a href="doc/changelogs/CHANGELOG_V4.md#4.0.0">4.0.0</a><br/>
   </td>
   <td valign="top">
-<b><a href="doc/changelogs/CHANGELOG_V012.md#0.12.14">0.12.14</a></b><br/>
+<b><a href="doc/changelogs/CHANGELOG_V012.md#0.12.15">0.12.15</a></b><br/>
+<a href="doc/changelogs/CHANGELOG_V012.md#0.12.14">0.12.14</a><br/>
 <a href="doc/changelogs/CHANGELOG_V012.md#0.12.13">0.12.13</a><br/>
 <a href="doc/changelogs/CHANGELOG_V012.md#0.12.12">0.12.12</a><br/>
 <a href="doc/changelogs/CHANGELOG_V012.md#0.12.11">0.12.11</a><br/>
@@ -91,7 +96,8 @@ release.
 <a href="doc/changelogs/CHANGELOG_V012.md#0.12.0">0.12.0</a><br/>
   </td>
   <td valign="top">
-<b><a href="doc/changelogs/CHANGELOG_V010.md#0.10.45">0.10.45</a></b><br/>
+<b><a href="doc/changelogs/CHANGELOG_V010.md#0.10.46">0.10.46</a></b><br/>
+<a href="doc/changelogs/CHANGELOG_V010.md#0.10.45">0.10.45</a><br/>
 <a href="doc/changelogs/CHANGELOG_V010.md#0.10.44">0.10.44</a><br/>
 <a href="doc/changelogs/CHANGELOG_V010.md#0.10.43">0.10.43</a><br/>
 <a href="doc/changelogs/CHANGELOG_V010.md#0.10.42">0.10.42</a><br/>

CONTRIBUTING.md

@@ -150,6 +150,9 @@ $ ./configure && make -j8 test
 Make sure the linter is happy and that all tests pass. Please, do not submit
 patches that fail either check.
 
+Running `make test` will run the linter as well unless one or more tests fail.
+If you want to run the linter without running tests, use `make lint`.
+
 If you are updating tests and just want to run a single test to check it, you
 can use this syntax to run it exactly as the test harness would:
 

GOVERNANCE.md

@@ -46,7 +46,7 @@ responsibility for the change. In the case of pull requests proposed
 by an existing Collaborator, an additional Collaborator is required
 for sign-off. Consensus should be sought if additional Collaborators
 participate and there is disagreement around a particular
-modification. See _Consensus Seeking Process_ below for further detail
+modification. See [Consensus Seeking Process](#consensus-seeking-process) below for further detail
 on the consensus model used for governance.
 
 Collaborators may opt to elevate significant or controversial

Makefile

@@ -19,9 +19,9 @@ ifdef QUICKCHECK
 endif
 
 ifdef ENABLE_V8_TAP
-  TAP_V8 := --junitout v8-tap.xml
-  TAP_V8_INTL := --junitout v8-intl-tap.xml
-  TAP_V8_BENCHMARKS := --junitout v8-benchmarks-tap.xml
+  TAP_V8 := --junitout $(PWD)/v8-tap.xml
+  TAP_V8_INTL := --junitout $(PWD)/v8-intl-tap.xml
+  TAP_V8_BENCHMARKS := --junitout $(PWD)/v8-benchmarks-tap.xml
 endif
 
 V8_TEST_OPTIONS = $(V8_EXTRA_TEST_OPTIONS)
@@ -112,13 +112,13 @@ cctest: all
 
 v8:
 	tools/make-v8.sh v8
-	$(MAKE) -C deps/v8 $(V8_ARCH) $(V8_BUILD_OPTIONS)
+	$(MAKE) -C deps/v8 $(V8_ARCH).$(BUILDTYPE_LOWER) $(V8_BUILD_OPTIONS)
 
 test: all
 	$(MAKE) build-addons
 	$(MAKE) cctest
 	$(PYTHON) tools/test.py --mode=release -J \
-		addon doctool known_issues message pseudo-tty parallel sequential
+		addons doctool known_issues message pseudo-tty parallel sequential
 	$(MAKE) lint
 
 test-parallel: all
@@ -184,11 +184,25 @@ test-all: test-build test/gc/node_modules/weak/build/Release/weakref.node
 test-all-valgrind: test-build
 	$(PYTHON) tools/test.py --mode=debug,release --valgrind
 
+CI_NATIVE_SUITES := addons
+CI_JS_SUITES := doctool known_issues message parallel pseudo-tty sequential
+
+# Build and test addons without building anything else
+test-ci-native: | test/addons/.buildstamp
+	$(PYTHON) tools/test.py $(PARALLEL_ARGS) -p tap --logfile test.tap \
+		--mode=release --flaky-tests=$(FLAKY_TESTS) \
+		$(TEST_CI_ARGS) $(CI_NATIVE_SUITES)
+
+# This target should not use a native compiler at all
+test-ci-js:
+	$(PYTHON) tools/test.py $(PARALLEL_ARGS) -p tap --logfile test.tap \
+		--mode=release --flaky-tests=$(FLAKY_TESTS) \
+		$(TEST_CI_ARGS) $(CI_JS_SUITES)
+
 test-ci: | build-addons
 	$(PYTHON) tools/test.py $(PARALLEL_ARGS) -p tap --logfile test.tap \
 		--mode=release --flaky-tests=$(FLAKY_TESTS) \
-		$(TEST_CI_ARGS) addons doctool known_issues message pseudo-tty parallel \
-		sequential
+		$(TEST_CI_ARGS) $(CI_NATIVE_SUITES) $(CI_JS_SUITES)
 
 test-release: test-build
 	$(PYTHON) tools/test.py --mode=release
@@ -232,22 +246,22 @@ test-timers-clean:
 
 
 ifneq ("","$(wildcard deps/v8/tools/run-tests.py)")
-test-v8:
+test-v8: v8
 	# note: performs full test unless QUICKCHECK is specified
 	deps/v8/tools/run-tests.py --arch=$(V8_ARCH) \
         --mode=$(BUILDTYPE_LOWER) $(V8_TEST_OPTIONS) $(QUICKCHECK_ARG) \
         --no-presubmit \
         --shell-dir=$(PWD)/deps/v8/out/$(V8_ARCH).$(BUILDTYPE_LOWER) \
 	 $(TAP_V8)
 
-test-v8-intl:
+test-v8-intl: v8
 	# note: performs full test unless QUICKCHECK is specified
 	deps/v8/tools/run-tests.py --arch=$(V8_ARCH) \
         --mode=$(BUILDTYPE_LOWER) --no-presubmit $(QUICKCHECK_ARG) \
         --shell-dir=deps/v8/out/$(V8_ARCH).$(BUILDTYPE_LOWER) intl \
         $(TAP_V8_INTL)
 
-test-v8-benchmarks:
+test-v8-benchmarks: v8
 	deps/v8/tools/run-tests.py --arch=$(V8_ARCH) --mode=$(BUILDTYPE_LOWER) \
         --download-data $(QUICKCHECK_ARG) --no-presubmit \
         --shell-dir=deps/v8/out/$(V8_ARCH).$(BUILDTYPE_LOWER) benchmarks \
@@ -299,9 +313,11 @@ docopen: out/doc/api/all.html
 docclean:
 	-rm -rf out/doc
 
-run-ci:
+build-ci:
 	$(PYTHON) ./configure $(CONFIG_FLAGS)
 	$(MAKE)
+
+run-ci: build-ci
 	$(MAKE) test-ci
 
 RAWVER=$(shell $(PYTHON) tools/getnodeversion.py)
@@ -662,27 +678,19 @@ bench-idle:
 	$(NODE) benchmark/idle_clients.js &
 
 jslint:
-	$(NODE) tools/jslint.js -J benchmark lib src test tools/doc \
-	  tools/eslint-rules tools/jslint.js
+	$(NODE) tools/jslint.js -J benchmark lib src test tools
 
 jslint-ci:
 	$(NODE) tools/jslint.js $(PARALLEL_ARGS) -f tap -o test-eslint.tap \
-		benchmark lib src test tools/doc \
-		tools/eslint-rules tools/jslint.js
+		benchmark lib src test tools
 
 CPPLINT_EXCLUDE ?=
-CPPLINT_EXCLUDE += src/node_lttng.cc
 CPPLINT_EXCLUDE += src/node_root_certs.h
-CPPLINT_EXCLUDE += src/node_lttng_tp.h
-CPPLINT_EXCLUDE += src/node_win32_perfctr_provider.cc
 CPPLINT_EXCLUDE += src/queue.h
 CPPLINT_EXCLUDE += src/tree.h
-CPPLINT_EXCLUDE += src/v8abbr.h
 CPPLINT_EXCLUDE += $(wildcard test/addons/??_*/*.cc test/addons/??_*/*.h)
 
 CPPLINT_FILES = $(filter-out $(CPPLINT_EXCLUDE), $(wildcard \
-	deps/debugger-agent/include/* \
-	deps/debugger-agent/src/* \
 	src/*.c \
 	src/*.cc \
 	src/*.h \
@@ -715,4 +723,4 @@ endif
 	bench-all bench bench-misc bench-array bench-buffer bench-net \
 	bench-http bench-fs bench-tls cctest run-ci test-v8 test-v8-intl \
 	test-v8-benchmarks test-v8-all v8 lint-ci bench-ci jslint-ci doc-only \
-	$(TARBALL)-headers
+	$(TARBALL)-headers test-ci test-ci-native test-ci-js build-ci