Skip to content

Commit 2824527

Browse files
TrottMylesBorins
authored andcommitted
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: #31326 Refs: #31073 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent baeabff commit 2824527

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/api/tls.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ called:
545545
added: v0.5.3
546546
-->
547547

548-
* `hostname` {string} A SNI hostname or wildcard (e.g. `'*'`)
548+
* `hostname` {string} A SNI host name or wildcard (e.g. `'*'`)
549549
* `context` {Object} An object containing any of the possible properties
550550
from the [`tls.createSecureContext()`][] `options` arguments (e.g. `key`,
551551
`cert`, `ca`, etc).
@@ -1308,7 +1308,7 @@ changes:
13081308
with optional identity `hint` provided by the server or `null`
13091309
in case of TLS 1.3 where `hint` was removed.
13101310
It will be necessary to provide a custom `tls.checkServerIdentity()`
1311-
for the connection as the default one will try to check hostname/IP
1311+
for the connection as the default one will try to check host name/IP
13121312
of the server against the certificate but that's not applicable for PSK
13131313
because there won't be a certificate present.
13141314
More information can be found in the [RFC 4279][].
@@ -1328,7 +1328,7 @@ changes:
13281328
`SNICallback` option to [`tls.createServer()`][].
13291329
* `checkServerIdentity(servername, cert)` {Function} A callback function
13301330
to be used (instead of the builtin `tls.checkServerIdentity()` function)
1331-
when checking the server's hostname (or the provided `servername` when
1331+
when checking the server's host name (or the provided `servername` when
13321332
explicitly set) against the certificate. This should return an {Error} if
13331333
verification fails. The method should return `undefined` if the `servername`
13341334
and `cert` are verified.

0 commit comments

Comments
 (0)