Skip to content

Commit f97c9e2

Browse files
authored
fix: update descriptions of https and server options (#4094)
1 parent 97a8b18 commit f97c9e2

7 files changed

+127
-129
lines changed

README.md

+18-20
Original file line numberDiff line numberDiff line change
@@ -119,40 +119,38 @@ Options:
119119
--host <value> Allows to specify a hostname to use.
120120
--hot [value] Enables Hot Module Replacement.
121121
--no-hot Disables Hot Module Replacement.
122-
--http2 Allows to serve over HTTP/2 using SPDY. Deprecated, it will be removed in favor of the `server` option.
122+
--http2 Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.
123123
--no-http2 Does not serve over HTTP/2 using SPDY.
124-
--https Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, it will be removed in favor
125-
of the `server` option.
124+
--https Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the `server` option.
126125
--no-https Disallows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).
127-
--https-passphrase <value> Passphrase for a pfx file. Deprecated, it will be removed in favor of the `server.options.passphrase` option.
128-
--https-request-cert Request for an SSL certificate. Deprecated, it will be removed in favor of the `server.options.requestCert`
129-
option.
126+
--https-passphrase <value> Passphrase for a pfx file. Deprecated, use the `server.options.passphrase` option.
127+
--https-request-cert Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option.
130128
--no-https-request-cert Negative 'https-request-cert' option.
131-
--https-ca <value...> Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, it will be removed in favor of the
129+
--https-ca <value...> Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the
132130
`server.options.ca` option.
133131
--https-ca-reset Clear all items provided in 'https.ca' configuration. Path to an SSL CA certificate or content of an SSL CA
134-
certificate. Deprecated, it will be removed in favor of the `server.options.ca` option.
135-
--https-cacert <value...> Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, it will be removed in favor of the
132+
certificate. Deprecated, use the `server.options.ca` option.
133+
--https-cacert <value...> Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the
136134
`server.options.cacert` option.
137135
--https-cacert-reset Clear all items provided in 'https.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA
138-
certificate. Deprecated, it will be removed in favor of the `server.options.cacert` option.
139-
--https-cert <value...> Path to an SSL certificate or content of an SSL certificate. Deprecated, it will be removed in favor of the
136+
certificate. Deprecated, use the `server.options.cacert` option.
137+
--https-cert <value...> Path to an SSL certificate or content of an SSL certificate. Deprecated, use the
140138
`server.options.cert` option.
141139
--https-cert-reset Clear all items provided in 'https.cert' configuration. Path to an SSL certificate or content of an SSL
142-
certificate. Deprecated, it will be removed in favor of the `server.options.cert` option.
140+
certificate. Deprecated, use the `server.options.cert` option.
143141
--https-crl <value...> Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate
144-
Revocation Lists). Deprecated, it will be removed in favor of the `server.options.crl` option.
142+
Revocation Lists). Deprecated, use the `server.options.crl` option.
145143
--https-crl-reset Clear all items provided in 'https.crl' configuration. Path to PEM formatted CRLs (Certificate Revocation Lists)
146-
or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, it will be removed in favor of the
144+
or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the
147145
`server.options.crl` option.
148-
--https-key <value...> Path to an SSL key or content of an SSL key. Deprecated, it will be removed in favor of the `server.options.key`
146+
--https-key <value...> Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key`
149147
option.
150148
--https-key-reset Clear all items provided in 'https.key' configuration. Path to an SSL key or content of an SSL key. Deprecated,
151-
it will be removed in favor of the `server.options.key` option.
152-
--https-pfx <value...> Path to an SSL pfx file or content of an SSL pfx file. Deprecated, it will be removed in favor of the
149+
use the `server.options.key` option.
150+
--https-pfx <value...> Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the
153151
`server.options.pfx` option.
154152
--https-pfx-reset Clear all items provided in 'https.pfx' configuration. Path to an SSL pfx file or content of an SSL pfx file.
155-
Deprecated, it will be removed in favor of the `server.options.pfx` option.
153+
Deprecated, use the `server.options.pfx` option.
156154
--ipc [value] Listen to a unix socket.
157155
--live-reload Enables reload/refresh the page(s) when file changes are detected (enabled by default).
158156
--no-live-reload Disables reload/refresh the page(s) when file changes are detected (enabled by default)
@@ -174,9 +172,9 @@ Options:
174172
--server-options-ca <value...> Path to an SSL CA certificate or content of an SSL CA certificate.
175173
--server-options-ca-reset Clear all items provided in 'server.options.ca' configuration. Path to an SSL CA certificate or content
176174
of an SSL CA certificate.
177-
--server-options-cacert <value...> Path to an SSL CA certificate or content of an SSL CA certificate.
175+
--server-options-cacert <value...> Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
178176
--server-options-cacert-reset Clear all items provided in 'server.options.cacert' configuration. Path to an SSL CA certificate or
179-
content of an SSL CA certificate.
177+
content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
180178
--server-options-cert <value...> Path to an SSL certificate or content of an SSL certificate.
181179
--server-options-cert-reset Clear all items provided in 'server.options.cert' configuration. Path to an SSL certificate or content
182180
of an SSL certificate.

0 commit comments

Comments
 (0)