Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: remove URLs from zlib and tls docs #28580

Merged
merged 2 commits into from
Jul 8, 2019
Merged

doc: remove URLs from zlib and tls docs #28580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29676f4
doc: make tls links more readable
cjihrig Jul 6, 2019
4742e4d
doc: remove URLs from zlib docs
cjihrig Jul 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/api/tls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1011,8 +1011,7 @@ Protocol versions are:
* `'TLSv1.2'`
* `'TLSv1.3'`

See <https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html> for more
information.
See the OpenSSL [`SSL_get_version`][] documentation for more information.

### tlsSocket.getSession()
<!-- YAML
Expand Down Expand Up @@ -1477,9 +1476,8 @@ and [`server.addContext()`][], but has no public methods.
A key is *required* for ciphers that make use of certificates. Either `key` or
`pfx` can be used to provide it.

If the 'ca' option is not given, then Node.js will use the default
publicly trusted list of CAs as given in
<https://hg.mozilla.org/mozilla-central/raw-file/tip/security/nss/lib/ckfw/builtins/certdata.txt>.
If the `ca` option is not given, then Node.js will default to using
[Mozilla's publicly trusted list of CAs][].

## tls.createServer([options][, secureConnectionListener])
<!-- YAML
Expand Down Expand Up @@ -1769,6 +1767,7 @@ where `secureSocket` has the same API as `pair.cleartext`.
[`'session'`]: #tls_event_session
[`--tls-cipher-list`]: cli.html#cli_tls_cipher_list_list
[`NODE_OPTIONS`]: cli.html#cli_node_options_options
[`SSL_get_version`]: https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html
[`crypto.getCurves()`]: crypto.html#crypto_crypto_getcurves
[`net.createServer()`]: net.html#net_net_createserver_options_connectionlistener
[`net.Server.address()`]: net.html#net_server_address
Expand Down Expand Up @@ -1799,6 +1798,7 @@ where `secureSocket` has the same API as `pair.cleartext`.
[DHE]: https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange
[ECDHE]: https://en.wikipedia.org/wiki/Elliptic_curve_Diffie%E2%80%93Hellman
[Forward secrecy]: https://en.wikipedia.org/wiki/Perfect_forward_secrecy
[Mozilla's publicly trusted list of CAs]: https://hg.mozilla.org/mozilla-central/raw-file/tip/security/nss/lib/ckfw/builtins/certdata.txt
[OCSP request]: https://en.wikipedia.org/wiki/OCSP_stapling
[OpenSSL Options]: crypto.html#crypto_openssl_options
[Perfect Forward Secrecy]: #tls_perfect_forward_secrecy
Expand Down
8 changes: 4 additions & 4 deletions doc/api/zlib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,7 @@ All of the constants defined in `zlib.h` are also defined on
`require('zlib').constants`. In the normal course of operations, it will not be
necessary to use these constants. They are documented so that their presence is
not surprising. This section is taken almost directly from the
[zlib documentation][]. See <https://zlib.net/manual.html#Constants> for more
details.
[zlib documentation][].

Previously, the constants were available directly from `require('zlib')`, for
instance `zlib.Z_NO_FLUSH`. Accessing the constants directly from the module is
Expand Down Expand Up @@ -408,8 +407,8 @@ ignored by the decompression classes.
empty dictionary by default)
* `info` {boolean} (If `true`, returns an object with `buffer` and `engine`.)

See the description of `deflateInit2` and `inflateInit2` at
<https://zlib.net/manual.html#Advanced> for more information on these.
See the [`deflateInit2` and `inflateInit2`][] documentation for more
information.

## Class: BrotliOptions
<!-- YAML
Expand Down Expand Up @@ -1039,6 +1038,7 @@ Decompress a chunk of data with [`Unzip`][].
[`Inflate`]: #zlib_class_zlib_inflate
[`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[`Unzip`]: #zlib_class_zlib_unzip
[`deflateInit2` and `inflateInit2`]: https://zlib.net/manual.html#Advanced
[`stream.Transform`]: stream.html#stream_class_stream_transform
[`zlib.bytesWritten`]: #zlib_zlib_byteswritten
[Brotli parameters]: #zlib_brotli_constants
Expand Down