From 06de0a5ebc8c4d6f71c59cc7a479c943f78aa501 Mon Sep 17 00:00:00 2001 From: Nora Reidy Date: Fri, 10 May 2024 13:10:18 -0400 Subject: [PATCH 1/2] DOCSP-37027: Additional 1.17 build fixes (#1301) --- docs/tutorial/encryption.txt | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/tutorial/encryption.txt b/docs/tutorial/encryption.txt index 3a9121658..c16845f9e 100644 --- a/docs/tutorial/encryption.txt +++ b/docs/tutorial/encryption.txt @@ -19,45 +19,45 @@ 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 -~~~~~~~~~~~~ +``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. @@ -67,11 +67,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. @@ -208,7 +208,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 From 528d2d1ec3d8995f8c7c635f7e76731632556832 Mon Sep 17 00:00:00 2001 From: Jeremy Mikola Date: Tue, 21 May 2024 16:45:54 -0400 Subject: [PATCH 2/2] DOCSP-38371: Remove broken link (#1312) (#1314) Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com> --- docs/tutorial/decimal128.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tutorial/decimal128.txt b/docs/tutorial/decimal128.txt index f73074f35..eced91cfe 100644 --- a/docs/tutorial/decimal128.txt +++ b/docs/tutorial/decimal128.txt @@ -13,8 +13,8 @@ Decimal128 Overview -------- -MongoDB 3.4 introduced support for a :manual:`Decimal128 BSON type -`, which is a 128-bit decimal-based +MongoDB 3.4 introduced support for a Decimal128 BSON type, +which is a 128-bit decimal-based floating-point value capable of emulating decimal rounding with exact precision. This functionality is intended for applications that handle :manual:`monetary data `, such as financial and tax computations.