Skip to content

Commit 3fe81c6

Browse files
andf-mongodbandf-mongodb
committed
DOCSP-14923 fix deprecated directive for NextGen
1 parent 737a14f commit 3fe81c6

File tree

12 files changed

+209
-62
lines changed

12 files changed

+209
-62
lines changed

‎source/includes/deprecation-uniqueDocs.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
.. deprecated:: 2.6
2+
23
Geospatial queries no longer return duplicate results. The
34
:query:`$uniqueDocs` operator has no impact on results.

‎source/reference/configuration-options.txt

Lines changed: 45 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1639,7 +1639,9 @@ Core Options
16391639

16401640
*Type*: boolean
16411641

1642-
.. deprecated:: 2.6 Use :setting:`net.tls.mode: requireTLS <net.tls.mode>` instead.
1642+
.. deprecated:: 2.6
1643+
1644+
Use :setting:`net.tls.mode: requireTLS <net.tls.mode>` instead.
16431645

16441646
Enable or disable TLS/SSL for :binary:`~bin.mongos` or :binary:`~bin.mongod`.
16451647

@@ -1655,7 +1657,9 @@ Core Options
16551657

16561658
*Type*: string
16571659

1658-
.. deprecated:: 4.2 Use :setting:`net.tls.mode` instead.
1660+
.. deprecated:: 4.2
1661+
1662+
Use :setting:`net.tls.mode` instead.
16591663

16601664
Enables TLS/SSL or mixed TLS/SSL used for all network connections. The
16611665
argument to the :setting:`net.ssl.mode` setting can be one of the following:
@@ -1696,7 +1700,9 @@ Core Options
16961700
*Type*: string
16971701

16981702

1699-
.. deprecated:: 4.2 Use :setting:`net.tls.certificateKeyFile` instead.
1703+
.. deprecated:: 4.2
1704+
1705+
Use :setting:`net.tls.certificateKeyFile` instead.
17001706

17011707
The :file:`.pem` file that contains both the TLS/SSL certificate
17021708
and key.
@@ -1730,7 +1736,9 @@ Core Options
17301736

17311737
*Type*: string
17321738

1733-
.. deprecated:: 4.2 Use :setting:`net.tls.certificateKeyFilePassword` instead.
1739+
.. deprecated:: 4.2
1740+
1741+
Use :setting:`net.tls.certificateKeyFilePassword` instead.
17341742

17351743
The password to de-crypt the certificate-key file (i.e.
17361744
:setting:`~net.ssl.PEMKeyFile`). Use the
@@ -1764,7 +1772,9 @@ Core Options
17641772
*Type*: string
17651773

17661774

1767-
.. deprecated:: 4.2 Use :setting:`net.tls.certificateSelector` instead.
1775+
.. deprecated:: 4.2
1776+
1777+
Use :setting:`net.tls.certificateSelector` instead.
17681778

17691779
.. versionadded:: 4.0
17701780

@@ -1806,7 +1816,9 @@ Core Options
18061816

18071817
*Type*: string
18081818

1809-
.. deprecated:: 4.2 Use :setting:`net.tls.clusterCertificateSelector` instead.
1819+
.. deprecated:: 4.2
1820+
1821+
Use :setting:`net.tls.clusterCertificateSelector` instead.
18101822

18111823
.. versionadded:: 4.0
18121824

@@ -1847,7 +1859,9 @@ Core Options
18471859

18481860
*Type*: string
18491861

1850-
.. deprecated:: 4.2 Use :setting:`net.tls.clusterFile` instead.
1862+
.. deprecated:: 4.2
1863+
1864+
Use :setting:`net.tls.clusterFile` instead.
18511865

18521866
The :file:`.pem` file that contains the x.509 certificate-key
18531867
file for :ref:`membership authentication <x509-internal-authentication>`
@@ -1883,7 +1897,9 @@ Core Options
18831897

18841898
*Type*: string
18851899

1886-
.. deprecated:: 4.2 Use :setting:`net.tls.clusterPassword` instead.
1900+
.. deprecated:: 4.2
1901+
1902+
Use :setting:`net.tls.clusterPassword` instead.
18871903

18881904
The password to de-crypt the x.509 certificate-key file specified
18891905
with ``--sslClusterFile``. Use the :setting:`net.ssl.clusterPassword`
@@ -1917,7 +1933,9 @@ Core Options
19171933
*Type*: string
19181934

19191935

1920-
.. deprecated:: 4.2 Use :setting:`net.tls.CAFile` instead.
1936+
.. deprecated:: 4.2
1937+
1938+
Use :setting:`net.tls.CAFile` instead.
19211939

19221940
The :file:`.pem` file that contains the root certificate chain
19231941
from the Certificate Authority. Specify the file name of the
@@ -1939,7 +1957,9 @@ Core Options
19391957
*Type*: string
19401958

19411959

1942-
.. deprecated:: 4.2 Use :setting:`net.tls.clusterCAFile` instead.
1960+
.. deprecated:: 4.2
1961+
1962+
Use :setting:`net.tls.clusterCAFile` instead.
19431963

19441964
The :file:`.pem` file that contains the root certificate chain from
19451965
the Certificate Authority used to validate the certificate presented
@@ -1981,7 +2001,9 @@ Core Options
19812001
*Type*: string
19822002

19832003

1984-
.. deprecated:: 4.2 Use :setting:`net.tls.CRLFile` instead.
2004+
.. deprecated:: 4.2
2005+
2006+
Use :setting:`net.tls.CRLFile` instead.
19852007

19862008
The :file:`.pem` file that contains the Certificate Revocation
19872009
List. Specify the file name of the :file:`.pem` file using relative or
@@ -2010,7 +2032,10 @@ Core Options
20102032

20112033
*Type*: boolean
20122034

2013-
.. deprecated:: 4.2 Use :setting:`net.tls.allowConnectionsWithoutCertificates` instead.
2035+
.. deprecated:: 4.2
2036+
2037+
Use :setting:`net.tls.allowConnectionsWithoutCertificates`
2038+
instead.
20142039

20152040
For clients that do not present certificates, :binary:`~bin.mongos` or :binary:`~bin.mongod` bypasses
20162041
TLS/SSL certificate validation when establishing the connection.
@@ -2030,7 +2055,9 @@ Core Options
20302055
*Type*: boolean
20312056

20322057

2033-
.. deprecated:: 4.2 Use :setting:`net.tls.allowInvalidCertificates` instead.
2058+
.. deprecated:: 4.2
2059+
2060+
Use :setting:`net.tls.allowInvalidCertificates` instead.
20342061

20352062
Enable or disable the validation checks for TLS/SSL certificates on other
20362063
servers in the cluster and allows the use of invalid certificates to
@@ -2069,8 +2096,9 @@ Core Options
20692096

20702097
*Type*: string
20712098

2072-
.. deprecated:: 4.2 Use :setting:`net.tls.disabledProtocols` instead.
2099+
.. deprecated:: 4.2
20732100

2101+
Use :setting:`net.tls.disabledProtocols` instead.
20742102

20752103
Prevents a MongoDB server running with TLS/SSL from accepting
20762104
incoming connections that use a specific protocol or protocols. To
@@ -2106,7 +2134,9 @@ Core Options
21062134

21072135
*Type*: boolean
21082136

2109-
.. deprecated:: 4.2 Use :setting:`net.tls.FIPSMode` instead.
2137+
.. deprecated:: 4.2
2138+
2139+
Use :setting:`net.tls.FIPSMode` instead.
21102140

21112141
Enable or disable the use of the FIPS mode of the TLS/SSL
21122142
library for the :binary:`~bin.mongos` or :binary:`~bin.mongod`. Your system must have a FIPS

‎source/reference/method/db.collection.ensureIndex.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ Definition
1919
.. include:: /includes/fact-mongo-shell-method.rst
2020

2121

22-
.. deprecated:: 3.0.0
22+
.. deprecated:: 3.0
23+
2324
:method:`db.collection.ensureIndex()` has been replaced by
2425
:method:`db.collection.createIndex()`.
2526

‎source/reference/method/db.getProfilingLevel.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ db.getProfilingLevel()
1616
":dbcommand:`profile`" and returns the current profiling level.
1717

1818
.. deprecated:: 1.8.4
19+
1920
Use :method:`db.getProfilingStatus()` for related functionality.

‎source/reference/method/db.removeUser.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ db.removeUser()
1111
:class: singlecol
1212

1313
.. deprecated:: 2.6
14+
1415
Use :method:`db.dropUser()` instead
1516
of :method:`db.removeUser()`
1617

‎source/reference/operator/aggregation/substr.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Definition
1616
.. expression:: $substr
1717

1818
.. deprecated:: 3.4
19+
1920
:expression:`$substr` is now an alias for
2021
:expression:`$substrBytes`.
2122

‎source/reference/operator/query/geoWithin.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,5 +194,6 @@ specify the custom MongoDB coordinate reference system. For example:
194194
.. query:: $within
195195

196196
.. deprecated:: 2.4
197+
197198
:query:`$geoWithin` replaces :query:`$within` in MongoDB
198199
2.4.

‎source/reference/parameters.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,9 @@ Authentication Parameters
716716

717717
*Default*: false
718718

719-
.. deprecated:: 4.2 Use :parameter:`tlsWithholdClientCertificate` instead.
719+
.. deprecated:: 4.2
720+
721+
Use :parameter:`tlsWithholdClientCertificate` instead.
720722

721723
|both|
722724

‎source/reference/privilege-documents.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
:class: singlecol
1414

1515
.. deprecated:: 2.6
16+
1617
MongoDB 2.6 introduced a new model for user
1718
credentials and privileges and no longer uses privilege documents.
1819
See :doc:`/reference/system-users-collection`.

‎source/reference/program/mongo.txt

Lines changed: 37 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -676,7 +676,9 @@ SSL Options (Deprecated)
676676
.. option:: --ssl
677677

678678

679-
.. deprecated:: 4.2 Use :option:`--tls <mongo --tls>` instead.
679+
.. deprecated:: 4.2
680+
681+
Use :option:`--tls <mongo --tls>` instead.
680682

681683
Enables connection to a :binary:`~bin.mongod` or :binary:`~bin.mongos` that has
682684
TLS/SSL support enabled.
@@ -689,7 +691,10 @@ SSL Options (Deprecated)
689691
.. option:: --sslPEMKeyFile <filename>
690692

691693

692-
.. deprecated:: 4.2 Use :option:`--tlsCertificateKeyFile <mongo --tlsCertificateKeyFile>` instead.
694+
.. deprecated:: 4.2
695+
696+
Use :option:`--tlsCertificateKeyFile
697+
<mongo --tlsCertificateKeyFile>` instead.
693698

694699
Specifies the :file:`.pem` file that contains both the TLS/SSL certificate
695700
and key. Specify the file name of the :file:`.pem` file using relative
@@ -706,7 +711,10 @@ SSL Options (Deprecated)
706711
.. option:: --sslPEMKeyPassword <value>
707712

708713

709-
.. deprecated:: 4.2 Use :option:`--tlsCertificateKeyFilePassword <mongo --tlsCertificateKeyFilePassword>` instead.
714+
.. deprecated:: 4.2
715+
716+
Use :option:`--tlsCertificateKeyFilePassword
717+
<mongo --tlsCertificateKeyFilePassword>` instead.
710718

711719
Specifies the password to de-crypt the certificate-key file (i.e.
712720
``--sslPEMKeyFile``). Use the :option:`--sslPEMKeyPassword` option only if the
@@ -722,9 +730,10 @@ SSL Options (Deprecated)
722730

723731
.. option:: --sslCAFile <filename>
724732

725-
.. deprecated:: 4.2 Use :option:`--tlsCAFile <mongo --tlsCAFile>` instead.
726-
727-
733+
.. deprecated:: 4.2
734+
735+
Use :option:`--tlsCAFile <mongo --tlsCAFile>` instead.
736+
728737
Specifies the :file:`.pem` file that contains the root certificate chain
729738
from the Certificate Authority. Specify the file name of the
730739
:file:`.pem` file using relative or absolute paths.
@@ -737,7 +746,10 @@ SSL Options (Deprecated)
737746
.. option:: --sslCertificateSelector <parameter>=<value>
738747

739748

740-
.. deprecated:: 4.2 Use :option:`--tlsCertificateSelector <mongo --tlsCertificateSelector>` instead.
749+
.. deprecated:: 4.2
750+
751+
Use :option:`--tlsCertificateSelector
752+
<mongo --tlsCertificateSelector>` instead.
741753

742754
.. versionadded:: 4.0
743755

@@ -760,7 +772,9 @@ SSL Options (Deprecated)
760772
.. option:: --sslCRLFile <filename>
761773

762774

763-
.. deprecated:: 4.2 Use :option:`--tlsCRLFile <mongo --tlsCRLFile>` instead.
775+
.. deprecated:: 4.2
776+
777+
Use :option:`--tlsCRLFile <mongo --tlsCRLFile>` instead.
764778

765779
Specifies the :file:`.pem` file that contains the Certificate Revocation
766780
List. Specify the file name of the :file:`.pem` file using relative or
@@ -779,7 +793,9 @@ SSL Options (Deprecated)
779793

780794
.. option:: --sslFIPSMode
781795

782-
.. deprecated:: 4.2 Use :option:`--tlsFIPSMode <mongo --tlsFIPSMode>` instead.
796+
.. deprecated:: 4.2
797+
798+
Use :option:`--tlsFIPSMode <mongo --tlsFIPSMode>` instead.
783799

784800
Directs the :program:`mongo` to use the FIPS mode of the TLS/SSL
785801
library. Your system must have a FIPS compliant library to use
@@ -790,8 +806,10 @@ SSL Options (Deprecated)
790806

791807
.. option:: --sslAllowInvalidCertificates
792808

793-
.. deprecated:: 4.2 Use :option:`--tlsAllowInvalidCertificates <mongo --tlsAllowInvalidCertificates>` instead.
794-
809+
.. deprecated:: 4.2
810+
811+
Use :option:`--tlsAllowInvalidCertificates
812+
<mongo --tlsAllowInvalidCertificates>` instead.
795813

796814
Bypasses the validation checks for server certificates and allows
797815
the use of invalid certificates to connect.
@@ -810,7 +828,10 @@ SSL Options (Deprecated)
810828

811829
.. option:: --sslAllowInvalidHostnames
812830

813-
.. deprecated:: 4.2 Use :option:`--tlsAllowInvalidHostnames <mongo --tlsAllowInvalidHostnames>` instead.
831+
.. deprecated:: 4.2
832+
833+
Use :option:`--tlsAllowInvalidHostnames
834+
<mongo --tlsAllowInvalidHostnames>` instead.
814835

815836
Disables the validation of the hostnames in TLS/SSL certificates. Allows
816837
:program:`mongo` to connect to MongoDB instances even if the hostname in their
@@ -822,7 +843,10 @@ SSL Options (Deprecated)
822843
.. option:: --sslDisabledProtocols <string>
823844

824845

825-
.. deprecated:: 4.2 Use :option:`--tlsDisabledProtocols <mongo --tlsDisabledProtocols>` instead.
846+
.. deprecated:: 4.2
847+
848+
Use :option:`--tlsDisabledProtocols
849+
<mongo --tlsDisabledProtocols>` instead.
826850

827851
Disables the specified TLS protocols. The option recognizes the
828852
following protocols: ``TLS1_0``, ``TLS1_1``, ``TLS1_2``, and

0 commit comments

Comments
 (0)