Skip to content

Runtime options 2501 #1554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 18 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 0 additions & 30 deletions source/includes/manpage-options-auth.rst

This file was deleted.

11 changes: 6 additions & 5 deletions source/includes/manpage-options-ssl-mongo-shell.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. include:: /includes/replace-pem-path-name.rst

.. option:: --ssl

.. versionadded:: 2.2
Expand All @@ -16,7 +14,8 @@
.. include:: /includes/note-general-ssl-support.rst

Specifies the :file:`.pem` file that contains both the SSL
certificate and key. |pem-path-name|
certificate and key. Specify the file name of the :file:`.pem` file
using relative or absolute paths.

Required when using the :option:`--ssl` option to connect to
:program:`mongod` or :program:`mongos` that have
Expand Down Expand Up @@ -47,7 +46,8 @@
.. include:: /includes/note-general-ssl-support.rst

Specifies the :file:`.pem` file that contains the root certificate
chain from the Certificate Authority. |pem-path-name|
chain from the Certificate Authority. Specify the file name of the
:file:`.pem` file using relative or absolute paths.

.. option:: --sslCRLFile <filename>

Expand All @@ -56,7 +56,8 @@
.. include:: /includes/note-general-ssl-support.rst

Specifies the :file:`.pem` file that contains the Certificate
Revocation List. |pem-path-name|
Revocation List. Specify the file name of the :file:`.pem` file
using relative or absolute paths.

.. option:: --sslFIPSMode

Expand Down
90 changes: 0 additions & 90 deletions source/includes/manpage-options-ssl-tools.rst

This file was deleted.

11 changes: 6 additions & 5 deletions source/includes/manpage-options-ssl.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
.. use |binary-name| to refer to ``mongos``/``mongod``.

.. include:: /includes/replace-pem-path-name.rst

.. option:: --sslOnNormalPorts

.. deprecated:: 2.5.3
Expand Down Expand Up @@ -58,7 +56,8 @@
.. include:: /includes/note-general-ssl-support.rst

Specifies the :file:`.pem` file that contains both the SSL
certificate and key. |pem-path-name|
certificate and key. Specify the file name of the :file:`.pem`
file using relative or absolute paths.

When SSL is enabled, you must specify :option:`--sslPEMKeyFile`.

Expand Down Expand Up @@ -93,7 +92,8 @@
.. include:: /includes/note-general-ssl-support.rst

Specifies the :file:`.pem` file that contains the root certificate
chain from the Certificate Authority. |pem-path-name|
chain from the Certificate Authority. Specify the file name of the
:file:`.pem` file using relative or absolute paths.

.. option:: --sslCRLFile <filename>

Expand All @@ -102,7 +102,8 @@
.. include:: /includes/note-general-ssl-support.rst

Specifies the :file:`.pem` file that contains the Certificate
Revocation List. |pem-path-name|
Revocation List. Specify the file name of the :file:`.pem`
file using relative or absolute paths.

.. option:: --sslWeakCertificateValidation

Expand Down
69 changes: 69 additions & 0 deletions source/includes/options-bsondump.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# This file borrows content from other files, including
# /includes/options-shared.yaml, which uses
# {{program}} to refer to the tool.
#
program: bsondump
name: help
inherit:
name: help
program: _shared
file: options-shared.yaml
---
program: bsondump
name: filter
directive: option
args: '<JSON>'
description: |
Limits the documents that :program:`bsondump` exports to only those
documents that match the :term:`JSON document` specified as
``'<JSON>'``. Be sure to include the document in single quotes to avoid
interaction with your system's shell environment.
optional: true
---
program: bsondump
name: noobjcheck
inherit:
name: noobjcheck
program: mongod
file: options-mongod.yaml
---
program: bsondump
name: objcheck
directive: option
args: null
description: |
Validates each :term:`BSON` object before outputting it in :term:`JSON`
format. By default, :program:`bsondump` enables :option:`--objcheck`.
For objects with a high degree of sub-document nesting,
:option:`--objcheck` can have a small impact on performance. You can set
:option:`--noobjcheck` to disable object checking.

.. versionchanged:: 2.4
MongoDB enables :option:`--objcheck` by default, to prevent any
client from inserting malformed or invalid BSON into a MongoDB
database.
optional: true
---
program: bsondump
name: type
directive: option
args: <=json|=debug>
description: |
Changes the operation of :program:`bsondump` from outputting
":term:`JSON`" (the default) to a debugging format.
optional: true
---
program: bsondump
name: verbose
inherit:
name: verbose
program: _shared
file: options-shared.yaml
---
program: bsondump
name: version
inherit:
name: version
program: _shared
file: options-shared.yaml
...
20 changes: 20 additions & 0 deletions source/includes/options-mongod.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# This file borrows content from other files, including
# /includes/options-shared.yaml, which uses
# {{program}} to refer to the tool.
#
program: mongod
name: noobjcheck
directive: option
args: null
description: |
.. versionadded:: 2.4

Disables the default document validation that MongoDB performs on all
incoming BSON documents.
optional: true
#
#
# This yaml file is in-progress
#
#
...
Loading