Skip to content

Commit

Permalink
DOCSP-37027: Fix build errors (#1289)
Browse files Browse the repository at this point in the history
  • Loading branch information
norareidy authored May 10, 2024
1 parent c76ea21 commit 783dba8
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 33 deletions.
1 change: 1 addition & 0 deletions docs/includes/extracts-option-requires.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,4 @@ source:
replacement:
version: "7.0"
...

8 changes: 4 additions & 4 deletions docs/reference/method/MongoDBClient-addSubscriber.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Definition

.. phpmethod:: MongoDB\Client::addSubscriber()

Registers a monitoring event subscriber with this Client. The subscriber
will be notified of all events for this Client.
Registers a monitoring event subscriber with this Client. The subscriber
will be notified of all events for this Client.

.. code-block:: php

Expand Down Expand Up @@ -50,8 +50,8 @@ notified once of each event for this Client.
Example
-------

Create a :phpclass:`MongoDB\Driver\Monitoring\CommandSubscriber` that
logs all events:
Create a :php:`MongoDB\Driver\Monitoring\CommandSubscriber <manual/en/class.mongodb-driver-monitoring-commandsubscriber>`
that logs all events:

.. code-block:: php

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/method/MongoDBClient-removeSubscriber.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Definition

.. phpmethod:: MongoDB\Client::removeSubscriber()

Unregisters a monitoring event subscriber with this Client.
Unregisters a monitoring event subscriber with this Client.

.. code-block:: php

Expand Down
3 changes: 1 addition & 2 deletions docs/reference/method/MongoDBCollection-dropIndexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ Parameters

``$indexName`` : string| :phpclass:`MongoDB\Model\IndexInfo`
The name or model object of the index to drop. View the existing indexes on
the collection using the :phpmethod:`listIndexes()
<MongoDB\Collection::listIndexes()>` method.
the collection by using the :phpmethod:`MongoDB\Collection::listIndexes()` method.

``$options`` : array
An array specifying the desired options.
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/method/MongoDBCollection-updateMany.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ Parameters

``$update`` : array|object
Specifies the field and value combinations to update and any relevant update
operators. ``$update`` uses MongoDB's :manual:`update operators
</reference/operator/update>`. Starting with MongoDB 4.2, an `aggregation
pipeline <https://mongodb.com/docs/master/reference/command/update/#update-with-an-aggregation-pipeline>`_
operators. ``$update`` uses MongoDB's :manual:`update operators </reference/operator/update>`.
Starting with MongoDB 4.2, an `aggregation pipeline
<https://mongodb.com/docs/master/reference/command/update/#update-with-an-aggregation-pipeline>`_
can be passed as this parameter.

``$options`` : array
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Definition

Registers an alias for the bucket, which enables files within the bucket to
be accessed using a basic filename string (e.g.
`gridfs://<bucket-alias>/<filename>`).
``gridfs://<bucket-alias>/<filename>``).

.. code-block:: php

Expand Down Expand Up @@ -58,7 +58,7 @@ revision is read (revision ``-1``).
In write mode, the stream context can contain the option ``gridfs['chunkSizeBytes']``.
If omitted, the defaults are inherited from the ``Bucket`` instance option.

The functions `rename` and `unlink` will rename or remove all revisions of a
The functions ``rename`` and ``unlink`` will rename or remove all revisions of a
filename. If the filename does not exist, these functions throw a ``FileNotFoundException``.

Example
Expand Down
38 changes: 17 additions & 21 deletions docs/tutorial/encryption.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,45 +19,43 @@ To get started using in-use encryption in your project, the
to be compiled with `libmongocrypt <https://github.com/mongodb/libmongocrypt>`_
(enabled by default).

Additionally, either `crypt_shared`_ or `mongocryptd`_ are required in order to
Additionally, either ``crypt_shared`` or ``mongocryptd`` are required in order to
use *automatic* client-side encryption. Neither is required for *explicit*
encryption.


crypt_shared
~~~~~~~~~~~~
``crypt_shared``
~~~~~~~~~~~~~~~~

The :manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`
(crypt_shared) provides the same functionality as mongocryptd_, but does not
(``crypt_shared``) provides the same functionality as ``mongocryptd``, but does not
require you to spawn another process to perform automatic encryption.

By default, the PHP driver attempts to load crypt_shared from the system path(s)
and uses it automatically if found. To load crypt_shared from another location,
By default, the PHP driver attempts to load ``crypt_shared`` from the system path(s)
and uses it automatically if found. To load ``crypt_shared`` from another location,
use the ``cryptSharedLibPath`` auto encryption
:php:`driver option <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`
when constructing a client. If the driver cannot load crypt_shared it will
attempt to fallback to using mongocryptd by default. The
``cryptSharedLibRequired`` option may be used to always require crypt_shared and
when constructing a client. If the driver cannot load ``crypt_shared`` it will
attempt to fallback to using ``mongocryptd`` by default. The
``cryptSharedLibRequired`` option may be used to always require ``crypt_shared`` and
fail if it cannot be loaded.

For detailed installation instructions see the MongoDB documentation for the
:manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`.

``mongocryptd``
~~~~~~~~~~~~~~~

mongocryptd
~~~~~~~~~~~

The mongocryptd binary is an alternative requirement for automatic client-side
The ``mongocryptd`` binary is an alternative requirement for automatic client-side
encryption and is included as a component in the
:manual:`MongoDB Enterprise Server package </administration/install-enterprise/>`.
For detailed installation instructions see the
:manual:`MongoDB documentation on mongocryptd </core/csfle/reference/mongocryptd/>`.

mongocryptd performs the following:
``mongocryptd`` performs the following:

- Parses the automatic encryption rules specified in the client configuration.
If the ``schemaMap`` auto encryption driver option contains invalid syntax,
mongocryptd returns an error.
``mongocryptd`` returns an error.

- Uses the specified automatic encryption rules to mark fields in read and write
operations for encryption.
Expand All @@ -67,14 +65,13 @@ mongocryptd performs the following:
see :manual:`Supported Operations for Automatic Encryption </core/csfle/reference/supported-operations/>`.

A client configured with auto encryption will automatically spawn the
mongocryptd process from the application's ``PATH``. Applications can control
``mongocryptd`` process from the application's ``PATH``. Applications can control
the spawning behavior via various auto encryption
:php:`driver options <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.

mongocryptd is only responsible for supporting automatic client-side encryption
``mongocryptd`` is only responsible for supporting automatic client-side encryption
and does not itself perform any encryption or decryption.


Managing Encryption Keys
------------------------

Expand Down Expand Up @@ -105,7 +102,6 @@ encryption key (e.g. user-specific encryption keys) or create them dynamically.
.. literalinclude:: /examples/encryption/create_data_key.php
:language: php


.. _alt_name:

Referencing Encryption Keys by an Alternative Name
Expand Down Expand Up @@ -208,7 +204,7 @@ Explicit Encryption
~~~~~~~~~~~~~~~~~~~

Explicit encryption is a MongoDB community feature and does not use
crypt_shared_ or mongocryptd_. Explicit encryption is provided by the
``crypt_shared`` or ``mongocryptd``. Explicit encryption is provided by the
:php:`MongoDB\Driver\ClientEncryption <mongodb-driver-clientencryption>` class.

.. literalinclude:: /examples/encryption/csfle-explicit_encryption.php
Expand Down

0 comments on commit 783dba8

Please sign in to comment.