Skip to content

Commit

Permalink
restructure
Browse files Browse the repository at this point in the history
  • Loading branch information
norareidy committed Mar 21, 2024
1 parent a798f8a commit e12ffb0
Show file tree
Hide file tree
Showing 684 changed files with 125 additions and 104 deletions.
Binary file added source/.DS_Store
Binary file not shown.
Binary file added source/docs-libmongoc/.DS_Store
Binary file not shown.
67 changes: 0 additions & 67 deletions source/docs-libmongoc/api.rst

This file was deleted.

68 changes: 68 additions & 0 deletions source/docs-libmongoc/api.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
=============
API Reference
=============

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

/api/init-cleanup
/api/logging
/api/errors
/api/lifecycle
/api/gridfs
/api/mongoc_auto_encryption_opts_t
/api/mongoc_bulk_operation_t
/api/mongoc_change_stream_t
/api/mongoc_client_encryption_t
/api/mongoc_client_encryption_datakey_opts_t
/api/mongoc_client_encryption_rewrap_many_datakey_result_t
/api/mongoc_client_encryption_encrypt_opts_t
/api/mongoc_client_encryption_encrypt_range_opts_t
/api/mongoc_client_encryption_opts_t
/api/mongoc_client_pool_t
/api/mongoc_client_session_t
/api/mongoc_client_session_with_transaction_cb_t
/api/mongoc_client_t
/api/mongoc_collection_t
/api/mongoc_cursor_t
/api/mongoc_database_t
/api/mongoc_delete_flags_t
/api/mongoc_find_and_modify_opts_t
/api/mongoc_gridfs_file_list_t
/api/mongoc_gridfs_file_opt_t
/api/mongoc_gridfs_file_t
/api/mongoc_gridfs_bucket_t
/api/mongoc_gridfs_t
/api/mongoc_host_list_t
/api/mongoc_index_opt_geo_t
/api/mongoc_index_opt_t
/api/mongoc_index_opt_wt_t
/api/mongoc_insert_flags_t
/api/mongoc_iovec_t
/api/mongoc_optional_t
/api/mongoc_query_flags_t
/api/mongoc_rand
/api/mongoc_read_concern_t
/api/mongoc_read_mode_t
/api/mongoc_read_prefs_t
/api/mongoc_remove_flags_t
/api/mongoc_reply_flags_t
/api/mongoc_server_api_t
/api/mongoc_server_api_version_t
/api/mongoc_server_description_t
/api/mongoc_session_opt_t
/api/mongoc_socket_t
/api/mongoc_ssl_opt_t
/api/mongoc_stream_buffered_t
/api/mongoc_stream_file_t
/api/mongoc_stream_socket_t
/api/mongoc_stream_t
/api/mongoc_stream_tls_t
/api/mongoc_topology_description_t
/api/mongoc_transaction_opt_t
/api/mongoc_transaction_state_t
/api/mongoc_update_flags_t
/api/mongoc_uri_t
/api/mongoc_version
/api/mongoc_write_concern_t
34 changes: 34 additions & 0 deletions source/docs-libmongoc/api/init-cleanup.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. _mongoc_init_cleanup:

==========================
Initialization and cleanup
==========================

Synopsis
--------

.. include:: includes/init_cleanup.txt

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

mongoc_init
mongoc_cleanup

Deprecated feature: automatic initialization and cleanup
--------------------------------------------------------

On some platforms the driver can automatically call :ref:`mongoc_init` before ``main``,
and call :ref:`mongoc_cleanup` as the process exits. This is problematic in situations where related
libraries also execute cleanup code on shutdown, and it creates inconsistent rules across platforms.
Therefore the automatic initialization and cleanup feature is deprecated, and will be dropped in
version 2.0. Meanwhile, for backward compatibility, the feature is *enabled* by default on platforms
where it is available.

For portable, future-proof code, always call :ref:`mongoc_init` and :ref:`mongoc_cleanup` yourself,
and configure the driver like:

.. code-block:: none

cmake -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
================
Object Lifecycle
================

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.. _mongoc_logging
.. _mongoc_logging:

=======
Logging
=======

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit e12ffb0

Please sign in to comment.