CDRIVER-1924 doc how to pass collation to commands

Author: ajdavis

doc/mongoc_client_read_command_with_opts.page

@@ -25,7 +25,7 @@ mongoc_client_read_command_with_opts (mongoc_client_t           *client,
 ]]></code></synopsis>
 
     <p>Execute a command on the server, applying logic that is specific to commands that read, and taking the MongoDB server version into account. To send a raw command to the server without any of this logic, use <code xref="mongoc_client_command_simple">mongoc_client_command_simple</code>.</p>
-    <p>Use this function for commands that read such as "count" or "distinct". Read concern is applied from <code>opts</code> or else from <code>client</code>. (Read concern requires MongoDB 3.2 or later, otherwise an error is returned.) Read preferences are applied from <code>read_prefs</code> or else from <code>client</code>. No write concern is applied.</p>
+    <p>Use this function for commands that read such as "count" or "distinct". Read concern is applied from <code>opts</code> or else from <code>client</code>. Collation is applied from <code>opts</code> (see example below). Read concern and collation both require MongoDB 3.2 or later, otherwise an error is returned. Read preferences are applied from <code>read_prefs</code> or else from <code>client</code>. No write concern is applied.</p>
     <p>To target a specific server, include an integer "serverId" field in <code>opts</code> with an id obtained first by calling <code xref="mongoc_client_select_server">mongoc_client_select_server</code>, then <code xref="mongoc_server_description_id">mongoc_server_description_id</code> on its return value.</p>
     <p><code>reply</code> is always initialized, and must be freed with <code xref="bson:bson_destroy">bson_destroy()</code>.</p>
   </section>

doc/mongoc_client_read_write_command_with_opts.page

@@ -26,7 +26,7 @@ mongoc_client_read_write_command_with_opts (mongoc_client_t           *client,
 
     <p>Execute a command on the server, applying logic for commands that both read and write, and taking the MongoDB server version into account. To send a raw command to the server without any of this logic, use <code xref="mongoc_client_command_simple">mongoc_client_command_simple</code>.</p>
     <p>Use this function for commands that both read and write, such as "mapReduce" with an output collection.</p>
-    <p>Read concern is applied from <code>opts</code> or else from <code>client</code>. (Read concern requires MongoDB 3.2 or later, otherwise an error is returned.) Read preferences are applied from <code>read_prefs</code> or else from <code>client</code>. Write concern is applied from <code>opts</code>, or else from <code>client</code>. The write concern is omitted for MongoDB before 3.2.</p>
+    <p>Read concern is applied from <code>opts</code> or else from <code>client</code>. Collation is applied from <code>opts</code> (<link xref="mongoc_client_read_command_with_opts#example">see example for <code>mongoc_client_read_command_with_opts</code></link>). Read concern and collation both require MongoDB 3.2 or later, otherwise an error is returned. Read preferences are applied from <code>read_prefs</code> or else from <code>client</code>. Write concern is applied from <code>opts</code>, or else from <code>client</code>. The write concern is omitted for MongoDB before 3.2.</p>
     <p>To target a specific server, include an integer "serverId" field in <code>opts</code> with an id obtained first by calling <code xref="mongoc_client_select_server">mongoc_client_select_server</code>, then <code xref="mongoc_server_description_id">mongoc_server_description_id</code> on its return value.</p>
     <p><code>reply</code> is always initialized, and must be freed with <code xref="bson:bson_destroy">bson_destroy()</code>.</p>
   </section>

doc/mongoc_client_write_command_with_opts.page

@@ -24,7 +24,7 @@ mongoc_client_write_command_with_opts (mongoc_client_t *client,
 ]]></code></synopsis>
 
     <p>Execute a command on the server, applying logic that is specific to commands that write, and taking the MongoDB server version into account. To send a raw command to the server without any of this logic, use <code xref="mongoc_client_command_simple">mongoc_client_command_simple</code>.</p>
-    <p>Use this function for commands that write such as "drop" or "createRole" (but not for "insert", "update", or "delete", see <link xref="#basic-write-operations">Basic Write Operations</link>). Write concern is applied from <code>opts</code>, or else from <code>client</code>. The write concern is omitted for MongoDB before 3.2. No read concern or read preferences are applied.</p>
+    <p>Use this function for commands that write such as "drop" or "createRole" (but not for "insert", "update", or "delete", see <link xref="#basic-write-operations">Basic Write Operations</link>). Write concern is applied from <code>opts</code>, or else from <code>client</code>. The write concern is omitted for MongoDB before 3.2. Collation is applied from <code>opts</code> (<link xref="mongoc_client_read_command_with_opts#example">see example for <code>mongoc_client_read_command_with_opts</code></link>). Collation requires MongoDB 3.2 or later, otherwise an error is returned. No read concern or read preferences are applied.</p>
     <p>To target a specific server, include an integer "serverId" field in <code>opts</code> with an id obtained first by calling <code xref="mongoc_client_select_server">mongoc_client_select_server</code>, then <code xref="mongoc_server_description_id">mongoc_server_description_id</code> on its return value.</p>
     <p><code>reply</code> is always initialized, and must be freed with <code xref="bson:bson_destroy">bson_destroy()</code>.</p>
   </section>

doc/mongoc_collection_read_command_with_opts.page

@@ -24,7 +24,7 @@ mongoc_collection_read_command_with_opts (mongoc_collection_t       *collection,
 ]]></code></synopsis>
 
     <p>Execute a command on the server, applying logic that is specific to commands that read, and taking the MongoDB server version into account. To send a raw command to the server without any of this logic, use <code xref="mongoc_collection_command_simple">mongoc_collection_command_simple</code>.</p>
-    <p>Use this function for commands that read such as "count" or "distinct". Read concern is applied from <code>opts</code> or else from <code>collection</code>. (Read concern requires MongoDB 3.2 or later, otherwise an error is returned.) Read preferences are applied from <code>read_prefs</code> or else from <code>collection</code>. No write concern is applied.</p>
+    <p>Use this function for commands that read such as "count" or "distinct". Read concern is applied from <code>opts</code> or else from <code>collection</code>. Collation is applied from <code>opts</code> (<link xref="mongoc_client_read_command_with_opts#example">see example for <code>mongoc_client_read_command_with_opts</code></link>). Read concern and collation both require MongoDB 3.2 or later, otherwise an error is returned. Read preferences are applied from <code>read_prefs</code> or else from <code>collection</code>. No write concern is applied.</p>
     <p>To target a specific server, include an integer "serverId" field in <code>opts</code> with an id obtained first by calling <code xref="mongoc_client_select_server">mongoc_client_select_server</code>, then <code xref="mongoc_server_description_id">mongoc_server_description_id</code> on its return value.</p>
     <p><code>reply</code> is always initialized, and must be freed with <code xref="bson:bson_destroy">bson_destroy()</code>.</p>
   </section>

doc/mongoc_collection_read_write_command_with_opts.page

@@ -25,7 +25,7 @@ mongoc_collection_read_write_command_with_opts (mongoc_collection_t       *colle
 
     <p>Execute a command on the server, applying logic for commands that both read and write, and taking the MongoDB server version into account. To send a raw command to the server without any of this logic, use <code xref="mongoc_collection_command_simple">mongoc_collection_command_simple</code>.</p>
     <p>Use this function for commands that both read and write, such as "mapReduce" with an output collection.</p>
-    <p>Read concern is applied from <code>opts</code> or else from <code>collection</code>. (Read concern requires MongoDB 3.2 or later, otherwise an error is returned.) Read preferences are applied from <code>read_prefs</code> or else from <code>collection</code>. Write concern is applied from <code>opts</code>, or else from <code>collection</code>. The write concern is omitted for MongoDB before 3.2.</p>
+    <p>Read concern is applied from <code>opts</code> or else from <code>collection</code>. Collation is applied from <code>opts</code> (<link xref="mongoc_client_read_command_with_opts#example">see example for <code>mongoc_client_read_command_with_opts</code></link>). Read concern and collation both require MongoDB 3.2 or later, otherwise an error is returned. Read preferences are applied from <code>read_prefs</code> or else from <code>collection</code>. Write concern is applied from <code>opts</code>, or else from <code>collection</code>. The write concern is omitted for MongoDB before 3.2.</p>
     <p>To target a specific server, include an integer "serverId" field in <code>opts</code> with an id obtained first by calling <code xref="mongoc_client_select_server">mongoc_client_select_server</code>, then <code xref="mongoc_server_description_id">mongoc_server_description_id</code> on its return value.</p>
     <p><code>reply</code> is always initialized, and must be freed with <code xref="bson:bson_destroy">bson_destroy()</code>.</p>
   </section>

doc/mongoc_collection_write_command_with_opts.page

@@ -23,7 +23,7 @@ mongoc_collection_write_command_with_opts (mongoc_collection_t *collection,
 ]]></code></synopsis>
 
     <p>Execute a command on the server, applying logic that is specific to commands that write, and taking the MongoDB server version into account. To send a raw command to the server without any of this logic, use <code xref="mongoc_collection_command_simple">mongoc_collection_command_simple</code>.</p>
-    <p>Use this function for commands that write such as "drop" or "createRole" (but not for "insert", "update", or "delete", see <link xref="#basic-write-operations">Basic Write Operations</link>). Write concern is applied from <code>opts</code>, or else from <code>collection</code>. The write concern is omitted for MongoDB before 3.2. No read concern or read preferences are applied.</p>
+    <p>Use this function for commands that write such as "drop" or "createRole" (but not for "insert", "update", or "delete", see <link xref="#basic-write-operations">Basic Write Operations</link>). Write concern is applied from <code>opts</code>, or else from <code>collection</code>. The write concern is omitted for MongoDB before 3.2. Collation is applied from <code>opts</code> (<link xref="mongoc_client_read_command_with_opts#example">see example for <code>mongoc_client_read_command_with_opts</code></link>). Collation requires MongoDB 3.2 or later, otherwise an error is returned. No read concern or read preferences are applied.</p>
     <p>To target a specific server, include an integer "serverId" field in <code>opts</code> with an id obtained first by calling <code xref="mongoc_client_select_server">mongoc_client_select_server</code>, then <code xref="mongoc_server_description_id">mongoc_server_description_id</code> on its return value.</p>
     <p><code>reply</code> is always initialized, and must be freed with <code xref="bson:bson_destroy">bson_destroy()</code>.</p>
   </section>

doc/mongoc_database_read_command_with_opts.page

@@ -24,7 +24,7 @@ mongoc_database_read_command_with_opts (mongoc_database_t         *database,
 ]]></code></synopsis>
 
     <p>Execute a command on the server, applying logic that is specific to commands that read, and taking the MongoDB server version into account. To send a raw command to the server without any of this logic, use <code xref="mongoc_database_command_simple">mongoc_database_command_simple</code>.</p>
-    <p>Use this function for commands that read such as "count" or "distinct". Read concern is applied from <code>opts</code> or else from <code>database</code>. (Read concern requires MongoDB 3.2 or later, otherwise an error is returned.) Read preferences are applied from <code>read_prefs</code> or else from <code>database</code>. No write concern is applied.</p>
+    <p>Use this function for commands that read such as "count" or "distinct". Read concern is applied from <code>opts</code> or else from <code>database</code>. Collation is applied from <code>opts</code> (<link xref="mongoc_client_read_command_with_opts#example">see example for <code>mongoc_client_read_command_with_opts</code></link>). Read concern and collation both require MongoDB 3.2 or later, otherwise an error is returned. Read preferences are applied from <code>read_prefs</code> or else from <code>database</code>. No write concern is applied.</p>
     <p>To target a specific server, include an integer "serverId" field in <code>opts</code> with an id obtained first by calling <code xref="mongoc_client_select_server">mongoc_client_select_server</code>, then <code xref="mongoc_server_description_id">mongoc_server_description_id</code> on its return value.</p>
     <p><code>reply</code> is always initialized, and must be freed with <code xref="bson:bson_destroy">bson_destroy()</code>.</p>
   </section>

doc/mongoc_database_read_write_command_with_opts.page

@@ -25,7 +25,7 @@ mongoc_database_read_write_command_with_opts (mongoc_database_t         *databas
 
     <p>Execute a command on the server, applying logic for commands that both read and write, and taking the MongoDB server version into account. To send a raw command to the server without any of this logic, use <code xref="mongoc_database_command_simple">mongoc_database_command_simple</code>.</p>
     <p>Use this function for commands that both read and write, such as "mapReduce" with an output collection.</p>
-    <p>Read concern is applied from <code>opts</code> or else from <code>database</code>. (Read concern requires MongoDB 3.2 or later, otherwise an error is returned.) Read preferences are applied from <code>read_prefs</code> or else from <code>database</code>. Write concern is applied from <code>opts</code>, or else from <code>database</code>. The write concern is omitted for MongoDB before 3.2.</p>
+    <p>Read concern is applied from <code>opts</code> or else from <code>database</code>. Collation is applied from <code>opts</code> (<link xref="mongoc_client_read_command_with_opts#example">see example for <code>mongoc_client_read_command_with_opts</code></link>). Read concern and collation both require MongoDB 3.2 or later, otherwise an error is returned. Read preferences are applied from <code>read_prefs</code> or else from <code>database</code>. Write concern is applied from <code>opts</code>, or else from <code>database</code>. The write concern is omitted for MongoDB before 3.2.</p>
     <p>To target a specific server, include an integer "serverId" field in <code>opts</code> with an id obtained first by calling <code xref="mongoc_client_select_server">mongoc_client_select_server</code>, then <code xref="mongoc_server_description_id">mongoc_server_description_id</code> on its return value.</p>
     <p><code>reply</code> is always initialized, and must be freed with <code xref="bson:bson_destroy">bson_destroy()</code>.</p>
   </section>

doc/mongoc_database_write_command_with_opts.page

@@ -23,7 +23,7 @@ mongoc_database_write_command_with_opts (mongoc_database_t *database,
 ]]></code></synopsis>
 
     <p>Execute a command on the server, applying logic that is specific to commands that write, and taking the MongoDB server version into account. To send a raw command to the server without any of this logic, use <code xref="mongoc_database_command_simple">mongoc_database_command_simple</code>.</p>
-    <p>Use this function for commands that write such as "drop" or "createRole" (but not for "insert", "update", or "delete", see <link xref="#basic-write-operations">Basic Write Operations</link>). Write concern is applied from <code>opts</code>, or else from <code>database</code>. The write concern is omitted for MongoDB before 3.2. No read concern or read preferences are applied.</p>
+    <p>Use this function for commands that write such as "drop" or "createRole" (but not for "insert", "update", or "delete", see <link xref="#basic-write-operations">Basic Write Operations</link>). Write concern is applied from <code>opts</code>, or else from <code>database</code>. The write concern is omitted for MongoDB before 3.2. Collation is applied from <code>opts</code> (<link xref="mongoc_client_read_command_with_opts#example">see example for <code>mongoc_client_read_command_with_opts</code></link>). Collation requires MongoDB 3.2 or later, otherwise an error is returned. No read concern or read preferences are applied.</p>
     <p>To target a specific server, include an integer "serverId" field in <code>opts</code> with an id obtained first by calling <code xref="mongoc_client_select_server">mongoc_client_select_server</code>, then <code xref="mongoc_server_description_id">mongoc_server_description_id</code> on its return value.</p>
     <p><code>reply</code> is always initialized, and must be freed with <code xref="bson:bson_destroy">bson_destroy()</code>.</p>
   </section>