From 24c99d2c85a098e4826b6b737d88b3fbf9cfe34e Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 11:33:21 -0400 Subject: [PATCH 01/12] DOCSP-37027: Fix build errors --- .../reference/method/MongoDBClient-addSubscriber.txt | 4 ++-- .../method/MongoDBClient-removeSubscriber.txt | 2 +- .../reference/method/MongoDBCollection-bulkWrite.txt | 12 ++++++------ .../reference/method/MongoDBCollection-dropIndex.txt | 3 +-- .../method/MongoDBCollection-dropIndexes.txt | 3 +-- docs/reference/method/MongoDBCollection-explain.txt | 2 +- .../method/MongoDBDatabase-createCollection.txt | 2 +- ...GridFSBucket-registerGlobalStreamWrapperAlias.txt | 4 ++-- docs/tutorial/encryption.txt | 10 +++------- docs/tutorial/gridfs.txt | 2 +- 10 files changed, 19 insertions(+), 25 deletions(-) diff --git a/docs/reference/method/MongoDBClient-addSubscriber.txt b/docs/reference/method/MongoDBClient-addSubscriber.txt index b85d8d992..265b7af4f 100644 --- a/docs/reference/method/MongoDBClient-addSubscriber.txt +++ b/docs/reference/method/MongoDBClient-addSubscriber.txt @@ -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 diff --git a/docs/reference/method/MongoDBClient-removeSubscriber.txt b/docs/reference/method/MongoDBClient-removeSubscriber.txt index 9270689d8..e95f74e73 100644 --- a/docs/reference/method/MongoDBClient-removeSubscriber.txt +++ b/docs/reference/method/MongoDBClient-removeSubscriber.txt @@ -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 diff --git a/docs/reference/method/MongoDBCollection-bulkWrite.txt b/docs/reference/method/MongoDBCollection-bulkWrite.txt index db4bfb8f3..ad31f0623 100644 --- a/docs/reference/method/MongoDBCollection-bulkWrite.txt +++ b/docs/reference/method/MongoDBCollection-bulkWrite.txt @@ -30,12 +30,12 @@ Parameters ``$operations`` : array An array containing the write operations to perform. :phpmethod:`MongoDB\Collection::bulkWrite()` supports - :phpmethod:`deleteMany() `, - :phpmethod:`deleteOne() `, - :phpmethod:`insertOne() `, - :phpmethod:`replaceOne() `, - :phpmethod:`updateMany() `, and - :phpmethod:`updateOne() ` operations in the + :phpmethod:`MongoDB\Collection::deleteMany()`, + :phpmethod:`MongoDB\Collection::deleteOne()`, + :phpmethod:`MongoDB\Collection::insertOne()`, + :phpmethod:`MongoDB\Collection::replaceOne()`, + :phpmethod:`MongoDB\Collection::updateMany()`, and + :phpmethod:`MongoDB\Collection::updateOne()` operations in the following array structure: .. code-block:: php diff --git a/docs/reference/method/MongoDBCollection-dropIndex.txt b/docs/reference/method/MongoDBCollection-dropIndex.txt index 67ba427e3..b92364ede 100644 --- a/docs/reference/method/MongoDBCollection-dropIndex.txt +++ b/docs/reference/method/MongoDBCollection-dropIndex.txt @@ -29,8 +29,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() - ` method. + the collection using the :phpmethod:`MongoDB\Collection::listIndexes()` method. ``$options`` : array An array specifying the desired options. diff --git a/docs/reference/method/MongoDBCollection-dropIndexes.txt b/docs/reference/method/MongoDBCollection-dropIndexes.txt index 52595c71e..f7c6e5007 100644 --- a/docs/reference/method/MongoDBCollection-dropIndexes.txt +++ b/docs/reference/method/MongoDBCollection-dropIndexes.txt @@ -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() - ` method. + the collection using the :phpmethod:`MongoDB\Collection::listIndexes()` method. ``$options`` : array An array specifying the desired options. diff --git a/docs/reference/method/MongoDBCollection-explain.txt b/docs/reference/method/MongoDBCollection-explain.txt index 592f717e0..03619755a 100644 --- a/docs/reference/method/MongoDBCollection-explain.txt +++ b/docs/reference/method/MongoDBCollection-explain.txt @@ -29,7 +29,7 @@ Definition Parameters ---------- -``$explainable`` : :phpclass:`MongoDB\Operation\Explainable` +``$explainable`` : ``MongoDB\Operation\Explainable`` The command to explain. ``$options`` : array diff --git a/docs/reference/method/MongoDBDatabase-createCollection.txt b/docs/reference/method/MongoDBDatabase-createCollection.txt index 3c45debc9..8b49e901b 100644 --- a/docs/reference/method/MongoDBDatabase-createCollection.txt +++ b/docs/reference/method/MongoDBDatabase-createCollection.txt @@ -296,7 +296,7 @@ Parameters rules or expressions. You can specify the expressions using the same operators as MongoDB's :manual:`query operators ` with the - exception of :query:`$geoNear`, :query:`$near`, :query:`$nearSphere`, + exception of :query:`$near`, :query:`$nearSphere`, :query:`$text`, and :query:`$where`. .. note:: diff --git a/docs/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt b/docs/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt index 2d8fe60d0..405b0d3ee 100644 --- a/docs/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt +++ b/docs/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt @@ -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:///`). + ``gridfs:///``). .. code-block:: php @@ -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 diff --git a/docs/tutorial/encryption.txt b/docs/tutorial/encryption.txt index 3a9121658..3409510cb 100644 --- a/docs/tutorial/encryption.txt +++ b/docs/tutorial/encryption.txt @@ -19,16 +19,15 @@ To get started using in-use encryption in your project, the to be compiled with `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 ~~~~~~~~~~~~ The :manual:`Automatic Encryption 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) @@ -43,7 +42,6 @@ fail if it cannot be loaded. For detailed installation instructions see the MongoDB documentation for the :manual:`Automatic Encryption Shared Library `. - mongocryptd ~~~~~~~~~~~ @@ -74,7 +72,6 @@ the spawning behavior via various auto encryption mongocryptd is only responsible for supporting automatic client-side encryption and does not itself perform any encryption or decryption. - Managing Encryption Keys ------------------------ @@ -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 @@ -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 ` class. .. literalinclude:: /examples/encryption/csfle-explicit_encryption.php diff --git a/docs/tutorial/gridfs.txt b/docs/tutorial/gridfs.txt index 4688aefb3..dc6afa15d 100644 --- a/docs/tutorial/gridfs.txt +++ b/docs/tutorial/gridfs.txt @@ -35,7 +35,7 @@ The bucket can be constructed with various options: needed. The default size is ``261120`` (i.e. 255 KiB). - ``readConcern``, ``readPreference`` and ``writeConcern`` options can be used to specify defaults for read and write operations, much like the - :phpclass:`MongoDB\GridFS\Collection` options. + :phpclass:`MongoDB\Collection` options. Uploading Files with Writable Streams ------------------------------------- From 0b0f6cdf6360a128c0e54a297eca1c8384e59b89 Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 11:55:06 -0400 Subject: [PATCH 02/12] more fixes --- docs/reference.txt | 2 -- docs/reference/method/MongoDBClient-addSubscriber.txt | 4 ++-- .../reference/method/MongoDBCollection-findOneAndUpdate.txt | 2 +- docs/reference/method/MongoDBCollection-updateMany.txt | 6 +++--- docs/reference/method/MongoDBCollection-updateOne.txt | 2 +- docs/reference/result-classes.txt | 2 +- 6 files changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/reference.txt b/docs/reference.txt index 8e2e0f1a7..2dd51527c 100644 --- a/docs/reference.txt +++ b/docs/reference.txt @@ -12,8 +12,6 @@ API Documentation /reference/class/MongoDBDatabase /reference/class/MongoDBCollection /reference/class/MongoDBGridFSBucket - /reference/write-result-classes /reference/result-classes - /reference/enumeration-classes /reference/functions /reference/exception-classes diff --git a/docs/reference/method/MongoDBClient-addSubscriber.txt b/docs/reference/method/MongoDBClient-addSubscriber.txt index 265b7af4f..9a3344b03 100644 --- a/docs/reference/method/MongoDBClient-addSubscriber.txt +++ b/docs/reference/method/MongoDBClient-addSubscriber.txt @@ -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 ` +that logs all events: .. code-block:: php diff --git a/docs/reference/method/MongoDBCollection-findOneAndUpdate.txt b/docs/reference/method/MongoDBCollection-findOneAndUpdate.txt index f4077b344..19849ad3c 100644 --- a/docs/reference/method/MongoDBCollection-findOneAndUpdate.txt +++ b/docs/reference/method/MongoDBCollection-findOneAndUpdate.txt @@ -33,7 +33,7 @@ Parameters ``$update`` : array|object Specifies the field and value combinations to update and any relevant update - operators. ``$update`` uses MongoDB's :method:`update operators + operators. ``$update`` uses MongoDB's :manual:`update operators `. Starting with MongoDB 4.2, an `aggregation pipeline `_ can be passed as this parameter. diff --git a/docs/reference/method/MongoDBCollection-updateMany.txt b/docs/reference/method/MongoDBCollection-updateMany.txt index 2b0772209..0ada743b6 100644 --- a/docs/reference/method/MongoDBCollection-updateMany.txt +++ b/docs/reference/method/MongoDBCollection-updateMany.txt @@ -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 :method:`update operators - `. Starting with MongoDB 4.2, an `aggregation - pipeline `_ + operators. ``$update`` uses MongoDB's :manual:`update operators `. + Starting with MongoDB 4.2, an `aggregation pipeline + `_ can be passed as this parameter. ``$options`` : array diff --git a/docs/reference/method/MongoDBCollection-updateOne.txt b/docs/reference/method/MongoDBCollection-updateOne.txt index 321103c24..42877e730 100644 --- a/docs/reference/method/MongoDBCollection-updateOne.txt +++ b/docs/reference/method/MongoDBCollection-updateOne.txt @@ -35,7 +35,7 @@ Parameters ``$update`` : array|object Specifies the field and value combinations to update and any relevant update - operators. ``$update`` uses MongoDB's :method:`update operators + operators. ``$update`` uses MongoDB's :manual:`update operators `. Starting with MongoDB 4.2, an `aggregation pipeline `_ can be passed as this parameter. diff --git a/docs/reference/result-classes.txt b/docs/reference/result-classes.txt index db5ff7590..b59f480cd 100644 --- a/docs/reference/result-classes.txt +++ b/docs/reference/result-classes.txt @@ -10,7 +10,7 @@ Result Classes BulkWriteResult Class DeleteResult Class InsertManyResult Class - InsertOneResult Class + InsertOneResult Class UpdateResult Class ChangeStream Class MapReduceResult Class From dda2a5b81bb1c06a526b0623cc716c843f418218 Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 11:58:11 -0400 Subject: [PATCH 03/12] .yaml fixes --- docs/includes/extracts-option-requires.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/includes/extracts-option-requires.yaml b/docs/includes/extracts-option-requires.yaml index 3b65fbbab..8714a85df 100644 --- a/docs/includes/extracts-option-requires.yaml +++ b/docs/includes/extracts-option-requires.yaml @@ -4,45 +4,45 @@ source: ref: option-requires-version file: extracts-option-requires.yaml replacement: - version: "4.2" + object: "4.2" --- ref: option-requires-4.4 source: ref: option-requires-version file: extracts-option-requires.yaml replacement: - version: "4.4" + object: "4.4" --- ref: option-requires-5.0 source: ref: option-requires-version file: extracts-option-requires.yaml replacement: - version: "5.0" + object: "5.0" --- ref: option-requires-5.3 source: ref: option-requires-version file: extracts-option-requires.yaml replacement: - version: "5.3" + object: "5.3" --- ref: option-requires-6.0 source: ref: option-requires-version file: extracts-option-requires.yaml replacement: - version: "6.0" + object: "6.0" --- ref: option-requires-7.0 source: ref: option-requires-version file: extracts-option-requires.yaml replacement: - version: "7.0" + object: "7.0" --- ref: option-requires-version content: | - This option is available since MongoDB {{version}} and will result in an + This option is available since MongoDB {{object}} and will result in an exception at execution time if specified for an older server version. ... From 2bdc4f9093c876823d67b3aea13ebe788b0545b5 Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 12:00:47 -0400 Subject: [PATCH 04/12] delete file --- docs/includes/extracts-option-requires.yaml | 48 --------------------- 1 file changed, 48 deletions(-) delete mode 100644 docs/includes/extracts-option-requires.yaml diff --git a/docs/includes/extracts-option-requires.yaml b/docs/includes/extracts-option-requires.yaml deleted file mode 100644 index 8714a85df..000000000 --- a/docs/includes/extracts-option-requires.yaml +++ /dev/null @@ -1,48 +0,0 @@ ---- -ref: option-requires-4.2 -source: - ref: option-requires-version - file: extracts-option-requires.yaml -replacement: - object: "4.2" ---- -ref: option-requires-4.4 -source: - ref: option-requires-version - file: extracts-option-requires.yaml -replacement: - object: "4.4" ---- -ref: option-requires-5.0 -source: - ref: option-requires-version - file: extracts-option-requires.yaml -replacement: - object: "5.0" ---- -ref: option-requires-5.3 -source: - ref: option-requires-version - file: extracts-option-requires.yaml -replacement: - object: "5.3" ---- -ref: option-requires-6.0 -source: - ref: option-requires-version - file: extracts-option-requires.yaml -replacement: - object: "6.0" ---- -ref: option-requires-7.0 -source: - ref: option-requires-version - file: extracts-option-requires.yaml -replacement: - object: "7.0" ---- -ref: option-requires-version -content: | - This option is available since MongoDB {{object}} and will result in an - exception at execution time if specified for an older server version. -... From d1627cd434e9f4befabaacc5cb251499a968540f Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 12:02:40 -0400 Subject: [PATCH 05/12] Revert "delete file" This reverts commit 2bdc4f9093c876823d67b3aea13ebe788b0545b5. --- docs/includes/extracts-option-requires.yaml | 48 +++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/includes/extracts-option-requires.yaml diff --git a/docs/includes/extracts-option-requires.yaml b/docs/includes/extracts-option-requires.yaml new file mode 100644 index 000000000..8714a85df --- /dev/null +++ b/docs/includes/extracts-option-requires.yaml @@ -0,0 +1,48 @@ +--- +ref: option-requires-4.2 +source: + ref: option-requires-version + file: extracts-option-requires.yaml +replacement: + object: "4.2" +--- +ref: option-requires-4.4 +source: + ref: option-requires-version + file: extracts-option-requires.yaml +replacement: + object: "4.4" +--- +ref: option-requires-5.0 +source: + ref: option-requires-version + file: extracts-option-requires.yaml +replacement: + object: "5.0" +--- +ref: option-requires-5.3 +source: + ref: option-requires-version + file: extracts-option-requires.yaml +replacement: + object: "5.3" +--- +ref: option-requires-6.0 +source: + ref: option-requires-version + file: extracts-option-requires.yaml +replacement: + object: "6.0" +--- +ref: option-requires-7.0 +source: + ref: option-requires-version + file: extracts-option-requires.yaml +replacement: + object: "7.0" +--- +ref: option-requires-version +content: | + This option is available since MongoDB {{object}} and will result in an + exception at execution time if specified for an older server version. +... From e2550807716925dffd1b767451456c4612dc358b Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 12:10:26 -0400 Subject: [PATCH 06/12] test yaml fixes --- docs/includes/extracts-option-requires.yaml | 51 ++++++++++----------- 1 file changed, 23 insertions(+), 28 deletions(-) diff --git a/docs/includes/extracts-option-requires.yaml b/docs/includes/extracts-option-requires.yaml index 8714a85df..2ee0ad984 100644 --- a/docs/includes/extracts-option-requires.yaml +++ b/docs/includes/extracts-option-requires.yaml @@ -1,48 +1,43 @@ --- ref: option-requires-4.2 -source: - ref: option-requires-version - file: extracts-option-requires.yaml +content: | + This option is available since MongoDB {{version}} and will result in an + exception at execution time if specified for an older server version. replacement: - object: "4.2" + version: "4.2" --- ref: option-requires-4.4 -source: - ref: option-requires-version - file: extracts-option-requires.yaml +content: | + This option is available since MongoDB {{version}} and will result in an + exception at execution time if specified for an older server version. replacement: - object: "4.4" + version: "4.4" --- ref: option-requires-5.0 -source: - ref: option-requires-version - file: extracts-option-requires.yaml +content: | + This option is available since MongoDB {{version}} and will result in an + exception at execution time if specified for an older server version. replacement: - object: "5.0" + version: "5.0" --- ref: option-requires-5.3 -source: - ref: option-requires-version - file: extracts-option-requires.yaml +content: | + This option is available since MongoDB {{version}} and will result in an + exception at execution time if specified for an older server version. replacement: - object: "5.3" + version: "5.3" --- ref: option-requires-6.0 -source: - ref: option-requires-version - file: extracts-option-requires.yaml +content: | + This option is available since MongoDB {{version}} and will result in an + exception at execution time if specified for an older server version. replacement: - object: "6.0" + version: "6.0" --- ref: option-requires-7.0 -source: - ref: option-requires-version - file: extracts-option-requires.yaml -replacement: - object: "7.0" ---- -ref: option-requires-version content: | - This option is available since MongoDB {{object}} and will result in an + This option is available since MongoDB {{version}} and will result in an exception at execution time if specified for an older server version. +replacement: + version: "7.0" ... From d3c951ea78fa635170b2ce8a0d8d522879091007 Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 13:31:30 -0400 Subject: [PATCH 07/12] JS feedback --- docs/reference/method/MongoDBCollection-dropIndexes.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/method/MongoDBCollection-dropIndexes.txt b/docs/reference/method/MongoDBCollection-dropIndexes.txt index f7c6e5007..32c1c1345 100644 --- a/docs/reference/method/MongoDBCollection-dropIndexes.txt +++ b/docs/reference/method/MongoDBCollection-dropIndexes.txt @@ -27,7 +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:`MongoDB\Collection::listIndexes()` method. + the collection by using the :phpmethod:`MongoDB\Collection::listIndexes()` method. ``$options`` : array An array specifying the desired options. From 029d07feb1cc60c8cdcd5ed10fe7f519b88ed4f2 Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 13:46:11 -0400 Subject: [PATCH 08/12] reorder yaml file --- docs/includes/extracts-option-requires.yaml | 39 ++++++++++++--------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/docs/includes/extracts-option-requires.yaml b/docs/includes/extracts-option-requires.yaml index 2ee0ad984..1113425b9 100644 --- a/docs/includes/extracts-option-requires.yaml +++ b/docs/includes/extracts-option-requires.yaml @@ -1,43 +1,48 @@ --- -ref: option-requires-4.2 +ref: option-requires-version content: | This option is available since MongoDB {{version}} and will result in an exception at execution time if specified for an older server version. +--- +ref: option-requires-4.2 +source: + ref: option-requires-version + file: extracts-option-requires.yaml replacement: version: "4.2" --- ref: option-requires-4.4 -content: | - This option is available since MongoDB {{version}} and will result in an - exception at execution time if specified for an older server version. +source: + ref: option-requires-version + file: extracts-option-requires.yaml replacement: version: "4.4" --- ref: option-requires-5.0 -content: | - This option is available since MongoDB {{version}} and will result in an - exception at execution time if specified for an older server version. +source: + ref: option-requires-version + file: extracts-option-requires.yaml replacement: version: "5.0" --- ref: option-requires-5.3 -content: | - This option is available since MongoDB {{version}} and will result in an - exception at execution time if specified for an older server version. +source: + ref: option-requires-version + file: extracts-option-requires.yaml replacement: version: "5.3" --- ref: option-requires-6.0 -content: | - This option is available since MongoDB {{version}} and will result in an - exception at execution time if specified for an older server version. +source: + ref: option-requires-version + file: extracts-option-requires.yaml replacement: version: "6.0" --- ref: option-requires-7.0 -content: | - This option is available since MongoDB {{version}} and will result in an - exception at execution time if specified for an older server version. +source: + ref: option-requires-version + file: extracts-option-requires.yaml replacement: version: "7.0" -... +... \ No newline at end of file From 52fd388abb332a7eab12e2148311f758a8d78f9a Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 13:48:44 -0400 Subject: [PATCH 09/12] file and ref order --- docs/includes/extracts-option-requires.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/includes/extracts-option-requires.yaml b/docs/includes/extracts-option-requires.yaml index 1113425b9..2c8824361 100644 --- a/docs/includes/extracts-option-requires.yaml +++ b/docs/includes/extracts-option-requires.yaml @@ -6,43 +6,43 @@ content: | --- ref: option-requires-4.2 source: - ref: option-requires-version file: extracts-option-requires.yaml + ref: option-requires-version replacement: version: "4.2" --- ref: option-requires-4.4 source: - ref: option-requires-version file: extracts-option-requires.yaml + ref: option-requires-version replacement: version: "4.4" --- ref: option-requires-5.0 source: - ref: option-requires-version file: extracts-option-requires.yaml + ref: option-requires-version replacement: version: "5.0" --- ref: option-requires-5.3 source: - ref: option-requires-version file: extracts-option-requires.yaml + ref: option-requires-version replacement: version: "5.3" --- ref: option-requires-6.0 source: - ref: option-requires-version file: extracts-option-requires.yaml + ref: option-requires-version replacement: version: "6.0" --- ref: option-requires-7.0 source: - ref: option-requires-version file: extracts-option-requires.yaml + ref: option-requires-version replacement: version: "7.0" ... \ No newline at end of file From d21a930d26bf5b7cfafdad0b97a173e44c19b5e4 Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 14:12:39 -0400 Subject: [PATCH 10/12] source -> inherit --- docs/includes/extracts-option-requires.yaml | 27 ++++++++++----------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/includes/extracts-option-requires.yaml b/docs/includes/extracts-option-requires.yaml index 2c8824361..728eba275 100644 --- a/docs/includes/extracts-option-requires.yaml +++ b/docs/includes/extracts-option-requires.yaml @@ -1,48 +1,47 @@ ---- -ref: option-requires-version +ref: _option-requires-version content: | This option is available since MongoDB {{version}} and will result in an exception at execution time if specified for an older server version. --- ref: option-requires-4.2 -source: +inherit: file: extracts-option-requires.yaml - ref: option-requires-version + ref: _option-requires-version replacement: version: "4.2" --- ref: option-requires-4.4 -source: +inherit: file: extracts-option-requires.yaml - ref: option-requires-version + ref: _option-requires-version replacement: version: "4.4" --- ref: option-requires-5.0 -source: +inherit: file: extracts-option-requires.yaml - ref: option-requires-version + ref: _option-requires-version replacement: version: "5.0" --- ref: option-requires-5.3 -source: +inherit: file: extracts-option-requires.yaml - ref: option-requires-version + ref: _option-requires-version replacement: version: "5.3" --- ref: option-requires-6.0 -source: +inherit: file: extracts-option-requires.yaml - ref: option-requires-version + ref: _option-requires-version replacement: version: "6.0" --- ref: option-requires-7.0 -source: +inherit: file: extracts-option-requires.yaml - ref: option-requires-version + ref: _option-requires-version replacement: version: "7.0" ... \ No newline at end of file From a85c90cea7c363a11d8af33f66749626e0a7b60e Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 14:24:05 -0400 Subject: [PATCH 11/12] most tech review, test source: --- docs/includes/extracts-option-requires.yaml | 14 +++++----- docs/tutorial/encryption.txt | 30 ++++++++++----------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/includes/extracts-option-requires.yaml b/docs/includes/extracts-option-requires.yaml index 728eba275..edc1c0d37 100644 --- a/docs/includes/extracts-option-requires.yaml +++ b/docs/includes/extracts-option-requires.yaml @@ -4,44 +4,44 @@ content: | exception at execution time if specified for an older server version. --- ref: option-requires-4.2 -inherit: +source: file: extracts-option-requires.yaml ref: _option-requires-version replacement: version: "4.2" --- ref: option-requires-4.4 -inherit: +source: file: extracts-option-requires.yaml ref: _option-requires-version replacement: version: "4.4" --- ref: option-requires-5.0 -inherit: +source: file: extracts-option-requires.yaml ref: _option-requires-version replacement: version: "5.0" --- ref: option-requires-5.3 -inherit: +source: file: extracts-option-requires.yaml ref: _option-requires-version replacement: version: "5.3" --- ref: option-requires-6.0 -inherit: +source: file: extracts-option-requires.yaml ref: _option-requires-version replacement: version: "6.0" --- ref: option-requires-7.0 -inherit: +source: file: extracts-option-requires.yaml ref: _option-requires-version replacement: version: "7.0" -... \ No newline at end of file +... diff --git a/docs/tutorial/encryption.txt b/docs/tutorial/encryption.txt index 3409510cb..375662f4b 100644 --- a/docs/tutorial/encryption.txt +++ b/docs/tutorial/encryption.txt @@ -23,39 +23,39 @@ Additionally, either ``crypt_shared`` or ``mongocryptd`` are required in order t use *automatic* client-side encryption. Neither is required for *explicit* encryption. -crypt_shared -~~~~~~~~~~~~ +``crypt_shared`` +~~~~~~~~~~~~~~~~ The :manual:`Automatic Encryption 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 ` -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 `. -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 `. For detailed installation instructions see the :manual:`MongoDB documentation on 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. @@ -65,11 +65,11 @@ mongocryptd performs the following: see :manual:`Supported Operations for Automatic Encryption `. 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 `. -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 From ea4e6527a542d99f018617ea91e131cb211f1182 Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 7 May 2024 14:33:43 -0400 Subject: [PATCH 12/12] newline --- docs/includes/extracts-option-requires.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/includes/extracts-option-requires.yaml b/docs/includes/extracts-option-requires.yaml index edc1c0d37..485ea8996 100644 --- a/docs/includes/extracts-option-requires.yaml +++ b/docs/includes/extracts-option-requires.yaml @@ -45,3 +45,4 @@ source: replacement: version: "7.0" ... +