CDRIVER-933 note change in ssl opts behavior

Beginning in version 1.2, once a pool or client has any SSL options
set, all connections use SSL, even if "ssl=true" is omitted from the
MongoDB URI. Before, SSL options were ignored unless "ssl=true" was
included in the URI.

Author: ajdavis

NEWS

@@ -1,6 +1,11 @@
 mongo-c-driver 1.2.1
 ====================
 
+ * mongoc_client_set_ssl_opts and mongoc_client_pool_set_ssl_opts now configure
+   the driver to require an SSL connection to the server, even if "ssl=true" is
+   omitted from the MongoDB URI. Before, SSL options were ignored unless
+   "ssl=true" was included in the URI.
+
 mongo-c-driver 1.2.0
 ====================
 

doc/mongoc_client_pool_set_ssl_opts.page

@@ -19,6 +19,7 @@ mongoc_client_pool_set_ssl_opts (mongoc_client_pool_t   *pool,
 #endif]]></code></synopsis>
     <p>This function is identical to <code xref="mongoc_client_set_ssl_opts">mongoc_client_set_ssl_opts()</code> except for client pools. It ensures that all clients retrieved from <code xref="mongoc_client_pool_pop">mongoc_client_pool_pop()</code> or <code xref="mongoc_client_pool_try_pop">mongoc_client_pool_try_pop()</code> are configured with the same SSL settings.</p>
     <p>It is a programming error to call this function after retrieving a client from the client pool.</p>
+    <p>Beginning in version 1.2.0, once a pool has any SSL options set, all connections use SSL, even if "ssl=true" is omitted from the MongoDB URI. Before, SSL options were ignored unless "ssl=true" was included in the URI.</p>
   </section>
 
   <section id="parameters">
@@ -29,10 +30,9 @@ mongoc_client_pool_set_ssl_opts (mongoc_client_pool_t   *pool,
     </table>
   </section>
 
-  <section id="parameters">
+  <section id="availability">
     <title>Availability</title>
-    <p>Since 0.96.0</p>
-    <note style="tip"><p>This feature requires that the MongoDB C driver was compiled with <code>--enable-ssl</code>.</p></note>
+    <p>This feature requires that the MongoDB C driver was compiled with <code>--enable-ssl</code>.</p>
   </section>
 
 </page>

doc/mongoc_client_set_ssl_opts.page

@@ -12,11 +12,13 @@
 
   <section id="synopsis">
     <title>Synopsis</title>
-    <synopsis><code mime="text/x-csrc"><![CDATA[void
+    <synopsis><code mime="text/x-csrc"><![CDATA[#ifdef MONGOC_ENABLE_SSL
 mongoc_client_set_ssl_opts (mongoc_client_t        *client,
-                            const mongoc_ssl_opt_t *opts);]]></code></synopsis>
+                            const mongoc_ssl_opt_t *opts);
+#endif]]></code></synopsis>
     <p>Sets the SSL options to use when connecting to SSL enabled MongoDB servers.</p>
-    <note><p>Although the <code>mongoc_ssl_opt_t</code> struct itself is shallow-copied by the client, the strings it points to (<code>pem_file</code>, <code>pem_pwd</code>, <code>ca_file</code>, <code>ca_dir</code>, and <code>crl_file</code>) are not copied and must remain valid for the life of the <code>mongoc_client_t</code>.</p></note>
+    <p>Beginning in version 1.2.0, once a client has any SSL options set, all connections use SSL, even if "ssl=true" is omitted from the MongoDB URI. Before, SSL options were ignored unless "ssl=true" was included in the URI.</p>
+    <p>Although the <code>mongoc_ssl_opt_t</code> struct itself is shallow-copied by the client, the strings it points to (<code>pem_file</code>, <code>pem_pwd</code>, <code>ca_file</code>, <code>ca_dir</code>, and <code>crl_file</code>) are not copied and must remain valid for the life of the <code>mongoc_client_t</code>.</p>
   </section>
 
   <section id="parameters">
@@ -27,4 +29,9 @@ mongoc_client_set_ssl_opts (mongoc_client_t        *client,
     </table>
   </section>
 
+  <section id="availability">
+    <title>Availability</title>
+    <p>This feature requires that the MongoDB C driver was compiled with <code>--enable-ssl</code>.</p>
+  </section>
+
 </page>

doc/mongoc_ssl_opt_t.page

@@ -27,11 +27,20 @@
 
   <section id="desc">
     <title>Description</title>
-    <p>This structure is used to set the SSL options for a <code xref="mongoc_client_t">mongoc_client_t</code>.</p>
+    <p>This structure is used to set the SSL options for a <code xref="mongoc_client_t">mongoc_client_t</code> or <code xref="mongoc_client_pool_t">mongoc_client_pool_t</code>.</p>
+    <p>Beginning in version 1.2.0, once a pool or client has any SSL options set, all connections use SSL, even if "ssl=true" is omitted from the MongoDB URI. Before, SSL options were ignored unless "ssl=true" was included in the URI.</p>
   </section>
 
   <links type="topic" groups="function" style="2column">
     <title>Functions</title>
   </links>
 
+  <section id="seealso">
+    <title>See Also</title>
+    <list>
+      <item><p><link type="seealso" xref="mongoc_client_set_ssl_opts"><code>mongoc_client_set_ssl_opts</code></link></p></item>
+      <item><p><link type="seealso" xref="mongoc_client_pool_set_ssl_opts"><code>mongoc_client_pool_set_ssl_opts</code></link></p></item>
+    </list>
+  </section>
+
 </page>

doc/mongoc_uri_t.page

@@ -55,7 +55,7 @@
   <section id="conn-options">
     <title>Connection Options</title>
     <table>
-      <tr><td><p>ssl</p></td><td><p>{true|false}, indicating if SSL must be used.</p></td></tr>
+      <tr><td><p>ssl</p></td><td><p>{true|false}, indicating if SSL must be used. (See also <code xref="mongoc_client_set_ssl_opts">mongoc_client_set_ssl_opts</code> and <code xref="mongoc_client_pool_set_ssl_opts">mongoc_client_pool_set_ssl_opts</code>.)</p></td></tr>
       <tr><td><p>connectTimeoutMS</p></td><td><p>A timeout in milliseconds to attempt a connection before timing out. This setting applies to server discovery and monitoring connections as well as to connections for application operations. The default is 10 seconds.</p></td></tr>
       <tr><td><p>socketTimeoutMS</p></td><td><p>The time in milliseconds to attempt to send or receive on a socket before the attempt times out. The default is 5 minutes.</p></td></tr>
     </table>