Skip to content

Commit 800c368

Browse files
andf-mongodbandf-mongodb
committed
DOCSP-14923 fix deprecated directive for NextGen
1 parent 86d5f0c commit 800c368

File tree

12 files changed

+210
-63
lines changed

12 files changed

+210
-63
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
@@ -1628,7 +1628,9 @@ Core Options
16281628

16291629
*Type*: boolean
16301630

1631-
.. deprecated:: 2.6 Use :setting:`net.tls.mode: requireTLS <net.tls.mode>` instead.
1631+
.. deprecated:: 2.6
1632+
1633+
Use :setting:`net.tls.mode: requireTLS <net.tls.mode>` instead.
16321634

16331635
Enable or disable TLS/SSL for :binary:`~bin.mongos` or :binary:`~bin.mongod`.
16341636

@@ -1644,7 +1646,9 @@ Core Options
16441646

16451647
*Type*: string
16461648

1647-
.. deprecated:: 4.2 Use :setting:`net.tls.mode` instead.
1649+
.. deprecated:: 4.2
1650+
1651+
Use :setting:`net.tls.mode` instead.
16481652

16491653
Enables TLS/SSL or mixed TLS/SSL used for all network connections. The
16501654
argument to the :setting:`net.ssl.mode` setting can be one of the following:
@@ -1685,7 +1689,9 @@ Core Options
16851689
*Type*: string
16861690

16871691

1688-
.. deprecated:: 4.2 Use :setting:`net.tls.certificateKeyFile` instead.
1692+
.. deprecated:: 4.2
1693+
1694+
Use :setting:`net.tls.certificateKeyFile` instead.
16891695

16901696
The :file:`.pem` file that contains both the TLS/SSL certificate
16911697
and key.
@@ -1719,7 +1725,9 @@ Core Options
17191725

17201726
*Type*: string
17211727

1722-
.. deprecated:: 4.2 Use :setting:`net.tls.certificateKeyFilePassword` instead.
1728+
.. deprecated:: 4.2
1729+
1730+
Use :setting:`net.tls.certificateKeyFilePassword` instead.
17231731

17241732
The password to de-crypt the certificate-key file (i.e.
17251733
:setting:`~net.ssl.PEMKeyFile`). Use the
@@ -1753,7 +1761,9 @@ Core Options
17531761
*Type*: string
17541762

17551763

1756-
.. deprecated:: 4.2 Use :setting:`net.tls.certificateSelector` instead.
1764+
.. deprecated:: 4.2
1765+
1766+
Use :setting:`net.tls.certificateSelector` instead.
17571767

17581768
.. versionadded:: 4.0
17591769

@@ -1795,7 +1805,9 @@ Core Options
17951805

17961806
*Type*: string
17971807

1798-
.. deprecated:: 4.2 Use :setting:`net.tls.clusterCertificateSelector` instead.
1808+
.. deprecated:: 4.2
1809+
1810+
Use :setting:`net.tls.clusterCertificateSelector` instead.
17991811

18001812
.. versionadded:: 4.0
18011813

@@ -1836,7 +1848,9 @@ Core Options
18361848

18371849
*Type*: string
18381850

1839-
.. deprecated:: 4.2 Use :setting:`net.tls.clusterFile` instead.
1851+
.. deprecated:: 4.2
1852+
1853+
Use :setting:`net.tls.clusterFile` instead.
18401854

18411855
The :file:`.pem` file that contains the x.509 certificate-key
18421856
file for :ref:`membership authentication <x509-internal-authentication>`
@@ -1872,7 +1886,9 @@ Core Options
18721886

18731887
*Type*: string
18741888

1875-
.. deprecated:: 4.2 Use :setting:`net.tls.clusterPassword` instead.
1889+
.. deprecated:: 4.2
1890+
1891+
Use :setting:`net.tls.clusterPassword` instead.
18761892

18771893
The password to de-crypt the x.509 certificate-key file specified
18781894
with ``--sslClusterFile``. Use the :setting:`net.ssl.clusterPassword`
@@ -1906,7 +1922,9 @@ Core Options
19061922
*Type*: string
19071923

19081924

1909-
.. deprecated:: 4.2 Use :setting:`net.tls.CAFile` instead.
1925+
.. deprecated:: 4.2
1926+
1927+
Use :setting:`net.tls.CAFile` instead.
19101928

19111929
The :file:`.pem` file that contains the root certificate chain
19121930
from the Certificate Authority. Specify the file name of the
@@ -1928,7 +1946,9 @@ Core Options
19281946
*Type*: string
19291947

19301948

1931-
.. deprecated:: 4.2 Use :setting:`net.tls.clusterCAFile` instead.
1949+
.. deprecated:: 4.2
1950+
1951+
Use :setting:`net.tls.clusterCAFile` instead.
19321952

19331953
The :file:`.pem` file that contains the root certificate chain from
19341954
the Certificate Authority used to validate the certificate presented
@@ -1970,7 +1990,9 @@ Core Options
19701990
*Type*: string
19711991

19721992

1973-
.. deprecated:: 4.2 Use :setting:`net.tls.CRLFile` instead.
1993+
.. deprecated:: 4.2
1994+
1995+
Use :setting:`net.tls.CRLFile` instead.
19741996

19751997
The :file:`.pem` file that contains the Certificate Revocation
19761998
List. Specify the file name of the :file:`.pem` file using relative or
@@ -1993,7 +2015,10 @@ Core Options
19932015

19942016
*Type*: boolean
19952017

1996-
.. deprecated:: 4.2 Use :setting:`net.tls.allowConnectionsWithoutCertificates` instead.
2018+
.. deprecated:: 4.2
2019+
2020+
Use :setting:`net.tls.allowConnectionsWithoutCertificates`
2021+
instead.
19972022

19982023
For clients that do not present certificates, :binary:`~bin.mongos` or :binary:`~bin.mongod` bypasses
19992024
TLS/SSL certificate validation when establishing the connection.
@@ -2013,7 +2038,9 @@ Core Options
20132038
*Type*: boolean
20142039

20152040

2016-
.. deprecated:: 4.2 Use :setting:`net.tls.allowInvalidCertificates` instead.
2041+
.. deprecated:: 4.2
2042+
2043+
Use :setting:`net.tls.allowInvalidCertificates` instead.
20172044

20182045
Enable or disable the validation checks for TLS/SSL certificates on other
20192046
servers in the cluster and allows the use of invalid certificates to
@@ -2052,8 +2079,9 @@ Core Options
20522079

20532080
*Type*: string
20542081

2055-
.. deprecated:: 4.2 Use :setting:`net.tls.disabledProtocols` instead.
2082+
.. deprecated:: 4.2
20562083

2084+
Use :setting:`net.tls.disabledProtocols` instead.
20572085

20582086
Prevents a MongoDB server running with TLS/SSL from accepting
20592087
incoming connections that use a specific protocol or protocols. To
@@ -2089,7 +2117,9 @@ Core Options
20892117

20902118
*Type*: boolean
20912119

2092-
.. deprecated:: 4.2 Use :setting:`net.tls.FIPSMode` instead.
2120+
.. deprecated:: 4.2
2121+
2122+
Use :setting:`net.tls.FIPSMode` instead.
20932123

20942124
Enable or disable the use of the FIPS mode of the TLS/SSL
20952125
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: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ Definition
1919
.. include:: /includes/fact-mongo-shell-method.rst
2020

2121

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

2627
Creates an index on the specified field if the index does not

‎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
@@ -561,7 +561,9 @@ Authentication Parameters
561561

562562
*Default*: false
563563

564-
.. deprecated:: 4.2 Use :parameter:`tlsWithholdClientCertificate` instead.
564+
.. deprecated:: 4.2
565+
566+
Use :parameter:`tlsWithholdClientCertificate` instead.
565567

566568
|both|
567569

‎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
@@ -628,7 +628,9 @@ SSL Options (Deprecated)
628628
.. option:: --ssl
629629

630630

631-
.. deprecated:: 4.2 Use :option:`--tls <mongo --tls>` instead.
631+
.. deprecated:: 4.2
632+
633+
Use :option:`--tls <mongo --tls>` instead.
632634

633635
Enables connection to a :binary:`~bin.mongod` or :binary:`~bin.mongos` that has
634636
TLS/SSL support enabled.
@@ -641,7 +643,10 @@ SSL Options (Deprecated)
641643
.. option:: --sslPEMKeyFile <filename>
642644

643645

644-
.. deprecated:: 4.2 Use :option:`--tlsCertificateKeyFile <mongo --tlsCertificateKeyFile>` instead.
646+
.. deprecated:: 4.2
647+
648+
Use :option:`--tlsCertificateKeyFile
649+
<mongo --tlsCertificateKeyFile>` instead.
645650

646651
Specifies the :file:`.pem` file that contains both the TLS/SSL certificate
647652
and key. Specify the file name of the :file:`.pem` file using relative
@@ -658,7 +663,10 @@ SSL Options (Deprecated)
658663
.. option:: --sslPEMKeyPassword <value>
659664

660665

661-
.. deprecated:: 4.2 Use :option:`--tlsCertificateKeyFilePassword <mongo --tlsCertificateKeyFilePassword>` instead.
666+
.. deprecated:: 4.2
667+
668+
Use :option:`--tlsCertificateKeyFilePassword
669+
<mongo --tlsCertificateKeyFilePassword>` instead.
662670

663671
Specifies the password to de-crypt the certificate-key file (i.e.
664672
``--sslPEMKeyFile``). Use the :option:`--sslPEMKeyPassword` option only if the
@@ -674,9 +682,10 @@ SSL Options (Deprecated)
674682

675683
.. option:: --sslCAFile <filename>
676684

677-
.. deprecated:: 4.2 Use :option:`--tlsCAFile <mongo --tlsCAFile>` instead.
678-
679-
685+
.. deprecated:: 4.2
686+
687+
Use :option:`--tlsCAFile <mongo --tlsCAFile>` instead.
688+
680689
Specifies the :file:`.pem` file that contains the root certificate chain
681690
from the Certificate Authority. Specify the file name of the
682691
:file:`.pem` file using relative or absolute paths.
@@ -689,7 +698,10 @@ SSL Options (Deprecated)
689698
.. option:: --sslCertificateSelector <parameter>=<value>
690699

691700

692-
.. deprecated:: 4.2 Use :option:`--tlsCertificateSelector <mongo --tlsCertificateSelector>` instead.
701+
.. deprecated:: 4.2
702+
703+
Use :option:`--tlsCertificateSelector
704+
<mongo --tlsCertificateSelector>` instead.
693705

694706
.. versionadded:: 4.0
695707

@@ -712,7 +724,9 @@ SSL Options (Deprecated)
712724
.. option:: --sslCRLFile <filename>
713725

714726

715-
.. deprecated:: 4.2 Use :option:`--tlsCRLFile <mongo --tlsCRLFile>` instead.
727+
.. deprecated:: 4.2
728+
729+
Use :option:`--tlsCRLFile <mongo --tlsCRLFile>` instead.
716730

717731
Specifies the :file:`.pem` file that contains the Certificate Revocation
718732
List. Specify the file name of the :file:`.pem` file using relative or
@@ -723,7 +737,9 @@ SSL Options (Deprecated)
723737

724738
.. option:: --sslFIPSMode
725739

726-
.. deprecated:: 4.2 Use :option:`--tlsFIPSMode <mongo --tlsFIPSMode>` instead.
740+
.. deprecated:: 4.2
741+
742+
Use :option:`--tlsFIPSMode <mongo --tlsFIPSMode>` instead.
727743

728744
Directs the :program:`mongo` to use the FIPS mode of the TLS/SSL
729745
library. Your system must have a FIPS compliant library to use
@@ -734,8 +750,10 @@ SSL Options (Deprecated)
734750

735751
.. option:: --sslAllowInvalidCertificates
736752

737-
.. deprecated:: 4.2 Use :option:`--tlsAllowInvalidCertificates <mongo --tlsAllowInvalidCertificates>` instead.
738-
753+
.. deprecated:: 4.2
754+
755+
Use :option:`--tlsAllowInvalidCertificates
756+
<mongo --tlsAllowInvalidCertificates>` instead.
739757

740758
Bypasses the validation checks for server certificates and allows
741759
the use of invalid certificates to connect.
@@ -754,7 +772,10 @@ SSL Options (Deprecated)
754772

755773
.. option:: --sslAllowInvalidHostnames
756774

757-
.. deprecated:: 4.2 Use :option:`--tlsAllowInvalidHostnames <mongo --tlsAllowInvalidHostnames>` instead.
775+
.. deprecated:: 4.2
776+
777+
Use :option:`--tlsAllowInvalidHostnames
778+
<mongo --tlsAllowInvalidHostnames>` instead.
758779

759780
Disables the validation of the hostnames in TLS/SSL certificates. Allows
760781
:program:`mongo` to connect to MongoDB instances even if the hostname in their
@@ -766,7 +787,10 @@ SSL Options (Deprecated)
766787
.. option:: --sslDisabledProtocols <string>
767788

768789

769-
.. deprecated:: 4.2 Use :option:`--tlsDisabledProtocols <mongo --tlsDisabledProtocols>` instead.
790+
.. deprecated:: 4.2
791+
792+
Use :option:`--tlsDisabledProtocols
793+
<mongo --tlsDisabledProtocols>` instead.
770794

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

0 commit comments

Comments
 (0)