Skip to content

Commit 783dba8

Browse files
authored
DOCSP-37027: Fix build errors (#1289)
1 parent c76ea21 commit 783dba8

7 files changed

+29
-33
lines changed

docs/includes/extracts-option-requires.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,4 @@ source:
4545
replacement:
4646
version: "7.0"
4747
...
48+

docs/reference/method/MongoDBClient-addSubscriber.txt

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Definition
1717

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

20-
Registers a monitoring event subscriber with this Client. The subscriber
21-
will be notified of all events for this Client.
20+
Registers a monitoring event subscriber with this Client. The subscriber
21+
will be notified of all events for this Client.
2222

2323
.. code-block:: php
2424

@@ -50,8 +50,8 @@ notified once of each event for this Client.
5050
Example
5151
-------
5252

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

5656
.. code-block:: php
5757

docs/reference/method/MongoDBClient-removeSubscriber.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Definition
1717

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

20-
Unregisters a monitoring event subscriber with this Client.
20+
Unregisters a monitoring event subscriber with this Client.
2121

2222
.. code-block:: php
2323

docs/reference/method/MongoDBCollection-dropIndexes.txt

+1-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ Parameters
2727

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

3332
``$options`` : array
3433
An array specifying the desired options.

docs/reference/method/MongoDBCollection-updateMany.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ Parameters
3333

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

4141
``$options`` : array

docs/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Definition
1919

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

2424
.. code-block:: php
2525

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

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

6464
Example

docs/tutorial/encryption.txt

+17-21
Original file line numberDiff line numberDiff line change
@@ -19,45 +19,43 @@ To get started using in-use encryption in your project, the
1919
to be compiled with `libmongocrypt <https://github.com/mongodb/libmongocrypt>`_
2020
(enabled by default).
2121

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

26-
27-
crypt_shared
28-
~~~~~~~~~~~~
26+
``crypt_shared``
27+
~~~~~~~~~~~~~~~~
2928

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

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

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

45+
``mongocryptd``
46+
~~~~~~~~~~~~~~~
4647

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

56-
mongocryptd performs the following:
54+
``mongocryptd`` performs the following:
5755

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

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

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

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

77-
7875
Managing Encryption Keys
7976
------------------------
8077

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

108-
109105
.. _alt_name:
110106

111107
Referencing Encryption Keys by an Alternative Name
@@ -208,7 +204,7 @@ Explicit Encryption
208204
~~~~~~~~~~~~~~~~~~~
209205

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

214210
.. literalinclude:: /examples/encryption/csfle-explicit_encryption.php

0 commit comments

Comments
 (0)