CDRIVER-1979 manual fixes for some RST files

Author: ajdavis

doc/aggregate.rst

@@ -41,7 +41,7 @@ Aggregations using the Zip Codes Data Set
 
 Each document in this collection has the following form:
 
-.. code-block:: none
+.. code-block:: json
 
   {
     "_id" : "35004",
@@ -70,7 +70,7 @@ To get all states with a population greater than 10 million, use the following a
 
 You should see a result like the following:
 
-.. code-block:: none
+.. code-block:: json
 
   { "_id" : "PA", "total_pop" : 11881643 }
   { "_id" : "OH", "total_pop" : 10847115 }
@@ -86,7 +86,7 @@ The ``$group`` pipeline operator requires _id field where we specify grouping; r
 
 The ``$group`` process reads all documents and for each state it creates a separate document, for example:
 
-.. code-block:: none
+.. code-block:: json
 
   { "_id" : "WA", "total_pop" : 4866692 }
 
@@ -99,7 +99,7 @@ Average City Population by State
 
 To get the first three states with the greatest average population per city, use the following aggregation:
 
-.. code-block:: none
+.. code-block:: c
 
   pipeline = BCON_NEW ("pipeline", "[",
      "{", "$group", "{", "_id", "{", "state", "$state", "city", "$city", "}", "pop", "{", "$sum", "$pop", "}", "}", "}",
@@ -110,7 +110,7 @@ To get the first three states with the greatest average population per city, use
 
 This aggregate pipeline produces:
 
-.. code-block:: none
+.. code-block:: json
 
   { "_id" : "DC", "avg_city_pop" : 303450.0 }
   { "_id" : "FL", "avg_city_pop" : 27942.29805615551 }
@@ -120,15 +120,15 @@ The above aggregation pipeline is build from three pipeline operators: ``$group`
 
 The first ``$group`` operator creates the following documents:
 
-.. code-block:: none
+.. code-block:: json
 
   { "_id" : { "state" : "WY", "city" : "Smoot" }, "pop" : 414 }
 
 Note, that the ``$group`` operator can't use nested documents except the ``_id`` field.
 
 The second ``$group`` uses these documents to create the following documents:
 
-.. code-block:: none
+.. code-block:: json
 
   { "_id" : "FL", "avg_city_pop" : 27942.29805615551 }
 

doc/api.rst

@@ -0,0 +1,52 @@
+:man_page: mongoc_api
+
+API Reference
+=============
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   init-cleanup
+   logging
+   errors
+   mongoc_version
+   mongoc_bulk_operation_t
+   mongoc_client_pool_t
+   mongoc_client_t
+   mongoc_collection_t
+   mongoc_cursor_t
+   mongoc_database_t
+   mongoc_delete_flags_t
+   mongoc_find_and_modify_opts_t
+   mongoc_gridfs_file_list_t
+   mongoc_gridfs_file_opt_t
+   mongoc_gridfs_file_t
+   mongoc_gridfs_t
+   mongoc_host_list_t
+   mongoc_index_opt_geo_t
+   mongoc_index_opt_t
+   mongoc_index_opt_wt_t
+   mongoc_insert_flags_t
+   mongoc_iovec_t
+   mongoc_matcher_t
+   mongoc_query_flags_t
+   mongoc_rand
+   mongoc_read_concern_t
+   mongoc_read_mode_t
+   mongoc_read_prefs_t
+   mongoc_remove_flags_t
+   mongoc_reply_flags_t
+   mongoc_server_description_t
+   mongoc_socket_t
+   mongoc_ssl_opt_t
+   mongoc_stream_buffered_t
+   mongoc_stream_file_t
+   mongoc_stream_gridfs_t
+   mongoc_stream_socket_t
+   mongoc_stream_t
+   mongoc_stream_tls_t
+   mongoc_topology_description_t
+   mongoc_update_flags_t
+   mongoc_uri_t
+   mongoc_write_concern_t

doc/application-performance-monitoring.rst

@@ -1,7 +1,7 @@
 :man_page: mongoc_application_performance_monitoring
 
-Introduction to Application Performance Monitoring (APM)
-========================================================
+Application Performance Monitoring (APM)
+========================================
 
 The MongoDB C Driver allows you to monitor all the MongoDB operations the driver executes. This event-notification system conforms to two MongoDB driver specs:
 
@@ -115,3 +115,26 @@ This example program prints something like:
 
 The driver discovers the third member, "localhost:27019", and adds it to the topology.
 
+
+.. only:: html
+
+  Functions
+  ---------
+
+  .. toctree::
+    :titlesonly:
+    :maxdepth: 1
+
+    mongoc_apm_callbacks_t
+    mongoc_apm_command_failed_t
+    mongoc_apm_command_started_t
+    mongoc_apm_command_succeeded_t
+    mongoc_apm_server_changed_t
+    mongoc_apm_server_closed_t
+    mongoc_apm_server_heartbeat_failed_t
+    mongoc_apm_server_heartbeat_started_t
+    mongoc_apm_server_heartbeat_succeeded_t
+    mongoc_apm_server_opening_t
+    mongoc_apm_topology_changed_t
+    mongoc_apm_topology_closed_t
+    mongoc_apm_topology_opening_t

doc/authentication.rst

@@ -21,15 +21,16 @@ Simply provide the username and password as one would with an ``HTTP URL``, as w
 GSSAPI (Kerberos) Authentication
 --------------------------------
 
-.. warning::
+.. note::
 
   Kerberos support is only provided in environments supported by the ``cyrus-sasl`` Kerberos implementation. This currently limits support to UNIX-like environments.
 
 ``GSSAPI`` (Kerberos) authentication is available in the Enterprise Edition of MongoDB, version 2.4 and newer. To authenticate using ``GSSAPI``, the MongoDB C driver must be installed with SASL support. Run the ``kinit`` command before using the following authentication methods:
 
 .. code-block:: none
 
-  $ kinit [email protected]@EXAMPLE.COM's Password:$ klistCredentials cache: FILE:/tmp/krb5cc_1000
+  $ kinit [email protected]@EXAMPLE.COM's Password:
+  $ klistCredentials cache: FILE:/tmp/krb5cc_1000
           Principal: [email protected]
 
     Issued                Expires               Principal
@@ -66,13 +67,13 @@ If you encounter errors such as ``Invalid net address``, check if the applicatio
 SASL Plain Authentication
 -------------------------
 
-.. warning::
+.. note::
 
   The MongoDB C Driver must be compiled with SASL support in order to use ``SASL PLAIN`` authentication.
 
 MongoDB Enterprise Edition versions 2.5.0 and newer support the ``SASL PLAIN`` authentication mechanism, initially intended for delegating authentication to an LDAP server. Using the ``SASL PLAIN`` mechanism is very similar to the challenge response mechanism with usernames and passwords. These examples use the ``$external`` virtual database for ``LDAP`` support:
 
-.. warning::
+.. note::
 
   ``SASL PLAIN`` is a clear-text authentication mechanism. It is strongly recommended to connect to MongoDB using SSL with certificate validation when using the ``PLAIN`` mechanism.
 
@@ -85,7 +86,7 @@ MongoDB Enterprise Edition versions 2.5.0 and newer support the ``SASL PLAIN`` a
 X.509 Certificate Authentication
 --------------------------------
 
-.. warning::
+.. note::
 
   The MongoDB C Driver must be compiled with SSL support for X.509 authentication support. Once this is done, start a server with the following options: 
 

doc/basic-troubleshooting.rst

@@ -17,16 +17,13 @@ The following is a short list of things to check when you have a problem.
 Performance Counters
 --------------------
 
-        The MongoDB C driver comes with a unique feature to help developers and sysadmins troubleshoot problems in production.
-        Performance counters are available for each process using the driver.
-        The counters can be accessed outside of the application process via a shared memory segment.
-        This means that you can graph statistics about your application process easily from tools like Munin or Nagios.
-        Your author often uses ``watch --interval=0.5 -d mongoc-stat $PID`` to monitor an application.
+The MongoDB C driver comes with a unique feature to help developers and sysadmins troubleshoot problems in production.
+Performance counters are available for each process using the driver.
+The counters can be accessed outside of the application process via a shared memory segment.
+This means that you can graph statistics about your application process easily from tools like Munin or Nagios.
+Your author often uses ``watch --interval=0.5 -d mongoc-stat $PID`` to monitor an application.
 
-
-.. note::
-
-  Counters are currently available on UNIX-like platforms that support shared memory segments.
+Counters are currently available on UNIX-like platforms that support shared memory segments.
 
 * Active and Disposed Cursors
 * Active and Disposed Clients, Client Pools, and Socket Streams.

doc/bulk.rst

@@ -10,9 +10,10 @@ Bulk Insert
 
 First we need to fetch a bulk operation handle from the :symbol:`mongoc_collection_t <mongoc_collection_t>`. This can be performed in either ordered or unordered mode. Unordered mode allows for greater parallelization when working with sharded clusters.
 
-.. code-block:: none
+.. code-block:: c
 
-  mongoc_bulk_operation_t *bulk = mongoc_collection_create_bulk_operation (collection, true, write_concern);
+  mongoc_bulk_operation_t *bulk =
+     mongoc_collection_create_bulk_operation (collection, true, write_concern);
 
 We can now start inserting documents to the bulk operation. These will be buffered until we execute the operation.
 
@@ -108,12 +109,12 @@ Example ``reply`` document:
 
 The :symbol:`bson_error_t <errors>` domain is ``MONGOC_ERROR_COMMAND`` and its code is 11000. 
 
+.. _bulk_operation_bypassing_document_validation:
+
 Bulk Operation Bypassing Document Validation
 --------------------------------------------
 
-.. tip::
-
-  This feature is only available when using MongoDB 3.2 and later.
+This feature is only available when using MongoDB 3.2 and later.
 
 By default bulk operations are validated against the schema, if any is defined. In certain cases however it may be necessary to bypass the document validation.
 
@@ -177,9 +178,7 @@ The :symbol:`bson_error_t <errors>` domain is ``MONGOC_ERROR_WRITE_CONCERN`` if
 Setting Collation Order
 -----------------------
 
-.. tip::
-
-  This feature is only available when using MongoDB 3.4 and later.
+This feature is only available when using MongoDB 3.4 and later.
 
 .. literalinclude:: ../examples/bulk/bulk-collation.c
    :language: c

doc/cursors.rst

@@ -10,7 +10,7 @@ Cursors exist on a MongoDB server. However, the ``mongoc_cursor_t`` structure gi
 
 While iterating cursors, you should check to see if an error has occurred. See the following example for how to robustly check for errors.
 
-.. code-block:: none
+.. code-block:: c
 
   static void
   print_all_documents (mongoc_collection_t *collection)
@@ -50,9 +50,9 @@ Tailable cursors are cursors that remain open even after they've returned a fina
 
 Here's a complete test case that demonstrates the use of tailable cursors.
 
-.. info::
+.. note::
 
-  Note that tailable cursors are for capped collections only.
+  Tailable cursors are for capped collections only.
 
 An example to tail the oplog from a replicaSet.
 
@@ -66,9 +66,7 @@ Let's compile and run this example against a replica set to see updates as they
 
   $ gcc -Wall -o mongoc-tail mongoc-tail.c $(pkg-config --cflags --libs libmongoc-1.0)$ ./mongoc-tail mongodb://example.com/?replicaSet=myReplSet{ "ts" : { "$timestamp" : { "t" : 1400023818, "i" : 1 } }, "h" : -8458503739429355503, "v" : 2, "op" : "i", "ns" : "test.test", "o" : { "_id" : { "$oid" : "5372ab0a25164be923d10d50" } } }
 
-.. tip::
-
-  The line of output is a sample from performing ``db.test.insert({})`` from the mongo shell on the given replicaSet.
+The line of output is a sample from performing ``db.test.insert({})`` from the mongo shell on the given replicaSet.
 
 See also :symbol:`mongoc_cursor_set_max_await_time_ms <mongoc_cursor_set_max_await_time_ms>`.