summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorСковорода Никита Андреевич <chalkerx@gmail.com>2016-07-09 08:13:09 +0300
committerСковорода Никита Андреевич <chalkerx@gmail.com>2016-07-14 12:26:50 +0300
commita58b48bc3bcf43f7090d4cc914606af68fe55815 (patch)
tree0fdf8a6a67489aa0474a6be3420dfb5cde3d61f9 /doc
parente09c62ae3307c434dd237a3bb47805207b36a0d1 (diff)
downloadandroid-node-v8-a58b48bc3bcf43f7090d4cc914606af68fe55815.tar.gz
android-node-v8-a58b48bc3bcf43f7090d4cc914606af68fe55815.tar.bz2
android-node-v8-a58b48bc3bcf43f7090d4cc914606af68fe55815.zip
doc: various documentation formatting fixes
* Fix markdown code sample in releases.md, it was <a id="x.y.x></a>" * Fix some markdown errors, e.g. in changelogs * Fix broken defs links, e.g. in domain-postmortem.md * Fix other broken refs, by addaleax * Add links to some defs that were present but not linked to * Remove dead defs * Move defs to the bottom (one file affected) * Add language indicators to all code blocks, using `txt` when no specific language could be chosen * Some minor formatting changes (spaces, ident, headings) PR-URL: https://github.com/nodejs/node/pull/7637 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Roman Reiss <me@silverwind.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/addons.md12
-rw-r--r--doc/api/buffer.md2
-rw-r--r--doc/api/cluster.md2
-rw-r--r--doc/api/debugger.md6
-rw-r--r--doc/api/dgram.md1
-rw-r--r--doc/api/dns.md8
-rw-r--r--doc/api/documentation.md8
-rw-r--r--doc/api/errors.md2
-rw-r--r--doc/api/fs.md2
-rw-r--r--doc/api/globals.md6
-rw-r--r--doc/api/http.md35
-rw-r--r--doc/api/modules.md14
-rw-r--r--doc/api/net.md4
-rw-r--r--doc/api/process.md25
-rw-r--r--doc/api/repl.md4
-rw-r--r--doc/api/stream.md12
-rw-r--r--doc/api/synopsis.md2
-rw-r--r--doc/api/timers.md2
-rw-r--r--doc/api/tls.md20
-rw-r--r--doc/api/tty.md4
-rw-r--r--doc/api/url.md4
-rw-r--r--doc/api/util.md5
-rw-r--r--doc/api/v8.md2
-rw-r--r--doc/api/vm.md3
-rw-r--r--doc/api/zlib.md9
-rw-r--r--doc/changelogs/CHANGELOG_V4.md6
-rw-r--r--doc/changelogs/CHANGELOG_V5.md4
-rw-r--r--doc/changelogs/CHANGELOG_V6.md4
-rw-r--r--doc/ctc-meetings/2016-02-03.md2
-rw-r--r--doc/ctc-meetings/2016-06-15.md3
-rw-r--r--doc/guides/building-node-with-ninja.md2
-rw-r--r--doc/onboarding-extras.md2
-rw-r--r--doc/releases.md29
-rw-r--r--doc/topics/blocking-vs-non-blocking.md2
-rw-r--r--doc/topics/domain-postmortem.md2
-rw-r--r--doc/tsc-meetings/io.js/2014-12-10.md2
36 files changed, 116 insertions, 136 deletions
diff --git a/doc/api/addons.md b/doc/api/addons.md
index 1187eafdc3..1333b3b136 100644
--- a/doc/api/addons.md
+++ b/doc/api/addons.md
@@ -102,7 +102,7 @@ top-level of the project describing the build configuration of your module
using a JSON-like format. This file is used by [node-gyp][] -- a tool written
specifically to compile Node.js Addons.
-```
+```json
{
"targets": [
{
@@ -222,7 +222,7 @@ templates, etc.
Each of these examples using the following `binding.gyp` file:
-```
+```json
{
"targets": [
{
@@ -236,14 +236,14 @@ Each of these examples using the following `binding.gyp` file:
In cases where there is more than one `.cc` file, simply add the additional
filename to the `sources` array. For example:
-```
+```json
"sources": ["addon.cc", "myexample.cc"]
```
Once the `binding.gyp` file is ready, the example Addons can be configured and
built using `node-gyp`:
-```
+```sh
$ node-gyp configure build
```
@@ -621,7 +621,7 @@ void MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {
To build this example, the `myobject.cc` file must be added to the
`binding.gyp`:
-```
+```json
{
"targets": [
{
@@ -813,7 +813,7 @@ void MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {
Once again, to build this example, the `myobject.cc` file must be added to the
`binding.gyp`:
-```
+```json
{
"targets": [
{
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
index 91852a2130..b332de1ab2 100644
--- a/doc/api/buffer.md
+++ b/doc/api/buffer.md
@@ -114,7 +114,7 @@ significant impact* on performance. Use of the `--zero-fill-buffers` option is
recommended only when absolutely necessary to enforce that newly allocated
`Buffer` instances cannot contain potentially sensitive data.
-```
+```txt
$ node --zero-fill-buffers
> Buffer.allocUnsafe(5);
<Buffer 00 00 00 00 00>
diff --git a/doc/api/cluster.md b/doc/api/cluster.md
index 1c769567c4..6f0b424e05 100644
--- a/doc/api/cluster.md
+++ b/doc/api/cluster.md
@@ -35,7 +35,7 @@ if (cluster.isMaster) {
Running Node.js will now share port 8000 between the workers:
-```
+```txt
$ NODE_DEBUG=cluster node server.js
23521,Master Worker 23524 online
23521,Master Worker 23526 online
diff --git a/doc/api/debugger.md b/doc/api/debugger.md
index 6a31212d9c..d146292f2d 100644
--- a/doc/api/debugger.md
+++ b/doc/api/debugger.md
@@ -9,7 +9,7 @@ via a simple [TCP-based protocol][] and built-in debugging client. To use it,
start Node.js with the `debug` argument followed by the path to the script to
debug; a prompt will be displayed indicating successful launch of the debugger:
-```
+```txt
$ node debug myscript.js
< debugger listening on port 5858
connecting... ok
@@ -38,7 +38,7 @@ console.log('hello');
Once the debugger is run, a breakpoint will occur at line 4:
-```
+```txt
$ node debug myscript.js
< debugger listening on port 5858
connecting... ok
@@ -119,7 +119,7 @@ on line 1
It is also possible to set a breakpoint in a file (module) that
isn't loaded yet:
-```
+```txt
$ ./node debug test/fixtures/break-in-module/main.js
< debugger listening on port 5858
connecting to port 5858... ok
diff --git a/doc/api/dgram.md b/doc/api/dgram.md
index df479a8e31..1a5cce0b91 100644
--- a/doc/api/dgram.md
+++ b/doc/api/dgram.md
@@ -425,7 +425,6 @@ and `udp6` sockets). The bound address and port can be retrieved using
[`EventEmitter`]: events.html
[`Buffer`]: buffer.html
[`'close'`]: #dgram_event_close
-[`addMembership()`]: #dgram_socket_addmembership_multicastaddress_multicastinterface
[`close()`]: #dgram_socket_close_callback
[`dgram.createSocket()`]: #dgram_dgram_createsocket_options_callback
[`dgram.Socket#bind()`]: #dgram_socket_bind_options_callback
diff --git a/doc/api/dns.md b/doc/api/dns.md
index 3f90d632a8..7192be9a86 100644
--- a/doc/api/dns.md
+++ b/doc/api/dns.md
@@ -86,7 +86,7 @@ Alternatively, `options` can be an object containing these properties:
All properties are optional. An example usage of options is shown below.
-```
+```js
{
family: 4,
hints: dns.ADDRCONFIG | dns.V4MAPPED,
@@ -279,7 +279,7 @@ be an object with the following properties:
* `expire`
* `minttl`
-```
+```js
{
nsname: 'ns.example.com',
hostmaster: 'root.example.com',
@@ -305,7 +305,7 @@ be an array of objects with the following properties:
* `port`
* `name`
-```
+```js
{
priority: 10,
weight: 5,
@@ -437,8 +437,6 @@ uses. For instance, _they do not use the configuration from `/etc/hosts`_.
[DNS error codes]: #dns_error_codes
[`dns.lookup()`]: #dns_dns_lookup_hostname_options_callback
-[`dns.resolve()`]: #dns_dns_resolve_hostname_rrtype_callback
-[`dns.resolve4()`]: #dns_dns_resolve4_hostname_callback
[`dns.resolveSoa()`]: #dns_dns_resolvesoa_hostname_callback
[`Error`]: errors.html#errors_class_error
[Implementation considerations section]: #dns_implementation_considerations
diff --git a/doc/api/documentation.md b/doc/api/documentation.md
index 61d623fe3e..1acb21a896 100644
--- a/doc/api/documentation.md
+++ b/doc/api/documentation.md
@@ -37,26 +37,26 @@ and in the process of being redesigned.
The stability indices are as follows:
-```
+```txt
Stability: 0 - Deprecated
This feature is known to be problematic, and changes are
planned. Do not rely on it. Use of the feature may cause warnings. Backwards
compatibility should not be expected.
```
-```
+```txt
Stability: 1 - Experimental
This feature is subject to change, and is gated by a command line flag.
It may change or be removed in future versions.
```
-```
+```txt
Stability: 2 - Stable
The API has proven satisfactory. Compatibility with the npm ecosystem
is a high priority, and will not be broken unless absolutely necessary.
```
-```
+```txt
Stability: 3 - Locked
Only fixes related to security, performance, or bug fixes will be accepted.
Please do not suggest API changes in this area; they will be refused.
diff --git a/doc/api/errors.md b/doc/api/errors.md
index e80dabe609..5ede6e6e38 100644
--- a/doc/api/errors.md
+++ b/doc/api/errors.md
@@ -268,7 +268,7 @@ instantiated.
For example:
-```
+```txt
Error: Things keep happening!
at /home/gbusey/file.js:525:2
at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)
diff --git a/doc/api/fs.md b/doc/api/fs.md
index 022fa0d2cf..e2d1597aa7 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -74,7 +74,7 @@ Most fs functions let you omit the callback argument. If you do, a default
callback is used that rethrows errors. To get a trace to the original call
site, set the `NODE_DEBUG` environment variable:
-```
+```txt
$ cat script.js
function bad() {
require('fs').readFile('/');
diff --git a/doc/api/globals.md b/doc/api/globals.md
index 1bd2dffc5f..7db4fbe1aa 100644
--- a/doc/api/globals.md
+++ b/doc/api/globals.md
@@ -207,9 +207,9 @@ but rather than loading the module, just return the resolved filename.
[Modules]: modules.html#modules_modules
[native addons]: addons.html
[timers]: timers.html
-[`clearImmediate`]: timers.html#timers_clearimmediate_immediateobject
-[`clearInterval`]: timers.html#timers_clearinterval_immediateobject
-[`clearTimeout`]: timers.html#timers_cleartimeout_timeoutobject
+[`clearImmediate`]: timers.html#timers_clearimmediate_immediate
+[`clearInterval`]: timers.html#timers_clearinterval_timeout
+[`clearTimeout`]: timers.html#timers_cleartimeout_timeout
[`setImmediate`]: timers.html#timers_setimmediate_callback_arg
[`setInterval`]: timers.html#timers_setinterval_callback_delay_arg
[`setTimeout`]: timers.html#timers_settimeout_callback_delay_arg
diff --git a/doc/api/http.md b/doc/api/http.md
index 1a09e96395..0079ec7566 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -12,7 +12,7 @@ user is able to stream data.
HTTP message headers are represented by an object like this:
-```
+```js
{ 'content-length': '123',
'content-type': 'text/plain',
'connection': 'keep-alive',
@@ -34,7 +34,7 @@ property, which is an array of `[key, value, key2, value2, ...]`. For
example, the previous message header object might have a `rawHeaders`
list like the following:
-```
+```js
[ 'ConTent-Length', '123456',
'content-LENGTH', '123',
'content-type', 'text/plain',
@@ -222,16 +222,16 @@ header is still mutable using the `setHeader(name, value)`, `getHeader(name)`,
`removeHeader(name)` API. The actual header will be sent along with the first
data chunk or when closing the connection.
-To get the response, add a listener for `'response'` to the request object.
-`'response'` will be emitted from the request object when the response
-headers have been received. The `'response'` event is executed with one
+To get the response, add a listener for [`'response'`][] to the request object.
+[`'response'`][] will be emitted from the request object when the response
+headers have been received. The [`'response'`][] event is executed with one
argument which is an instance of [`http.IncomingMessage`][].
-During the `'response'` event, one can add listeners to the
+During the [`'response'`][] event, one can add listeners to the
response object; particularly to listen for the `'data'` event.
-If no `'response'` handler is added, then the response will be
-entirely discarded. However, if you add a `'response'` event handler,
+If no [`'response'`][] handler is added, then the response will be
+entirely discarded. However, if you add a [`'response'`][] event handler,
then you **must** consume the data from the response object, either by
calling `response.read()` whenever there is a `'readable'` event, or
by adding a `'data'` handler, or by calling the `.resume()` method.
@@ -677,7 +677,7 @@ already been bound to a port or domain socket.
Listening on a file descriptor is not supported on Windows.
This function is asynchronous. `callback` will be added as a listener for the
-`'listening'` event. See also [`net.Server.listen()`][].
+[`'listening'`][] event. See also [`net.Server.listen()`][].
Returns `server`.
@@ -689,7 +689,7 @@ added: v0.1.90
Start a UNIX socket server listening for connections on the given `path`.
This function is asynchronous. `callback` will be added as a listener for the
-`'listening'` event. See also [`net.Server.listen(path)`][].
+[`'listening'`][] event. See also [`net.Server.listen(path)`][].
### server.listen(port[, hostname][, backlog][, callback])
<!-- YAML
@@ -709,7 +709,7 @@ The actual length will be determined by your OS through sysctl settings such as
parameter is 511 (not 512).
This function is asynchronous. `callback` will be added as a listener for the
-`'listening'` event. See also [`net.Server.listen(port)`][].
+[`'listening'`][] event. See also [`net.Server.listen(port)`][].
### server.listening
<!-- YAML
@@ -1084,7 +1084,7 @@ added: v0.1.17
An `IncomingMessage` object is created by [`http.Server`][] or
[`http.ClientRequest`][] and passed as the first argument to the `'request'`
-and `'response'` event respectively. It may be used to access response status,
+and [`'response'`][] event respectively. It may be used to access response status,
headers and data.
It implements the [Readable Stream][] interface, as well as the
@@ -1264,7 +1264,7 @@ added: v0.1.90
Request URL string. This contains only the URL that is
present in the actual HTTP request. If the request is:
-```
+```txt
GET /status?name=ryan HTTP/1.1\r\n
Accept: text/plain\r\n
\r\n
@@ -1272,14 +1272,14 @@ Accept: text/plain\r\n
Then `request.url` will be:
-```
+```js
'/status?name=ryan'
```
If you would like to parse the URL into its parts, you can use
`require('url').parse(request.url)`. Example:
-```
+```txt
$ node
> require('url').parse('/status?name=ryan')
{
@@ -1294,7 +1294,7 @@ If you would like to extract the parameters from the query string,
you can use the `require('querystring').parse` function, or pass
`true` as the second argument to `require('url').parse`. Example:
-```
+```txt
$ node
> require('url').parse('/status?name=ryan', true)
{
@@ -1419,7 +1419,7 @@ Options:
function. See [`agent.createConnection()`][] for more details.
The optional `callback` parameter will be added as a one time listener for
-the `'response'` event.
+the [`'response'`][] event.
`http.request()` returns an instance of the [`http.ClientRequest`][]
class. The `ClientRequest` instance is a writable stream. If one needs to
@@ -1521,7 +1521,6 @@ There are a few special headers that should be noted.
[`socket.setKeepAlive()`]: net.html#net_socket_setkeepalive_enable_initialdelay
[`socket.setNoDelay()`]: net.html#net_socket_setnodelay_nodelay
[`socket.setTimeout()`]: net.html#net_socket_settimeout_timeout_callback
-[`stream.setEncoding()`]: stream.html#stream_stream_setencoding_encoding
[`TypeError`]: errors.html#errors_class_typeerror
[`url.parse()`]: url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost
[constructor options]: #http_new_agent_options
diff --git a/doc/api/modules.md b/doc/api/modules.md
index 836285b26f..9f6093aaec 100644
--- a/doc/api/modules.md
+++ b/doc/api/modules.md
@@ -143,7 +143,7 @@ the `require.resolve()` function.
Putting together all of the above, here is the high-level algorithm
in pseudocode of what require.resolve does:
-```
+```txt
require(X) from module at path Y
1. If X is a core module,
a. return the core module
@@ -244,7 +244,7 @@ Consider this situation:
`a.js`:
-```
+```js
console.log('a starting');
exports.done = false;
const b = require('./b.js');
@@ -255,7 +255,7 @@ console.log('a done');
`b.js`:
-```
+```js
console.log('b starting');
exports.done = false;
const a = require('./a.js');
@@ -266,7 +266,7 @@ console.log('b done');
`main.js`:
-```
+```js
console.log('main starting');
const a = require('./a.js');
const b = require('./b.js');
@@ -282,7 +282,7 @@ provided to the `a.js` module.
By the time `main.js` has loaded both modules, they're both finished.
The output of this program would thus be:
-```
+```txt
$ node main.js
main starting
a starting
@@ -336,7 +336,7 @@ The first is to create a `package.json` file in the root of the folder,
which specifies a `main` module. An example package.json file might
look like this:
-```
+```json
{ "name" : "some-library",
"main" : "./lib/some-library.js" }
```
@@ -351,7 +351,7 @@ Note: If the file specified by the `"main"` entry of `package.json` is missing
and can not be resolved, Node.js will report the entire module as missing with
the default error:
-```
+```txt
Error: Cannot find module 'some-library'
```
diff --git a/doc/api/net.md b/doc/api/net.md
index 876cf97ccf..e3160ff461 100644
--- a/doc/api/net.md
+++ b/doc/api/net.md
@@ -858,7 +858,7 @@ server.listen(8124, () => {
Test this by using `telnet`:
-```
+```sh
telnet localhost 8124
```
@@ -912,7 +912,7 @@ Returns true if input is a version 6 IP address, otherwise returns false.
[`'timeout'`]: #net_event_timeout
[`child_process.fork()`]: child_process.html#child_process_child_process_fork_modulepath_args_options
[`connect()`]: #net_socket_connect_options_connectlistener
-[`destroy()`]: #net_socket_destroy
+[`destroy()`]: #net_socket_destroy_exception
[`dns.lookup()`]: dns.html#dns_dns_lookup_hostname_options_callback
[`dns.lookup()` hints]: dns.html#dns_supported_getaddrinfo_flags
[`end()`]: #net_socket_end_data_encoding
diff --git a/doc/api/process.md b/doc/api/process.md
index d2f101419d..92b55b35ee 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -283,7 +283,7 @@ command-line option can be used to suppress the default console output but the
The following example illustrates the warning that is printed to `stderr` when
too many listeners have been added to an event
-```
+```txt
$ node
> event.defaultMaxListeners = 1;
> process.on('foo', () => {});
@@ -295,7 +295,7 @@ $ node
In contrast, the following example turns off the default warning output and
adds a custom handler to the `'warning'` event:
-```
+```txt
$ node --no-warnings
> var p = process.on('warning', (warning) => console.warn('Do not do that!'));
> event.defaultMaxListeners = 1;
@@ -467,7 +467,7 @@ process.argv.forEach((val, index) => {
Launching the Node.js process as:
-```
+```sh
$ node process-2.js one two=three four
```
@@ -645,7 +645,7 @@ It is possible to modify this object, but such modifications will not be
reflected outside the Node.js process. In other words, the following example
would not work:
-```
+```sh
$ node -e 'process.env.foo = "bar"' && echo $foo
```
@@ -703,7 +703,7 @@ process.emitWarning('Something happened!');
// Emits: (node: 56338) Warning: Something happened!
```
-```
+```js
// Emit a warning using a string and a name...
process.emitWarning('Something Happened!', 'CustomWarning');
// Emits: (node:56338) CustomWarning: Something Happened!
@@ -713,7 +713,7 @@ In each of the previous examples, an `Error` object is generated internally by
`process.emitWarning()` and passed through to the
[`process.on('warning')`][process_warning] event.
-```
+```js
process.on('warning', (warning) => {
console.warn(warning.name);
console.warn(warning.message);
@@ -725,7 +725,7 @@ If `warning` is passed as an `Error` object, it will be passed through to the
`process.on('warning')` event handler unmodified (and the optional `name`
and `ctor` arguments will be ignored):
-```
+```js
// Emit a warning using an Error object...
const myWarning = new Error('Warning! Something happened!');
myWarning.name = 'CustomWarning';
@@ -756,7 +756,7 @@ As a best practice, warnings should be emitted only once per process. To do
so, it is recommended to place the `emitWarning()` behind a simple boolean
flag as illustrated in the example below:
-```
+```js
var warned = false;
function emitMyWarning() {
if (!warned) {
@@ -784,7 +784,7 @@ the same execution environment as the parent.
For example:
-```
+```sh
$ node --harmony script.js --version
```
@@ -810,7 +810,7 @@ that started the Node.js process.
For example:
-```
+```sh
/usr/local/bin/node
```
@@ -1501,7 +1501,7 @@ To check if Node.js is being run in a [TTY][] context, check the `isTTY`
property on `process.stderr`, `process.stdout`, or `process.stdin`.
For instance:
-```
+```sh
$ node -p "Boolean(process.stdin.isTTY)"
true
$ echo "foo" | node -p "Boolean(process.stdin.isTTY)"
@@ -1664,11 +1664,10 @@ cases:
[`process.argv`]: #process_process_argv
[`process.exit()`]: #process_process_exit_code
[`process.kill()`]: #process_process_kill_pid_signal
-[`process.execPath`]: #process_process_execPath
+[`process.execPath`]: #process_process_execpath
[`promise.catch()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch
[`require.main`]: modules.html#modules_accessing_the_main_module
[`setTimeout(fn, 0)`]: timers.html#timers_settimeout_callback_delay_arg
-[child_process `'disconnect'` event]: child_process.html#child_process_event_disconnect
[process_emit_warning]: #process_process_emitwarning_warning_name_ctor
[process_warning]: #process_event_warning
[Signal Events]: #process_signal_events
diff --git a/doc/api/repl.md b/doc/api/repl.md
index 2be7e2b283..f74b40723c 100644
--- a/doc/api/repl.md
+++ b/doc/api/repl.md
@@ -324,7 +324,7 @@ replServer.defineCommand('saybye', function() {
The new commands can then be used from within the REPL instance:
-```
+```txt
> .sayhello Node.js User
Hello, Node.js User!
> .saybye
@@ -524,8 +524,6 @@ For an example of running a REPL instance over `curl(1)`,
see: https://gist.github.com/2053342
[stream]: stream.html
-[`readline.prompt`]: readline.html#readline_rl_prompt_preservecursor
[`util.inspect()`]: util.html#util_util_inspect_object_options
-[here]: util.html#util_custom_inspect_function_on_objects
[`readline.Interface`]: readline.html#readline_class_interface
[`readline.InterfaceCompleter`]: readline.html#readline_use_of_the_completer_function
diff --git a/doc/api/stream.md b/doc/api/stream.md
index 3365c8b9b7..b8541f2cf6 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -378,7 +378,7 @@ If the `writable.cork()` method is called multiple times on a stream, the same
number of calls to `writable.uncork()` must be called to flush the buffered
data.
-```
+```js
stream.cork();
stream.write('some ');
stream.cork();
@@ -408,7 +408,7 @@ first argument. To reliably detect write errors, add a listener for the
The return value indicates whether the written `chunk` was buffered internally
and the buffer has exceeded the `highWaterMark` configured when the stream was
created. If `false` is returned, further attempts to write data to the stream
-should be paused until the `'drain'` event is emitted.
+should be paused until the [`'drain'`][] event is emitted.
A Writable stream in object mode will always ignore the `encoding` argument.
@@ -622,7 +622,7 @@ rr.on('end', () => {
The output of running this script is:
-```
+```txt
$ node test.js
readable: null
end
@@ -1175,7 +1175,7 @@ write succeeded.
It is important to note that all calls to `writable.write()` that occur between
the time `writable._write()` is called and the `callback` is called will cause
the written data to be buffered. Once the `callback` is invoked, the stream will
-emit a `'drain'` event. If a stream implementation is capable of processing
+emit a [`'drain'`][] event. If a stream implementation is capable of processing
multiple chunks of data at once, the `writable._writev()` method should be
implemented.
@@ -1881,7 +1881,6 @@ readable buffer so there is nothing for a user to consume.
[`'end'`]: #stream_event_end
[`'finish'`]: #stream_event_finish
[`'readable'`]: #stream_event_readable
-[`buf.toString(encoding)`]: buffer.html#buffer_buf_tostring_encoding_start_end
[`EventEmitter`]: events.html#events_class_eventemitter
[`process.stderr`]: process.html#process_process_stderr
[`process.stdin`]: process.html#process_process_stdin
@@ -1891,7 +1890,6 @@ readable buffer so there is nothing for a user to consume.
[`stream.uncork()`]: #stream_writable_uncork
[`stream.unpipe()`]: #stream_readable_unpipe_destination
[`stream.wrap()`]: #stream_readable_wrap_stream
-[`tls.CryptoStream`]: tls.html#tls_class_cryptostream
[API for Stream Consumers]: #stream_api_for_stream_consumers
[API for Stream Implementers]: #stream_api_for_stream_implementers
[child process stdin]: child_process.html#child_process_child_stdin
@@ -1908,9 +1906,7 @@ readable buffer so there is nothing for a user to consume.
[HTTP requests, on the client]: http.html#http_class_http_clientrequest
[HTTP responses, on the server]: http.html#http_class_http_serverresponse
[http-incoming-message]: http.html#http_class_http_incomingmessage
-[Object mode]: #stream_object_mode
[Readable]: #stream_class_stream_readable
-[SimpleProtocol v2]: #stream_example_simpleprotocol_parser_v2
[stream-_flush]: #stream_transform_flush_callback
[stream-_read]: #stream_readable_read_size_1
[stream-_transform]: #stream_transform_transform_chunk_encoding_callback
diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md
index 35e8593d35..5e4e22a38b 100644
--- a/doc/api/synopsis.md
+++ b/doc/api/synopsis.md
@@ -32,7 +32,7 @@ server.listen(port, hostname, () => {
To run the server, put the code into a file called `example.js` and execute
it with Node.js:
-```
+```txt
$ node example.js
Server running at http://127.0.0.1:3000/
```
diff --git a/doc/api/timers.md b/doc/api/timers.md
index 6a97484c65..a311edd744 100644
--- a/doc/api/timers.md
+++ b/doc/api/timers.md
@@ -164,7 +164,7 @@ Cancels a `Timeout` object created by [`setTimeout()`][].
[the Node.js Event Loop]: https://github.com/nodejs/node/blob/master/doc/topics/the-event-loop-timers-and-nexttick.md
-[`TypeError`]: errors.html#errors_class_typerror
+[`TypeError`]: errors.html#errors_class_typeerror
[`clearImmediate()`]: timers.html#timers_clearimmediate_immediate
[`clearInterval()`]: timers.html#timers_clearinterval_timeout
[`clearTimeout()`]: timers.html#timers_cleartimeout_timeout
diff --git a/doc/api/tls.md b/doc/api/tls.md
index ca21905757..94dc78fbe7 100644
--- a/doc/api/tls.md
+++ b/doc/api/tls.md
@@ -19,7 +19,7 @@ Private keys can be generated in multiple ways. The example below illustrates
use of the OpenSSL command-line interface to generate a 2048-bit RSA private
key:
-```
+```sh
openssl genrsa -out ryans-key.pem 2048
```
@@ -33,7 +33,7 @@ step to obtaining a certificate is to create a *Certificate Signing Request*
The OpenSSL command-line interface can be used to generate a CSR for a private
key:
-```
+```sh
openssl req -new -sha256 -key ryans-key.pem -out ryans-csr.pem
```
@@ -43,14 +43,14 @@ Authority for signing or used to generate a self-signed certificate.
Creating a self-signed certificate using the OpenSSL command-line interface
is illustrated in the example below:
-```
+```sh
openssl x509 -req -in ryans-csr.pem -signkey ryans-key.pem -out ryans-cert.pem
```
Once the certificate is generated, it can be used to generate a `.pfx` or
`.p12` file:
-```
+```sh
openssl pkcs12 -export -in ryans-cert.pem -inkey ryans-key.pem \
-certfile ca-cert.pem -out ryans.pfx
```
@@ -92,7 +92,7 @@ To use Perfect Forward Secrecy using `DHE` with the `tls` module, it is required
to generate Diffie-Hellman parameters. The following illustrates the use of the
OpenSSL command-line interface to generate such parameters:
-```
+```sh
openssl dhparam -outform PEM -out dhparam.pem 2048
```
@@ -147,7 +147,7 @@ command-line client (`openssl s_client -connect address:port`) then input
Node.js is built with a default suite of enabled and disabled TLS ciphers.
Currently, the default cipher suite is:
-```
+```txt
ECDHE-RSA-AES128-GCM-SHA256:
ECDHE-ECDSA-AES128-GCM-SHA256:
ECDHE-RSA-AES256-GCM-SHA384:
@@ -175,7 +175,7 @@ This default can be replaced entirely using the `--tls-cipher-list` command
line switch. For instance, the following makes
`ECDHE-RSA-AES128-GCM-SHA256:!RC4` the default TLS cipher suite:
-```
+```sh
node --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4"
```
@@ -1128,7 +1128,7 @@ server.listen(8000, () => {
This server can be tested by connecting to it using `openssl s_client`:
-```
+```sh
openssl s_client -connect 127.0.0.1:8000
```
@@ -1176,7 +1176,7 @@ deprecated: v0.11.3
Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.
-Returned by `tls.createSecurePair()`.
+Returned by [`tls.createSecurePair()`][].
#### Event: 'secure'
<!-- YAML
@@ -1255,7 +1255,6 @@ where `secure_socket` has the same API as `pair.cleartext`.
[OpenSSL cipher list format documentation]: https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT
[Chrome's 'modern cryptography' setting]: https://www.chromium.org/Home/chromium-security/education/tls#TOC-Cipher-Suites
[specific attacks affecting larger AES key sizes]: https://www.schneier.com/blog/archives/2009/07/another_new_aes.html
-[BEAST attacks]: https://blog.ivanristic.com/2011/10/mitigating-the-beast-attack-on-tls.html
[`crypto.getCurves()`]: crypto.html#crypto_crypto_getcurves
[`tls.createServer()`]: #tls_tls_createserver_options_secureconnectionlistener
[`tls.createSecurePair()`]: #tls_tls_createsecurepair_context_isserver_requestcert_rejectunauthorized_options
@@ -1270,7 +1269,6 @@ where `secure_socket` has the same API as `pair.cleartext`.
[SSL_METHODS]: https://www.openssl.org/docs/ssl/ssl.html#DEALING-WITH-PROTOCOL-METHODS
[tls.Server]: #tls_class_tls_server
[SSL_CTX_set_timeout]: https://www.openssl.org/docs/ssl/SSL_CTX_set_timeout.html
-[RFC 4492]: https://www.rfc-editor.org/rfc/rfc4492.txt
[Forward secrecy]: https://en.wikipedia.org/wiki/Perfect_forward_secrecy
[DHE]: https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange
[ECDHE]: https://en.wikipedia.org/wiki/Elliptic_curve_Diffie%E2%80%93Hellman
diff --git a/doc/api/tty.md b/doc/api/tty.md
index ca5f2aacea..372f29b6ce 100644
--- a/doc/api/tty.md
+++ b/doc/api/tty.md
@@ -17,7 +17,7 @@ default be instances of `tty.WriteStream`. The preferred method of determining
whether Node.js is being run within a TTY context is to check that the value of
the `process.stdout.isTTY` property is `true`:
-```
+```sh
$ node -p -e "Boolean(process.stdout.isTTY)"
true
$ node -p -e "Boolean(process.stdout.isTTY)" | cat
@@ -106,5 +106,3 @@ added: v0.5.8
The `tty.isatty()` method returns `true` if the given `fd` is associated with
a TTY and `false` if is not.
-
-[tty.ReadStream#setRawMode]: #tty_readstream_setrawmode_mode
diff --git a/doc/api/url.md b/doc/api/url.md
index ea3075accd..76b0a3794d 100644
--- a/doc/api/url.md
+++ b/doc/api/url.md
@@ -19,7 +19,7 @@ The following details each of the components of a parsed URL. The example
`'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'` is used to
illustrate each.
-```
+```txt
┌─────────────────────────────────────────────────────────────────────────────┐
│ href │
├──────────┬┬───────────┬─────────────────┬───────────────────────────┬───────┤
@@ -241,7 +241,7 @@ URLs are only permitted to contain a certain range of characters. Spaces (`' '`)
and the following characters will be automatically escaped in the
properties of URL objects:
-```
+```txt
< > " ` \r \n \t { } | \ ^ '
```
diff --git a/doc/api/util.md b/doc/api/util.md
index 56ea9a474d..856e1f1584 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -20,7 +20,7 @@ The `util.debuglog()` method is used to create a function that conditionally
writes debug messages to `stderr` based on the existence of the `NODE_DEBUG`
environment variable. If the `section` name appears within the value of that
environment variable, then the returned function operates similar to
-`console.error()`. If not, then the returned function is a no-op.
+[`console.error()`][]. If not, then the returned function is a no-op.
For example:
@@ -34,7 +34,7 @@ debuglog('hello from foo [%d]', 123);
If this program is run with `NODE_DEBUG=foo` in the environment, then
it will output something like:
-```
+```txt
FOO 3245: hello from foo [123]
```
@@ -663,7 +663,6 @@ similar built-in functionality through [`Object.assign()`].
[constructor]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object/constructor
[semantically incompatible]: https://github.com/nodejs/node/issues/4179
[Customizing `util.inspect` colors]: #util_customizing_util_inspect_colors
-[here]: #util_customizing_util_inspect_colors
[`Error`]: errors.html#errors_class_error
[`console.log()`]: console.html#console_console_log_data
[`console.error()`]: console.html#console_console_error_data
diff --git a/doc/api/v8.md b/doc/api/v8.md
index a589a0fbb1..01a20defce 100644
--- a/doc/api/v8.md
+++ b/doc/api/v8.md
@@ -56,7 +56,7 @@ The value returned is an array of objects containing the following properties:
For example:
-```
+```json
[
{
"space_name": "new_space",
diff --git a/doc/api/vm.md b/doc/api/vm.md
index 0141ad605e..c774ebe6a4 100644
--- a/doc/api/vm.md
+++ b/doc/api/vm.md
@@ -395,7 +395,7 @@ local scope, so the value `localVar` is changed. In this way
## Example: Running an HTTP Server within a VM
-When using either `script.runInThisContext()` or `vm.runInThisContext()`, the
+When using either [`script.runInThisContext()`][] or [`vm.runInThisContext()`][], the
code is executed within the current V8 global context. The code passed
to this VM context will have its own isolated scope.
@@ -451,7 +451,6 @@ associating it with the `sandbox` object is what this document refers to as
[`script.runInThisContext()`]: #vm_script_runinthiscontext_options
[`vm.createContext()`]: #vm_vm_createcontext_sandbox
[`vm.runInContext()`]: #vm_vm_runincontext_code_contextifiedsandbox_options
-[`vm.runInNewContext()`]: #vm_vm_runinnewcontext_code_sandbox_options
[`vm.runInThisContext()`]: #vm_vm_runinthiscontext_code_options
[`eval()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval
[V8 Embedder's Guide]: https://developers.google.com/v8/embed#contexts
diff --git a/doc/api/zlib.md b/doc/api/zlib.md
index bddeead132..e421841d67 100644
--- a/doc/api/zlib.md
+++ b/doc/api/zlib.md
@@ -148,7 +148,7 @@ From `zlib/zconf.h`, modified to node.js's usage:
The memory requirements for deflate are (in bytes):
-```
+```js
(1 << (windowBits+2)) + (1 << (memLevel+9))
```
@@ -158,7 +158,7 @@ That is: 128K for windowBits=15 + 128K for memLevel = 8
For example, to reduce the default memory requirements from 256K to 128K, the
options shoud be set to:
-```
+```js
{ windowBits: 14, memLevel: 7 }
```
@@ -166,7 +166,7 @@ This will, however, generally degrade compression.
The memory requirements for inflate are (in bytes)
-```
+```js
1 << windowBits
```
@@ -386,7 +386,7 @@ added: v0.7.0
## zlib.constants
-Provides an object enumerating Zlib-related [constants][].
+Provides an object enumerating Zlib-related constants.
Reset the compressor/decompressor to factory defaults. Only applicable to
the inflate and deflate algorithms.
@@ -542,4 +542,3 @@ Decompress a Buffer or string with Unzip.
[Unzip]: #zlib_class_zlib_unzip
[`.flush()`]: #zlib_zlib_flush_kind_callback
[Buffer]: buffer.html
-[constants]: #constants_constants
diff --git a/doc/changelogs/CHANGELOG_V4.md b/doc/changelogs/CHANGELOG_V4.md
index f179806c58..061e503b14 100644
--- a/doc/changelogs/CHANGELOG_V4.md
+++ b/doc/changelogs/CHANGELOG_V4.md
@@ -133,7 +133,7 @@ This LTS release comes with 89 commits. This includes 46 commits that are docs r
* [[`c98aaf59bf`](https://github.com/nodejs/node/commit/c98aaf59bf)] - **http**: speed up checkIsHttpToken (Jackson Tian) [#4790](https://github.com/nodejs/node/pull/4790)
* [[`552e25cb6b`](https://github.com/nodejs/node/commit/552e25cb6b)] - **lib,test**: update in preparation for linter update (Rich Trott) [#6498](https://github.com/nodejs/node/pull/6498)
* [[`aaeeec4765`](https://github.com/nodejs/node/commit/aaeeec4765)] - **lib,test,tools**: alignment on variable assignments (Rich Trott) [#6869](https://github.com/nodejs/node/pull/6869)
-* [[`b3acbc5648`](https://github.com/nodejs/node/commit/b3acbc5648)] - **net**: replace __defineGetter__ with defineProperty (Fedor Indutny) [#6284](https://github.com/nodejs/node/pull/6284)
+* [[`b3acbc5648`](https://github.com/nodejs/node/commit/b3acbc5648)] - **net**: replace `__defineGetter__` with defineProperty (Fedor Indutny) [#6284](https://github.com/nodejs/node/pull/6284)
* [[`4c1eb5bf03`](https://github.com/nodejs/node/commit/4c1eb5bf03)] - **repl**: create history file with mode 0600 (Carl Lei) [#3394](https://github.com/nodejs/node/pull/3394)
* [[`90306bb81d`](https://github.com/nodejs/node/commit/90306bb81d)] - **src**: use size_t for http parser array size fields (Ben Noordhuis) [#5969](https://github.com/nodejs/node/pull/5969)
* [[`af41a63d0f`](https://github.com/nodejs/node/commit/af41a63d0f)] - **src**: replace ARRAY_SIZE with typesafe arraysize (Ben Noordhuis) [#5969](https://github.com/nodejs/node/pull/5969)
@@ -712,7 +712,7 @@ Notable semver patch changes include:
* [[`c9e2dce247`](https://github.com/nodejs/node/commit/c9e2dce247)] - **querystring**: improve parse() performance (Brian White) [#4675](https://github.com/nodejs/node/pull/4675)
* [[`18542c41fe`](https://github.com/nodejs/node/commit/18542c41fe)] - **repl**: remove variable redeclaration (Rich Trott) [#4977](https://github.com/nodejs/node/pull/4977)
* [[`10be8dc360`](https://github.com/nodejs/node/commit/10be8dc360)] - **src**: force line buffering for stderr (Rich Trott) [#3701](https://github.com/nodejs/node/pull/3701)
-* [[`7958664e85`](https://github.com/nodejs/node/commit/7958664e85)] - **src**: clean up usage of __proto__ (Jackson Tian) [#5069](https://github.com/nodejs/node/pull/5069)
+* [[`7958664e85`](https://github.com/nodejs/node/commit/7958664e85)] - **src**: clean up usage of `__proto__` (Jackson Tian) [#5069](https://github.com/nodejs/node/pull/5069)
* [[`4e0a0d51b3`](https://github.com/nodejs/node/commit/4e0a0d51b3)] - **src**: remove no longer relevant comments (Chris911) [#4843](https://github.com/nodejs/node/pull/4843)
* [[`51c8bc8abc`](https://github.com/nodejs/node/commit/51c8bc8abc)] - **src**: remove __builtin_bswap16 call (Ben Noordhuis) [#4290](https://github.com/nodejs/node/pull/4290)
* [[`5e1976e37c`](https://github.com/nodejs/node/commit/5e1976e37c)] - **src**: remove unused BITS_PER_LONG macro (Ben Noordhuis) [#4290](https://github.com/nodejs/node/pull/4290)
@@ -1533,7 +1533,7 @@ See https://github.com/nodejs/node/labels/confirmed-bug for complete and current
* [[`54795620f6`](https://github.com/nodejs/node/commit/54795620f6)] - **buffer**: don't abort on prototype getters (Trevor Norris) [#3302](https://github.com/nodejs/node/pull/3302)
* [[`660f7591c8`](https://github.com/nodejs/node/commit/660f7591c8)] - **buffer**: FreeCallback should be tied to ArrayBuffer (Fedor Indutny) [#3198](https://github.com/nodejs/node/pull/3198)
* [[`651a5b51eb`](https://github.com/nodejs/node/commit/651a5b51eb)] - **buffer**: only check if instance is Uint8Array (Trevor Norris) [#3080](https://github.com/nodejs/node/pull/3080)
-* [[`d5a1b1ad7c`](https://github.com/nodejs/node/commit/d5a1b1ad7c)] - **buffer**: clean up usage of __proto__ (Trevor Norris) [#3080](https://github.com/nodejs/node/pull/3080)
+* [[`d5a1b1ad7c`](https://github.com/nodejs/node/commit/d5a1b1ad7c)] - **buffer**: clean up usage of `__proto__` (Trevor Norris) [#3080](https://github.com/nodejs/node/pull/3080)
* [[`af24376e18`](https://github.com/nodejs/node/commit/af24376e18)] - **build**: Intl: deps: bump ICU to 56.1 (GA) (Steven R. Loomis) [#3281](https://github.com/nodejs/node/pull/3281)
* [[`9136359d57`](https://github.com/nodejs/node/commit/9136359d57)] - **build**: make icu download path customizable (Johan Bergström) [#3200](https://github.com/nodejs/node/pull/3200)
* [[`b3c5ad10a8`](https://github.com/nodejs/node/commit/b3c5ad10a8)] - **build**: add --with-arm-fpu option (Jérémy Lal) [#3228](https://github.com/nodejs/node/pull/3228)
diff --git a/doc/changelogs/CHANGELOG_V5.md b/doc/changelogs/CHANGELOG_V5.md
index d1e307df19..d8f61e16a8 100644
--- a/doc/changelogs/CHANGELOG_V5.md
+++ b/doc/changelogs/CHANGELOG_V5.md
@@ -159,7 +159,7 @@ This is a security release. All Node.js users should consult the security releas
* [[`a259ee4018`](https://github.com/nodejs/node/commit/a259ee4018)] - **http**: unref socket timer on parser execute (Fedor Indutny) [#6286](https://github.com/nodejs/node/pull/6286)
* [[`d4abca5b27`](https://github.com/nodejs/node/commit/d4abca5b27)] - **lib**: remove bootstrap global context indirection (Jeremiah Senkpiel) [#5881](https://github.com/nodejs/node/pull/5881)
* [[`c8783aff21`](https://github.com/nodejs/node/commit/c8783aff21)] - **lib,test,tools**: alignment on variable assignments (Rich Trott) [#6242](https://github.com/nodejs/node/pull/6242)
-* [[`d5d4f194f1`](https://github.com/nodejs/node/commit/d5d4f194f1)] - **net**: replace __defineGetter__ with defineProperty (Fedor Indutny) [#6284](https://github.com/nodejs/node/pull/6284)
+* [[`d5d4f194f1`](https://github.com/nodejs/node/commit/d5d4f194f1)] - **net**: replace `__defineGetter__` with defineProperty (Fedor Indutny) [#6284](https://github.com/nodejs/node/pull/6284)
* [[`6d9c0c9aa7`](https://github.com/nodejs/node/commit/6d9c0c9aa7)] - **(SEMVER-MINOR)** **net**: support DNS hints in createConnection() (Colin Ihrig) [#6000](https://github.com/nodejs/node/pull/6000)
* [[`457f24f19c`](https://github.com/nodejs/node/commit/457f24f19c)] - **(SEMVER-MINOR)** **node**: make builtin libs available for `--eval` (Anna Henningsen) [#6207](https://github.com/nodejs/node/pull/6207)
* [[`fc89d17656`](https://github.com/nodejs/node/commit/fc89d17656)] - **path**: fixing a test that breaks on some machines. (Mike Kaufman) [#6067](https://github.com/nodejs/node/pull/6067)
@@ -843,7 +843,7 @@ This is an important security release. All Node.js users should consult the secu
* [[`2844cc03dc`](https://github.com/nodejs/node/commit/2844cc03dc)] - **repl**: remove variable redeclaration (Rich Trott) [#4977](https://github.com/nodejs/node/pull/4977)
* [[`ac6627a0fe`](https://github.com/nodejs/node/commit/ac6627a0fe)] - **src**: avoid compiler warning in node_revert.cc (James M Snell)
* [[`459c5844c8`](https://github.com/nodejs/node/commit/459c5844c8)] - **(SEMVER-MINOR)** **src**: add --security-revert command line flag (James M Snell)
-* [[`95615196de`](https://github.com/nodejs/node/commit/95615196de)] - **src**: clean up usage of __proto__ (Jackson Tian) [#5069](https://github.com/nodejs/node/pull/5069)
+* [[`95615196de`](https://github.com/nodejs/node/commit/95615196de)] - **src**: clean up usage of `__proto__` (Jackson Tian) [#5069](https://github.com/nodejs/node/pull/5069)
* [[`e93b024214`](https://github.com/nodejs/node/commit/e93b024214)] - **src**: remove no longer relevant comments (Chris911) [#4843](https://github.com/nodejs/node/pull/4843)
* [[`a2c257a3ef`](https://github.com/nodejs/node/commit/a2c257a3ef)] - **src**: fix negative values in process.hrtime() (Ben Noordhuis) [#4757](https://github.com/nodejs/node/pull/4757)
* [[`b46f3b84d4`](https://github.com/nodejs/node/commit/b46f3b84d4)] - **src,deps**: replace LoadLibrary by LoadLibraryW (Cheng Zhao) [iojs/io.js#226](https://github.com/iojs/io.js/pull/226)
diff --git a/doc/changelogs/CHANGELOG_V6.md b/doc/changelogs/CHANGELOG_V6.md
index 0a6f372a5a..929d7a6cc1 100644
--- a/doc/changelogs/CHANGELOG_V6.md
+++ b/doc/changelogs/CHANGELOG_V6.md
@@ -408,7 +408,7 @@ October 2016.
* [[`4cc6a18448`](https://github.com/nodejs/node/commit/4cc6a18448)] - **test**: verify IPC messages are emitted on next tick (Santiago Gimeno) [#6909](https://github.com/nodejs/node/pull/6909)
* [[`69e119dbfb`](https://github.com/nodejs/node/commit/69e119dbfb)] - **test**: refactor spawnSync() cwd test (cjihrig) [#6939](https://github.com/nodejs/node/pull/6939)
* [[`32cc43a1bd`](https://github.com/nodejs/node/commit/32cc43a1bd)] - **test**: fix component printing on windows (Ben Noordhuis) [#6915](https://github.com/nodejs/node/pull/6915)
-* [[`c81b6f8d0d`](https://github.com/nodejs/node/commit/c81b6f8d0d)] - **test**: refactor to eliminate __defineGetter__ (Rich Trott) [#6774](https://github.com/nodejs/node/pull/6774)
+* [[`c81b6f8d0d`](https://github.com/nodejs/node/commit/c81b6f8d0d)] - **test**: refactor to eliminate `__defineGetter__` (Rich Trott) [#6774](https://github.com/nodejs/node/pull/6774)
* [[`1965e445ec`](https://github.com/nodejs/node/commit/1965e445ec)] - **test**: refactor test-tls-reuse-host-from-socket (Rich Trott) [#6756](https://github.com/nodejs/node/pull/6756)
* [[`2cf3a53ce1`](https://github.com/nodejs/node/commit/2cf3a53ce1)] - **test**: fix test-debug-port-cluster flakiness (Rich Trott) [#6769](https://github.com/nodejs/node/pull/6769)
* [[`5374afdef8`](https://github.com/nodejs/node/commit/5374afdef8)] - **test**: add logging for test-debug-port-cluster (Rich Trott) [#6769](https://github.com/nodejs/node/pull/6769)
@@ -519,7 +519,7 @@ running in big endian mode in addition to the existing 64-bit binaries for runni
* [[`2000072903`](https://github.com/nodejs/node/commit/2000072903)] - **handle_wrap**: IsRefed -> Unrefed, no isAlive check (Jeremiah Senkpiel) [#6204](https://github.com/nodejs/node/pull/6204)
* [[`d3132048cb`](https://github.com/nodejs/node/commit/d3132048cb)] - **(SEMVER-MINOR)** **handle_wrap**: expose an `isRefed()` check to JS (Jeremiah Senkpiel) [#5834](https://github.com/nodejs/node/pull/5834)
* [[`59666502c5`](https://github.com/nodejs/node/commit/59666502c5)] - **intl**: Don't crash if v8BreakIterator not available (Steven R. Loomis) [#4253](https://github.com/nodejs/node/pull/4253)
-* [[`74582aa590`](https://github.com/nodejs/node/commit/74582aa590)] - **lib**: replace legacy uses of __defineGetter__ (James M Snell) [#6768](https://github.com/nodejs/node/pull/6768)
+* [[`74582aa590`](https://github.com/nodejs/node/commit/74582aa590)] - **lib**: replace legacy uses of `__defineGetter__` (James M Snell) [#6768](https://github.com/nodejs/node/pull/6768)
* [[`559c2583e0`](https://github.com/nodejs/node/commit/559c2583e0)] - **lib,test**: update in preparation for linter update (Rich Trott) [#6498](https://github.com/nodejs/node/pull/6498)
* [[`226b9668db`](https://github.com/nodejs/node/commit/226b9668db)] - **(SEMVER-MINOR)** **repl**: copying tabs shouldn't trigger completion (Eugene Obrezkov) [#5958](https://github.com/nodejs/node/pull/5958)
* [[`ce2d5be4a1`](https://github.com/nodejs/node/commit/ce2d5be4a1)] - **(SEMVER-MINOR)** **repl**: exports `Recoverable` (Blake Embrey) [#3488](https://github.com/nodejs/node/pull/3488)
diff --git a/doc/ctc-meetings/2016-02-03.md b/doc/ctc-meetings/2016-02-03.md
index d44596dfd8..687cbe7ee7 100644
--- a/doc/ctc-meetings/2016-02-03.md
+++ b/doc/ctc-meetings/2016-02-03.md
@@ -180,7 +180,7 @@ James: If you’ve been holding off on it, I don’t really care about the name
Rod: Likely a two line comment at the top of all files.
-### @srl295: [path for full-icu data?](https://github.com/nodejs/node/issues/3460) - ./node_modules vs ./node/ ? (npm linkage)
+### @srl295: [path for full-icu data?](https://github.com/nodejs/node/issues/3460) - ./node_modules vs ./node/ ? (npm linkage)
Steven: Put together a proof of concept. Core question here is: is full-icu try to use a directory such as node_modules, or is that hijacking it for improper use [cd: unsure if I captured that correctly]
diff --git a/doc/ctc-meetings/2016-06-15.md b/doc/ctc-meetings/2016-06-15.md
index 3af642b840..4168b36131 100644
--- a/doc/ctc-meetings/2016-06-15.md
+++ b/doc/ctc-meetings/2016-06-15.md
@@ -137,8 +137,6 @@ replaces https://github.com/nodejs/node-eps/blob/master/002-es6-modules.md#51-de
This would be part of ECMA262 so browsers would do the same, but needs to be ironed out in TC39. On [agenda][TC39 Agenda] for 7/26 TC39 meeting.
-[TC39 Agenda]: https://github.com/tc39/agendas/blob/master/2016/07.md
-
What if nothing is imported or exported? Could do `export default null` to export nothing.
Starting off, preferred goal when preparing code would be CommonJS/script, later on could change to ES6/module.
@@ -173,3 +171,4 @@ None.
## Next Meeting
2016-06-22
+[TC39 Agenda]: https://github.com/tc39/agendas/blob/master/2016/07.md
diff --git a/doc/guides/building-node-with-ninja.md b/doc/guides/building-node-with-ninja.md
index eb5791af54..a9a3a922ed 100644
--- a/doc/guides/building-node-with-ninja.md
+++ b/doc/guides/building-node-with-ninja.md
@@ -9,7 +9,7 @@ To build Node with ninja, there are 3 steps that must be taken:
3. Lastly, make symlink to `./node` using `ln -fs out/Release/node node`.
When running `ninja -C out/Release` you will see output similar to the following if the build has succeeded:
-```
+```txt
ninja: Entering directory `out/Release`
[4/4] LINK node, POSTBUILDS
```
diff --git a/doc/onboarding-extras.md b/doc/onboarding-extras.md
index 5fc5424224..279bb38638 100644
--- a/doc/onboarding-extras.md
+++ b/doc/onboarding-extras.md
@@ -66,7 +66,7 @@ Please use these when possible / appropriate
* minor vs. patch: roughly: "does it add a new method / does it add a new section to the docs"
* major vs. everything else: run last versions tests against this version, if they pass, **probably** minor or patch
* A breaking change helper ([full source](https://gist.github.com/chrisdickinson/ba532fa0e4e243fb7b44)):
- ```
+ ```sh
git checkout $(git show -s --pretty='%T' $(git show-ref -d $(git describe --abbrev=0) | tail -n1 | awk '{print $1}')) -- test; make -j8 test
```
diff --git a/doc/releases.md b/doc/releases.md
index 8ea4484c2a..b5e57d1251 100644
--- a/doc/releases.md
+++ b/doc/releases.md
@@ -1,5 +1,4 @@
-Node.js Release Process
-=====================
+# Node.js Release Process
This document describes the technical aspects of the Node.js release process. The intended audience is those who have been authorized by the Node.js Foundation Technical Steering Committee (TSC) to create, promote, and sign official release builds for Node.js, hosted on <https://nodejs.org/>.
@@ -35,8 +34,8 @@ A SHASUMS256.txt file is produced for every promoted build, nightly, and release
The GPG keys should be fetchable from a known third-party keyserver. The SKS Keyservers at <https://sks-keyservers.net> are recommended. Use the [submission](https://sks-keyservers.net/i/#submit) form to submit a new GPG key. Keys should be fetchable via:
-```
-gpg --keyserver pool.sks-keyservers.net --recv-keys <FINGERPRINT>
+```sh
+$ gpg --keyserver pool.sks-keyservers.net --recv-keys <FINGERPRINT>
```
The key you use may be a child/subkey of an existing key.
@@ -56,7 +55,7 @@ Create a new branch named _"vx.y.z-proposal"_, or something similar. Using `git
For a list of commits that could be landed in a patch release on v5.x
-```
+```sh
$ branch-diff v5.x master --exclude-label=semver-major,semver-minor,dont-land-on-v5.x --filter-release --format=simple
```
@@ -66,7 +65,7 @@ Carefully review the list of commits looking for errors (incorrect `PR-URL`, inc
Set the version for the proposed release using the following macros, which are already defined in `src/node_version.h`:
-```
+```c
#define NODE_MAJOR_VERSION x
#define NODE_MINOR_VERSION y
#define NODE_PATCH_VERSION z
@@ -74,7 +73,7 @@ Set the version for the proposed release using the following macros, which are a
Set the `NODE_VERSION_IS_RELEASE` macro value to `1`. This causes the build to be produced with a version string that does not have a trailing pre-release tag:
-```
+```c
#define NODE_VERSION_IS_RELEASE 1
```
@@ -95,13 +94,13 @@ The general rule is to bump this version when there are _breaking ABI_ changes a
Collect a formatted list of commits since the last release. Use [`changelog-maker`](https://github.com/rvagg/changelog-maker) to do this.
-```
+```sh
$ changelog-maker --group
```
Note that changelog-maker counts commits since the last tag and if the last tag in the repository was not on the current branch you may have to supply a `--start-ref` argument:
-```
+```sh
$ changelog-maker --group --start-ref v2.3.1
```
@@ -117,8 +116,8 @@ file in the release branch (e.g. a release for Node.js v4 would be added to the
The new entry should take the following form:
-```
-<a id="x.y.x></a>"
+```md
+<a id="x.y.x"></a>
## YYYY-MM-DD, Version x.y.z (Release Type), @releaser
### Notable changes
@@ -161,7 +160,7 @@ The `CHANGELOG.md`, `doc/changelogs/CHANGELOG_*.md`, `src/node_version.h`, and
`REPLACEME` changes should be the final commit that will be tagged for the
release. When committing these to git, use the following message format:
-```
+```txt
YYYY-MM-DD, Version x.y.z (Release Type)
Notable changes:
@@ -219,7 +218,7 @@ Tag summaries have a predictable format, look at a recent tag to see, `git tag -
Create a tag using the following command:
-```
+```sh
$ git tag <vx.y.z> <commit-sha> -sm 'YYYY-MM-DD Node.js vx.y.z (Release Type) Release'
```
@@ -227,7 +226,7 @@ The tag **must** be signed using the GPG key that's listed for you on the projec
Push the tag to the repo before you promote the builds. If you haven't pushed your tag first, then build promotion won't work properly. Push the tag using the following command:
-```
+```sh
$ git push <remote> <vx.y.z>
```
@@ -240,7 +239,7 @@ On release proposal branch, edit `src/node_version.h` again and:
Commit this change with the following commit message format:
-```
+```txt
Working on vx.y.z # where 'z' is the incremented patch number
PR-URL: <full URL to your release proposal PR>
diff --git a/doc/topics/blocking-vs-non-blocking.md b/doc/topics/blocking-vs-non-blocking.md
index 788887ae3b..606371789e 100644
--- a/doc/topics/blocking-vs-non-blocking.md
+++ b/doc/topics/blocking-vs-non-blocking.md
@@ -6,7 +6,7 @@ prior knowledge of those topics is required. Readers are assumed to have a
basic understanding of the JavaScript language and Node.js callback pattern.
> "I/O" refers primarily to interaction with the system's disk and
-network supported by [libuv](http://libuv.org/).
+> network supported by [libuv](http://libuv.org/).
## Blocking
diff --git a/doc/topics/domain-postmortem.md b/doc/topics/domain-postmortem.md
index c33c85b430..e03012db92 100644
--- a/doc/topics/domain-postmortem.md
+++ b/doc/topics/domain-postmortem.md
@@ -298,4 +298,4 @@ proposal for Zones being prepared for the TC39. At such time there is suitable
functionality to replace domains it will undergo the full deprecation cycle and
eventually be removed from core.
-[domain-resource-cleanup-example.js]: ./domain-resource-cleanup-example.js
+[`domain-resource-cleanup-example.js`]: ./domain-resource-cleanup-example.js
diff --git a/doc/tsc-meetings/io.js/2014-12-10.md b/doc/tsc-meetings/io.js/2014-12-10.md
index 8bbfdfed10..a28ad644a5 100644
--- a/doc/tsc-meetings/io.js/2014-12-10.md
+++ b/doc/tsc-meetings/io.js/2014-12-10.md
@@ -130,7 +130,7 @@ https://github.com/nodejs/io.js/issues/11
* Chris: +0
-### Working with nvm, nvmw and similar installation managers
+### Working with nvm, nvmw and similar installation managers
https://github.com/nodejs/io.js/issues/40