Skip to content

Commit b283a31

Browse files
authored
Correct mention of the tls-native-tls in the documentation. (launchbadge#2593)
1 parent a87a871 commit b283a31

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -134,14 +134,14 @@ For the previous stable release, 0.6.3, see [the previous version of this docume
134134
# tokio (no TLS)
135135
sqlx = { version = "0.7", features = [ "runtime-tokio" ] }
136136
# tokio + native-tls
137-
sqlx = { version = "0.7", features = [ "runtime-tokio", "tls-native" ] }
137+
sqlx = { version = "0.7", features = [ "runtime-tokio", "tls-native-tls" ] }
138138
# tokio + rustls
139139
sqlx = { version = "0.7", features = [ "runtime-tokio", "tls-rustls" ] }
140140

141141
# async-std (no TLS)
142142
sqlx = { version = "0.7", features = [ "runtime-async-std" ] }
143143
# async-std + native-tls
144-
sqlx = { version = "0.7", features = [ "runtime-async-std", "tls-native" ] }
144+
sqlx = { version = "0.7", features = [ "runtime-async-std", "tls-native-tls" ] }
145145
# async-std + rustls
146146
sqlx = { version = "0.7", features = [ "runtime-async-std", "tls-rustls" ] }
147147
```
@@ -168,7 +168,7 @@ be removed in the future.
168168

169169
- Actix-web is fully compatible with Tokio and so a separate runtime feature is no longer needed.
170170

171-
- `tls-native`: Use the `native-tls` TLS backend (OpenSSL on *nix, SChannel on Windows, Secure Transport on macOS).
171+
- `tls-native-tls`: Use the `native-tls` TLS backend (OpenSSL on *nix, SChannel on Windows, Secure Transport on macOS).
172172

173173
- `tls-rustls`: Use the `rustls` TLS backend (cross-platform backend, only supports TLS 1.2 and 1.3).
174174

src/lib.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ internal management tasks.
3030
For securely communicating with SQL servers over an untrusted network connection such as the internet,
3131
you can enable Transport Layer Security (TLS) by enabling one of the following features:
3232

33-
* `tls-native`: Enables the [`native-tls`] backend which uses the OS-native TLS capabilities:
33+
* `tls-native-tls`: Enables the [`native-tls`] backend which uses the OS-native TLS capabilities:
3434
* SecureTransport on macOS.
3535
* SChannel on Windows.
3636
* OpenSSL on all other platforms.
3737
* `tls-rustls`: Enables the [RusTLS] backend, a crossplatform TLS library.
3838
* Only supports TLS revisions 1.2 and 1.3.
3939
* If you get `HandshakeFailure` errors when using this feature, it likely means your database server does not support
40-
these newer revisions. This might be resolved by enabling or switching to the `tls-native` feature.
40+
these newer revisions. This might be resolved by enabling or switching to the `tls-native-tls` feature.
4141

42-
If more than one TLS feature is enabled, the `tls-native` feature takes precedent so that it is only necessary to enable
42+
If more than one TLS feature is enabled, the `tls-native-tls` feature takes precedent so that it is only necessary to enable
4343
it to see if it resolves the `HandshakeFailure` error without disabling `tls-rustls`.
4444

4545
Consult the user manual for your database to find the TLS versions it supports.

0 commit comments

Comments
 (0)