Skip to content

Commit 22ee5a5

Browse files
committed
docs: update README for dependency selection
1 parent d37d6a9 commit 22ee5a5

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

README.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -265,29 +265,39 @@ Build options:
265265

266266
Dependency options:
267267

268-
* `USE_SSH=type`: enables SSH support; `type` can be set to `libssh2`
269-
or `exec` (which will execute an external OpenSSH command)
270-
* `USE_HTTPS=type`: enables HTTPS support; `type` can be set to
271-
`OpenSSL`, `mbedTLS`, `SecureTransport`, `Schannel`, or `WinHTTP`;
272-
the default is `SecureTransport` on macOS, `WinHTTP` on Windows, and
273-
whichever of `OpenSSL` or `mbedTLS` is detected on other platforms.
268+
* `USE_SSH=type`: enables SSH support and optionally selects the provider;
269+
`type` can be set to `libssh2` or `exec` (which will execute an external
270+
OpenSSH command). `ON` implies `libssh2`; defaults to `OFF`.
271+
* `USE_HTTPS=type`: enables HTTPS support and optionally selects the
272+
provider; `type` can be set to `OpenSSL`, `OpenSSL-Dynamic` (to not
273+
link against OpenSSL, but load it dynamically), `SecureTransport`,
274+
`Schannel` or `WinHTTP`; the default is `SecureTransport` on macOS,
275+
`WinHTTP` on Windows, and whichever of `OpenSSL` or `mbedTLS` is
276+
detected on other platforms. Defaults to `ON`.
274277
* `USE_SHA1=type`: selects the SHA1 mechanism to use; `type` can be set
275-
to `CollisionDetection` (default), or `HTTPS` to use the HTTPS
276-
driver specified above as the hashing provider.
278+
to `CollisionDetection`, `HTTPS` to use the system or HTTPS provider,
279+
or one of `OpenSSL`, `OpenSSL-Dynamic`, `OpenSSL-FIPS` (to use FIPS
280+
compliant routines in OpenSSL), `CommonCrypto`, or `Schannel`.
281+
Defaults to `CollisionDetection`. This option is retained for
282+
backward compatibility and should not be changed.
277283
* `USE_SHA256=type`: selects the SHA256 mechanism to use; `type` can be
278-
set to `HTTPS` (default) to use the HTTPS driver specified above as
279-
the hashing provider, or `Builtin`.
284+
set to `HTTPS` to use the system or HTTPS driver, `builtin`, or one of
285+
`OpenSSL`, `OpenSSL-Dynamic`, `OpenSSL-FIPS` (to use FIPS compliant
286+
routines in OpenSSL), `CommonCrypto`, or `Schannel`. Defaults to `HTTPS`.
280287
* `USE_GSSAPI=<on/off>`: enables GSSAPI for SPNEGO authentication on
281-
Unix
288+
Unix. Defaults to `OFF`.
282289
* `USE_HTTP_PARSER=type`: selects the HTTP Parser; either `http-parser`
283290
for an external
284291
[`http-parser`](https://github.com/nodejs/http-parser) dependency,
285292
`llhttp` for an external [`llhttp`](https://github.com/nodejs/llhttp)
286-
dependency, or `builtin`
293+
dependency, or `builtin`. Defaults to `builtin`.
287294
* `REGEX_BACKEND=type`: selects the regular expression backend to use;
288-
one of `regcomp_l`, `pcre2`, `pcre`, `regcomp`, or `builtin`.
289-
* `USE_BUNDLED_ZLIB=type`: selects the zlib dependency to use; one of
290-
`bundled` or `Chromium`.
295+
one of `regcomp_l`, `pcre2`, `pcre`, `regcomp`, or `builtin`. The
296+
default is to use `regcomp_l` where available, PCRE if found, otherwise,
297+
to use the builtin.
298+
* `USE_BUNDLED_ZLIB=type`: selects the bundled zlib; either `ON` or `OFF`.
299+
Defaults to using the system zlib if available, falling back to the
300+
bundled zlib.
291301

292302
Locating Dependencies
293303
---------------------

0 commit comments

Comments
 (0)