From 816e92e6968fe6b48f16f12f53736ffa797682b1 Mon Sep 17 00:00:00 2001 From: Richard Lau Date: Wed, 20 Oct 2021 22:57:11 +0100 Subject: [PATCH] doc: update for changed `--dns-result-order` default MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update documentation to match the changed `--dns-result-order` default value in Node.js 17. Refs: https://github.com/nodejs/node/pull/39987 PR-URL: https://github.com/nodejs/node/pull/40538 Reviewed-By: Antoine du Hamel Reviewed-By: Colin Ihrig Reviewed-By: Michaël Zasso Reviewed-By: Rich Trott --- doc/api/cli.md | 6 +++++- doc/api/dns.md | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/api/cli.md b/doc/api/cli.md index 7f97e50afd3027..c01b397e83615f 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -207,6 +207,10 @@ code from strings throw an exception instead. This does not affect the Node.js added: - v16.4.0 - v14.18.0 +changes: + - version: v17.0.0 + pr-url: https://github.com/nodejs/node/pull/39987 + description: Changed default value to `verbatim`. --> Set the default value of `verbatim` in [`dns.lookup()`][] and @@ -215,7 +219,7 @@ Set the default value of `verbatim` in [`dns.lookup()`][] and * `ipv4first`: sets default `verbatim` `false`. * `verbatim`: sets default `verbatim` `true`. -The default is `ipv4first` and [`dns.setDefaultResultOrder()`][] have higher +The default is `verbatim` and [`dns.setDefaultResultOrder()`][] have higher priority than `--dns-result-order`. ### `--enable-fips` diff --git a/doc/api/dns.md b/doc/api/dns.md index 63d0fbba9ab91c..bcbdeb9bbb7c4d 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -202,7 +202,7 @@ changes: * `verbatim` {boolean} When `true`, the callback receives IPv4 and IPv6 addresses in the order the DNS resolver returned them. When `false`, IPv4 addresses are placed before IPv6 addresses. - **Default:** `true` (addresses are reordered). Default value is + **Default:** `true` (addresses are not reordered). Default value is configurable using [`dns.setDefaultResultOrder()`][] or [`--dns-result-order`][]. * `callback` {Function}