Skip to content

Commit

Permalink
more fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
norareidy committed Apr 2, 2024
1 parent 10d974d commit 842e2a4
Show file tree
Hide file tree
Showing 41 changed files with 113 additions and 113 deletions.
2 changes: 1 addition & 1 deletion source/libbson/api/bson_iter_t/bson_iter_init.txt
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ Example
}
}

.. include:: ../../includes/seealso/iter-init.rst
.. include:: /libbson/includes/seealso/iter-init.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_iter_t/bson_iter_init_find.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Description

This function is identical to ``(bson_iter_init() && bson_iter_find())``.

.. include:: ../../includes/seealso/iter-init.rst
.. include:: /libbson/includes/seealso/iter-init.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Description

This function is identical to ``bson_iter_init() && bson_iter_find_case()``.

.. include:: ../../includes/seealso/iter-init.rst
.. include:: /libbson/includes/seealso/iter-init.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Description

This function is identical to ``(bson_iter_init() && bson_iter_find_w_len())``.

.. include:: ../../includes/seealso/iter-init.rst
.. include:: /libbson/includes/seealso/iter-init.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ Example
}
}

.. include:: ../../includes/seealso/iter-init.rst
.. include:: /libbson/includes/seealso/iter-init.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Returns

1 if successful and data was read. 0 if successful and no data was read. -1 if there was an error.

.. include:: ../../includes/seealso/json.rst
.. include:: /libbson/includes/seealso/json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ Example
}


.. include:: ../../includes/seealso/bson-as-json.rst
.. include:: /libbson/includes/seealso/bson-as-json.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_array_as_json.txt
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ Example
}


.. include:: ../../includes/seealso/bson-as-json.rst
.. include:: /libbson/includes/seealso/bson-as-json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ Example
bson_destroy (&bson);
}

.. include:: ../../includes/seealso/bson-as-json.rst
.. include:: /libbson/includes/seealso/bson-as-json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ Example
bson_free (str);


.. include:: ../../includes/seealso/bson-as-json.rst
.. include:: /libbson/includes/seealso/bson-as-json.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_as_json.txt
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ Example
bson_destroy (&bson);
}

.. include:: ../../includes/seealso/bson-as-json.rst
.. include:: /libbson/includes/seealso/bson-as-json.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_as_json_with_opts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ Example
bson_json_opts_destroy (opts);


.. include:: ../../includes/seealso/bson-as-json.rst
.. include:: /libbson/includes/seealso/bson-as-json.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_concat.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Returns

Returns ``true`` if successful; ``false`` if the operation would overflow the maximum document size or another invalid state is detected.

.. include:: ../../includes/seealso/create-bson.rst
.. include:: /libbson/includes/seealso/create-bson.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_init.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Description
The :ref:`bson_init` function shall initialize a :ref:`bson_t` that is placed on
the stack. This is equivalent to initializing a :ref:`bson_t` to ``BSON_INITIALIZER``.

.. include:: ../../includes/seealso/create-bson.rst
.. include:: /libbson/includes/seealso/create-bson.rst
4 changes: 2 additions & 2 deletions source/libbson/api/bson_t/bson_init_from_json.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ Returns
Returns ``true`` if valid JSON was parsed, otherwise ``false`` and ``error`` is set. On success,
``bson`` is initialized and must be freed with :ref:`bson_destroy` otherwise ``bson`` is invalid.

.. include:: ../../includes/seealso/create-bson.rst
.. include:: /libbson/includes/seealso/create-bson.rst

.. include:: ../../includes/seealso/json.rst
.. include:: /libbson/includes/seealso/json.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_init_static.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ Returns
Returns ``true`` if :ref:`bson_t` was successfully initialized, otherwise ``false``. The
function can fail if ``data`` or ``length`` are invalid.

.. include:: ../../includes/seealso/create-bson.rst
.. include:: /libbson/includes/seealso/create-bson.rst
6 changes: 3 additions & 3 deletions source/libbson/api/bson_t/bson_json_opts_t.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ Functions
:titlesonly:
:maxdepth: 1

bson_json_opts_new
bson_json_opts_destroy
bson_json_opts_set_outermost_array
/libbson/api/bson_t/bson_json_opts_new
/libbson/api/bson_t/bson_json_opts_destroy
/libbson/api/bson_t/bson_json_opts_set_outermost_array
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_new.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Returns

A newly allocated :ref:`bson_t` that should be freed with :ref:`bson_destroy`.

.. include:: ../../includes/seealso/create-bson.rst
.. include:: /libbson/includes/seealso/create-bson.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_new_from_buffer.txt
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ Returns

A newly-allocated :ref:`bson_t` on success, or NULL.

.. include:: ../../includes/seealso/create-bson.rst
.. include:: /libbson/includes/seealso/create-bson.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_new_from_data.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Returns

A newly allocated :ref:`bson_t` if successful, otherwise NULL.

.. include:: ../../includes/seealso/create-bson.rst
.. include:: /libbson/includes/seealso/create-bson.rst
4 changes: 2 additions & 2 deletions source/libbson/api/bson_t/bson_new_from_json.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ Returns

A newly allocated :ref:`bson_t` if successful, otherwise NULL and ``error`` is set.

.. include:: ../../includes/seealso/create-bson.rst
.. include:: /libbson/includes/seealso/create-bson.rst

.. include:: ../../includes/seealso/json.rst
.. include:: /libbson/includes/seealso/json.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_reinit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ If the :ref:`bson_t` structure contains a malloc()'d buffer, it may be reused. T
certain that any buffer is freed, always call :ref:`bson_destroy` on any :ref:`bson_t`
structure, whether initialized or reinitialized, after its final use.

.. include:: ../../includes/seealso/create-bson.rst
.. include:: /libbson/includes/seealso/create-bson.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_reserve_buffer.txt
Original file line number Diff line number Diff line change
Expand Up @@ -113,4 +113,4 @@ reads a file into it directly:
return 0;
}

.. include:: ../../includes/seealso/create-bson.rst
.. include:: /libbson/includes/seealso/create-bson.rst
2 changes: 1 addition & 1 deletion source/libbson/api/bson_t/bson_sized_new.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ Returns

A newly allocated :ref:`bson_t` that should be freed with :ref:`bson_destroy`.

.. include:: ../../includes/seealso/create-bson.rst
.. include:: /libbson/includes/seealso/create-bson.rst
4 changes: 2 additions & 2 deletions source/libbson/includes/seealso/bson-as-json.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. seealso::

| :ref: `bson_array_as_canonical_extended_json`
| :ref:`bson_array_as_canonical_extended_json`
| :ref:`bson_array_as_json`
| :ref: `bson_array_as_relaxed_extended_json`
| :ref:`bson_array_as_relaxed_extended_json`
| :ref:`bson_as_canonical_extended_json`
Expand Down
4 changes: 2 additions & 2 deletions source/libmongoc/api/mongoc_client_encryption_t.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Functions
---------

.. toctree::
:titlesonly:
:maxdepth: 1
:titlesonly:
:maxdepth: 1

/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_new
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_destroy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Functions
:titlesonly:
:maxdepth: 1

mongoc_client_encryption_datakey_opts_new
mongoc_client_encryption_datakey_opts_destroy
mongoc_client_encryption_datakey_opts_set_masterkey
mongoc_client_encryption_datakey_opts_set_keyaltnames
mongoc_client_encryption_datakey_opts_set_keymaterial
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_datakey_opts_new
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_datakey_opts_destroy
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_datakey_opts_set_masterkey
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_datakey_opts_set_keyaltnames
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_datakey_opts_set_keymaterial

.. seealso::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ Functions
:titlesonly:
:maxdepth: 1

mongoc_client_encryption_encrypt_opts_new
mongoc_client_encryption_encrypt_opts_destroy
mongoc_client_encryption_encrypt_opts_set_keyid
mongoc_client_encryption_encrypt_opts_set_keyaltname
mongoc_client_encryption_encrypt_opts_set_algorithm
mongoc_client_encryption_encrypt_opts_set_contention_factor
mongoc_client_encryption_encrypt_opts_set_query_type
mongoc_client_encryption_encrypt_opts_set_range_opts
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_opts_new
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_opts_destroy
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_opts_set_keyid
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_opts_set_keyaltname
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_opts_set_algorithm
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_opts_set_contention_factor
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_opts_set_query_type
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_opts_set_range_opts

.. seealso::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ Functions
:titlesonly:
:maxdepth: 1

mongoc_client_encryption_encrypt_range_opts_new
mongoc_client_encryption_encrypt_range_opts_destroy
mongoc_client_encryption_encrypt_range_opts_set_sparsity
mongoc_client_encryption_encrypt_range_opts_set_min
mongoc_client_encryption_encrypt_range_opts_set_max
mongoc_client_encryption_encrypt_range_opts_set_precision
mongoc_client_encryption_encrypt_opts_set_range_opts
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_range_opts_new
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_range_opts_destroy
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_range_opts_set_sparsity
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_range_opts_set_min
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_range_opts_set_max
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_range_opts_set_precision
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_encrypt_opts_set_range_opts

.. seealso::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ Functions
:titlesonly:
:maxdepth: 1

mongoc_client_encryption_opts_new
mongoc_client_encryption_opts_destroy
mongoc_client_encryption_opts_set_keyvault_client
mongoc_client_encryption_opts_set_keyvault_namespace
mongoc_client_encryption_opts_set_kms_credential_provider_callback
mongoc_client_encryption_opts_set_kms_providers
mongoc_client_encryption_opts_set_tls_opts
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_opts_new
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_opts_destroy
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_opts_set_keyvault_client
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_opts_set_keyvault_namespace
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_opts_set_kms_credential_provider_callback
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_opts_set_kms_providers
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_opts_set_tls_opts

.. seealso::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Functions
:titlesonly:
:maxdepth: 1

mongoc_client_encryption_rewrap_many_datakey_result_new
mongoc_client_encryption_rewrap_many_datakey_result_destroy
mongoc_client_encryption_rewrap_many_datakey_result_get_bulk_write_result
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_rewrap_many_datakey_result_new
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_rewrap_many_datakey_result_destroy
/libmongoc/api/mongoc_client_encryption_t/mongoc_client_encryption_rewrap_many_datakey_result_get_bulk_write_result

.. seealso::

Expand Down
4 changes: 2 additions & 2 deletions source/libmongoc/api/mongoc_cursor_t.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ Functions
---------

.. toctree::
:titlesonly:
:maxdepth: 1
:titlesonly:
:maxdepth: 1

/libmongoc/api/mongoc_cursor_t/mongoc_cursor_clone
/libmongoc/api/mongoc_cursor_t/mongoc_cursor_current
Expand Down
36 changes: 19 additions & 17 deletions source/libmongoc/api/mongoc_find_and_modify_opts_t.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ find_and_modify abstraction
Synopsis
--------

``mongoc_find_and_modify_opts_t`` is a builder interface to construct `the findAndModify command`_.
``mongoc_find_and_modify_opts_t`` is a builder interface to construct `the findAndModify command
<https://www.mongodb.com/docs/manual/reference/command/findAndModify/>`_.

It was created to be able to accommodate new arguments to `the findAndModify command`_.
It was created to be able to accommodate new arguments to `the findAndModify command
<https://www.mongodb.com/docs/manual/reference/command/findAndModify/>`_.

As of MongoDB 3.2, the :ref:`mongoc_write_concern_t` specified on the :ref:`mongoc_collection_t` will be used, if any.

Expand Down Expand Up @@ -163,19 +165,19 @@ Functions
:titlesonly:
:maxdepth: 1

/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_append
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_destroy
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_bypass_document_validation
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_fields
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_flags
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_max_time_ms
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_sort
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_update
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_new
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_bypass_document_validation
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_fields
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_flags
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_max_time_ms
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_sort
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_update
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_append
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_destroy
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_bypass_document_validation
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_fields
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_flags
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_max_time_ms
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_sort
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_get_update
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_new
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_bypass_document_validation
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_fields
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_flags
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_max_time_ms
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_sort
/libmongoc/api/mongoc_find_and_modify_opts_t/mongoc_find_and_modify_opts_set_update

Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,3 @@ Description
This structure contains options that can be set on a :ref:`mongoc_gridfs_file_t`. It can
be used by various functions when creating a new gridfs file.

Functions
---------

.. toctree::
:titlesonly:
:maxdepth: 1

6 changes: 2 additions & 4 deletions source/libmongoc/api/mongoc_uri_t/mongoc_uri_get_ssl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@ mongoc_uri_get_ssl()
====================

.. warning::
.. deprecated:: 1.15.0

This function is deprecated and should not be used in new code. See :ref:`mongoc_manage_collection_indexes`.

This function is deprecated and should not be used in new code. See :ref:`mongoc_manage_collection_indexes`.

This function is deprecated and should not be used in new code.

Please use :doc:`mongoc_uri_get_tls() <mongoc_uri_get_tls>` in new code.
Please use :ref:`mongoc_uri_get_tls <mongoc_uri_get_tls>` in new code.

Synopsis
--------
Expand Down
4 changes: 2 additions & 2 deletions source/libmongoc/application-performance-monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ set callbacks on it, then pass it to :ref:`mongoc_client_set_apm_callbacks` or :
Command-Monitoring Example
--------------------------

.. literalinclude:: includes/examples/example-command-monitoring.c
.. literalinclude:: /libmongoc/includes/examples/example-command-monitoring.c
:language: c
:caption: example-command-monitoring.c

Expand Down Expand Up @@ -81,7 +81,7 @@ overall command with ``"ok": 1``.
SDAM Monitoring Example
-----------------------

.. literalinclude:: includes/examples/example-sdam-monitoring.c
.. literalinclude:: /libmongoc/includes/examples/example-sdam-monitoring.c
:language: c
:caption: example-sdam-monitoring.c

Expand Down
Loading

0 comments on commit 842e2a4

Please sign in to comment.