From 788ea985e6a7211e8347e6935548917095b48823 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sun, 12 Jan 2020 07:57:16 -0800 Subject: [PATCH] doc: standardize on "host name" in tls.md Our docs have a mix of "hostname" and "host name" in prose. Let's follow the usage of Unix man pages, RFCs, and most professionally-edited sources, and use "host name" in prose and "hostname" to refer to the command and in code. Lint rule forthcoming. PR-URL: https://github.com/nodejs/node/pull/31326 Refs: https://github.com/nodejs/node/pull/31073 Reviewed-By: Luigi Pinca Reviewed-By: Richard Lau Reviewed-By: James M Snell Reviewed-By: Trivikram Kamat --- doc/api/tls.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/tls.md b/doc/api/tls.md index 2eaaab5a851821..51f5cf9b4adf1b 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -545,7 +545,7 @@ called: added: v0.5.3 --> -* `hostname` {string} A SNI hostname or wildcard (e.g. `'*'`) +* `hostname` {string} A SNI host name or wildcard (e.g. `'*'`) * `context` {Object} An object containing any of the possible properties from the [`tls.createSecureContext()`][] `options` arguments (e.g. `key`, `cert`, `ca`, etc). @@ -1308,7 +1308,7 @@ changes: with optional identity `hint` provided by the server or `null` in case of TLS 1.3 where `hint` was removed. It will be necessary to provide a custom `tls.checkServerIdentity()` - for the connection as the default one will try to check hostname/IP + for the connection as the default one will try to check host name/IP of the server against the certificate but that's not applicable for PSK because there won't be a certificate present. More information can be found in the [RFC 4279][]. @@ -1328,7 +1328,7 @@ changes: `SNICallback` option to [`tls.createServer()`][]. * `checkServerIdentity(servername, cert)` {Function} A callback function to be used (instead of the builtin `tls.checkServerIdentity()` function) - when checking the server's hostname (or the provided `servername` when + when checking the server's host name (or the provided `servername` when explicitly set) against the certificate. This should return an {Error} if verification fails. The method should return `undefined` if the `servername` and `cert` are verified.