CDRIVER-3436 Document "ssl" APIs use TLS protocols (#1786)

* note only TLS protocols are supported

Author: kevinAlbs

src/libmongoc/doc/conf.py

@@ -223,6 +223,9 @@ def _maybe_update_inventories(app: Sphinx):
 
 .. _bson_lifetimes: https://www.mongodb.com/docs/languages/c/c-driver/current/libbson/guides/lifetimes/
 
+.. |ssl:naming| replace::
+    Though some API names include the term "ssl", the C driver only support TLS protocols, which supersede SSL.
+
 """
 
 

src/libmongoc/doc/mongoc_client_pool_set_ssl_opts.rst

@@ -14,18 +14,21 @@ Synopsis
                                    const mongoc_ssl_opt_t *opts);
   #endif
 
+.. note::
+   |ssl:naming|
+
 This function is identical to :symbol:`mongoc_client_set_ssl_opts()` except for
 client pools. It ensures that all clients retrieved from
 :symbol:`mongoc_client_pool_pop()` or :symbol:`mongoc_client_pool_try_pop()`
-are configured with the same SSL settings.
+are configured with the same TLS settings.
 
-The ``mongoc_ssl_opt_t`` struct is copied by the pool along with the strings
+The :symbol:`mongoc_ssl_opt_t` struct is copied by the pool along with the strings
 it points to (``pem_file``, ``pem_pwd``, ``ca_file``, ``ca_dir``, and
 ``crl_file``) so they don't have to remain valid after the call to
-``mongoc_client_pool_set_ssl_opts``.
+:symbol:`mongoc_client_pool_set_ssl_opts`.
 
-A call to ``mongoc_client_pool_set_ssl_opts`` overrides all TLS options set
-through the connection string with which the ``mongoc_client_pool_t`` was
+A call to :symbol:`mongoc_client_pool_set_ssl_opts` overrides all TLS options set
+through the connection string with which the :symbol:`mongoc_client_pool_t` was
 constructed.
 
 Parameters

src/libmongoc/doc/mongoc_client_set_ssl_opts.rst

@@ -14,15 +14,18 @@ Synopsis
                               const mongoc_ssl_opt_t *opts);
   #endif
 
+.. note::
+   |ssl:naming|
+
 Sets the TLS (SSL) options to use when connecting to TLS enabled MongoDB servers.
 
-The ``mongoc_ssl_opt_t`` struct is copied by the client along with the strings
+The :symbol:`mongoc_ssl_opt_t` struct is copied by the client along with the strings
 it points to (``pem_file``, ``pem_pwd``, ``ca_file``, ``ca_dir``, and
 ``crl_file``) so they don't have to remain valid after the call to
-``mongoc_client_set_ssl_opts``.
+:symbol:`mongoc_client_set_ssl_opts`.
 
-A call to ``mongoc_client_set_ssl_opts`` overrides all TLS options set through
-the connection string with which the ``mongoc_client_t`` was constructed.
+A call to :symbol:`mongoc_client_set_ssl_opts` overrides all TLS options set through
+the connection string with which the :symbol:`mongoc_client_t` was constructed.
 
 It is a programming error to call this function on a client from a
 :symbol:`mongoc_client_pool_t`. Instead, call

src/libmongoc/doc/mongoc_ssl_opt_get_default.rst

@@ -11,8 +11,11 @@ Synopsis
   const mongoc_ssl_opt_t *
   mongoc_ssl_opt_get_default (void);
 
+.. note::
+   |ssl:naming|
+
 Returns
 -------
 
-Returns the default SSL options for the process. This should not be modified or freed.
+Returns the default TLS options for the process. This should not be modified or freed.
 

src/libmongoc/doc/mongoc_ssl_opt_t.rst

@@ -20,6 +20,9 @@ Synopsis
      void *padding[6];
   } mongoc_ssl_opt_t;
 
+.. note::
+   |ssl:naming|
+
 Description
 -----------