DOCSP-30813 Add buildInfo() Command and Binary Flag (#282)

* DOCSP-30813 Add buildInfo() Command and Binary Flag

* *

* *

* *

* *

* *

* *

* *

* *

* *

* *

* IR 1

* *

* *

* indents

* *

Author: ianf-mongodb

source/includes/examples/ex-build-info-command.rst

@@ -0,0 +1,25 @@
+Returns the following JSON-formatted document that describes 
+your ``mongosh`` build and driver dependencies:
+
+.. code-block:: javascript
+   :copyable: false
+
+   {
+     version: '1.10.1',
+     distributionKind: 'packaged',
+     buildArch: 'x64',
+     buildPlatform: 'linux',
+     buildTarget: 'unknown',
+     buildTime: '2023-06-21T09:49:37.225Z',
+     gitVersion: '05ad91b4dd40382a13f27abe1ae8c3f9f52a38f7',
+     nodeVersion: 'v16.20.1',
+     opensslVersion: '3.1.1',
+     sharedOpenssl: true,
+     runtimeArch: 'x64',
+     runtimePlatform: 'darwin',
+     deps: {
+        nodeDriverVersion: '5.6.0',
+        libmongocryptVersion: undefined,
+        libmongocryptNodeBindingsVersion: undefined
+      }
+   }

source/includes/examples/ex-build-info-flag.rst

@@ -0,0 +1,30 @@
+You can check the build information and driver dependencies of your 
+:binary:`~bin.mongosh` binary by running the following command 
+from your terminal:
+
+.. code-block:: sh
+
+   mongosh --build-info
+
+This command returns the following JSON-formatted document:
+
+.. code-block:: javascript
+   :copyable: false
+
+   {
+     version: '1.10.1',
+     distributionKind: 'packaged',
+     buildArch: 'x64',
+     buildPlatform: 'linux',
+     buildTarget: 'unknown',
+     buildTime: '2023-06-21T09:49:37.225Z',
+     gitVersion: '05ad91b4dd40382a13f27abe1ae8c3f9f52a38f7',
+     nodeVersion: 'v16.20.1',
+     opensslVersion: '3.1.1',
+     sharedOpenssl: true,
+     runtimeArch: 'x64',
+     runtimePlatform: 'darwin',
+     deps: {
+        nodeDriverVersion: '5.6.0'
+      }
+   }

source/reference/methods.txt

@@ -848,6 +848,12 @@ Native Methods
 
      - Description
 
+   * - .. _mongosh-native-method-buildInfo():
+
+       ``buildInfo()``
+
+     - .. include:: /includes/examples/ex-build-info-command.rst
+
    * - .. _mongosh-native-method-cd:
 
        ``cd()``

source/reference/options.txt

@@ -10,8 +10,8 @@ Options
    :depth: 2
    :class: singlecol
 
-Use the following options to control various aspects of your
-|mdb-shell| connection and behavior.
+Use the following options to view and control various aspects of your
+|mdb-shell|.
 
 General Options
 ---------------
@@ -20,8 +20,12 @@ General Options
 
 .. option:: --build-info
 
-   Returns a JSON-formatted document with information about the
-   :binary:`~bin.mongosh` build.
+   Returns a JSON-formatted document with information about
+   your :binary:`~bin.mongosh` build and driver dependencies.
+
+   **Example: View Build Information**
+
+   .. include:: /includes/examples/ex-build-info-flag.rst
 
 .. option:: --eval <javascript>