doc: fix comment on WebPKI and platform verifier

Since the webpki crate is a specific implementation (which is chosen by the platform verifier crate on some platforms), it was confusing to call it out by name. Instead, simplify the comment to say it uses "the default behavior for the current platform."
rustls · Jul 30, 2024 · 311fba1 · 311fba1
1 parent 493ee05
commit 311fba1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/src/cipher.rs b/src/cipher.rs
@@ -1055,8 +1055,9 @@ box_castable! {
 }
 
 impl rustls_server_cert_verifier {
-    /// Create a new server certificate verifier that uses the system's root store and WebPKI via
-    /// [`rustls-platform-verifier`][].
+    /// Create a verifier that uses the default behavior for the current platform.
+    ///
+    /// This uses [`rustls-platform-verifier`][].
     ///
     /// The verifier can be used in several `rustls_client_config` instances and must be freed by
     /// the application using `rustls_server_cert_verifier_free` when no longer needed.

diff --git a/src/rustls.h b/src/rustls.h
@@ -1257,8 +1257,9 @@ rustls_result rustls_web_pki_server_cert_verifier_builder_build(struct rustls_we
 void rustls_web_pki_server_cert_verifier_builder_free(struct rustls_web_pki_server_cert_verifier_builder *builder);
 
 /**
- * Create a new server certificate verifier that uses the system's root store and WebPKI via
- * [`rustls-platform-verifier`][].
+ * Create a verifier that uses the default behavior for the current platform.
+ *
+ * This uses [`rustls-platform-verifier`][].
  *
  * The verifier can be used in several `rustls_client_config` instances and must be freed by
  * the application using `rustls_server_cert_verifier_free` when no longer needed.