Skip to content

Commit e98e404

Browse files
(DOCSP-26626): Fix mongod/mongos formatting (#2170)
1 parent 437e7ea commit e98e404

23 files changed

+87
-92
lines changed

source/core/security-transport-encryption.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ Starting in version 4.4, to check for certificate revocation, MongoDB
224224
Status Protocol) by default. The use of OCSP eliminates the need to
225225
periodically download a :setting:`Certificate Revocation List (CRL)
226226
<net.tls.CRLFile>` and restart the
227-
:binary:`~bin.mongod`/:binary:`~bin.mongos` with the updated CRL.
227+
:binary:`mongod` / :binary:`mongos` with the updated CRL.
228228

229229
In versions 4.0 and 4.2, the use of OCSP is available only through the
230230
use of :setting:`system certificate store

source/includes/extracts-4.2-changes.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -411,8 +411,8 @@ content: |
411411
Starting in version 4.2, MongoDB removes the ``--sslFIPSMode``
412412
option for |tool-binary|. |tool-binary|
413413
will use FIPS compliant connections to
414-
:binary:`~bin.mongod`/:binary:`~bin.mongos` if the
415-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instances are
414+
:binary:`mongod` / :binary:`mongos` if the
415+
:binary:`mongod` / :binary:`mongos` instances are
416416
:doc:`configured to use FIPS mode </tutorial/configure-fips>`.
417417
---
418418
ref: 4.2-changes-fips-program-mongod
@@ -440,8 +440,8 @@ content: |
440440
- :binary:`~bin.mongotop`
441441
442442
The programs will use FIPS compliant connections to
443-
:binary:`~bin.mongod`/:binary:`~bin.mongos` if the
444-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instances are
443+
:binary:`mongod` / :binary:`mongos` if the
444+
:binary:`mongod` / :binary:`mongos` instances are
445445
:doc:`configured to use FIPS mode </tutorial/configure-fips>`.
446446
---
447447
ref: 4.2-changes-count-syntax-validation
@@ -764,15 +764,15 @@ content: |
764764
765765
If the configuration file includes the :configexpansion:`__rest`
766766
expansion, on Linux/macOS, the read access to the configuration file must be limited
767-
to the user running the :binary:`~bin.mongod`/:binary:`~bin.mongos`
767+
to the user running the :binary:`mongod` / :binary:`mongos`
768768
process only.
769769
---
770770
ref: 4.2-changes-expansion-configuration-file-permission-exec
771771
content: |
772772
If the configuration file includes the :configexpansion:`__exec`
773773
expansion, on Linux/macOS, the write access to the configuration file must be
774774
limited to the user running the
775-
:binary:`~bin.mongod`/:binary:`~bin.mongos` process only.
775+
:binary:`mongod` / :binary:`mongos` process only.
776776
---
777777
ref: 4.2-changes-ese-key-rollover
778778
content: |
@@ -811,7 +811,7 @@ content: |
811811
Starting in MongoDB 4.2, MongoDB adds the parameter
812812
:parameter:`ShardingTaskExecutorPoolReplicaSetMatching`. This
813813
parameter determines the minimum size of the
814-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance's
814+
:binary:`mongod` / :binary:`mongos` instance's
815815
connection pool to each member of the sharded cluster. This value
816816
can vary during runtime.
817817

source/includes/list-table-ocsp-parameters.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
* - :parameter:`tlsOCSPStaplingTimeoutSecs`
1818

1919
- Specifies the maximum number of seconds the
20-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance should
20+
:binary:`mongod` / :binary:`mongos` instance should
2121
wait to receive the OCSP status response for its certificates.
2222

2323
* - :parameter:`tlsOCSPVerifyTimeoutSecs`
2424

2525
- Specifies the maximum number of seconds that the
26-
:binary:`~bin.mongod`/:binary:`~bin.mongos` should wait for
26+
:binary:`mongod` / :binary:`mongos` should wait for
2727
the OCSP response when verifying client certificates.

source/reference/command.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ Sharding Commands
484484

485485
* - :dbcommand:`flushRouterConfig`
486486

487-
- Forces a :binary:`~bin.mongod`/:binary:`~bin.mongos` instance to update its cached routing metadata.
487+
- Forces a :binary:`mongod` / :binary:`mongos` instance to update its cached routing metadata.
488488

489489
* - :dbcommand:`getShardMap`
490490

source/reference/command/connPoolStats.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -366,32 +366,32 @@ Output
366366
.. data:: connPoolStats.totalAvailable
367367

368368
Reports the total number of available outgoing connections from the
369-
current :binary:`~bin.mongod`/:binary:`~bin.mongos` instance to other members
369+
current :binary:`mongod` / :binary:`mongos` instance to other members
370370
of the :term:`sharded cluster` or :term:`replica set`.
371371

372372
.. data:: connPoolStats.totalCreated
373373

374374
Reports the total number of outgoing connections ever created by the
375-
current :binary:`~bin.mongod`/:binary:`~bin.mongos` instance to other members
375+
current :binary:`mongod` / :binary:`mongos` instance to other members
376376
of the :term:`sharded cluster` or :term:`replica set`.
377377

378378
.. data:: connPoolStats.totalInUse
379379

380380
Reports the total number of outgoing connections from the current
381-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance to other members of the
381+
:binary:`mongod` / :binary:`mongos` instance to other members of the
382382
:term:`sharded cluster` or :term:`replica set` that are currently in use.
383383

384384
.. data:: connPoolStats.totalRefreshing
385385

386386
Reports the total number of outgoing connections from the
387-
current :binary:`~bin.mongod`/:binary:`~bin.mongos` instance to other
387+
current :binary:`mongod` / :binary:`mongos` instance to other
388388
members of the :term:`sharded cluster` or :term:`replica set` that
389389
are currently being refreshed.
390390

391391
.. data:: connPoolStats.totalWasNeverUsed
392392

393393
Reports the total number of outgoing connections from the
394-
current :binary:`~bin.mongod`/:binary:`~bin.mongos` instance to other
394+
current :binary:`mongod` / :binary:`mongos` instance to other
395395
members of the :term:`sharded cluster` or :term:`replica set` that
396396
were closed having never been used.
397397

@@ -479,7 +479,7 @@ Output
479479
.. data:: connPoolStats.numClientConnection
480480

481481
Reports the number of active and stored outgoing **synchronous**
482-
connections from the current :binary:`~bin.mongod`/:binary:`~bin.mongos` instance
482+
connections from the current :binary:`mongod` / :binary:`mongos` instance
483483
to other members of the :term:`sharded cluster` or :term:`replica set`.
484484

485485
These connections are a part of a pool that is a subset of the data
@@ -490,7 +490,7 @@ Output
490490

491491
Reports the number of active and stored outgoing **scoped
492492
synchronous** connections from the current
493-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance to other members of the
493+
:binary:`mongod` / :binary:`mongos` instance to other members of the
494494
:term:`sharded cluster` or :term:`replica set`.
495495

496496
These connections are a part of a pool that is a subset of the data
@@ -553,7 +553,7 @@ Output
553553
*Available if the command is run on a member of a sharded cluster.*
554554

555555
Displays the pool statistics for the connections between the
556-
current :binary:`~bin.mongod`/:binary:`~bin.mongos` instance and other
556+
current :binary:`mongod` / :binary:`mongos` instance and other
557557
members of the sharded cluster.
558558

559559
.. data:: connPoolStats.pools.NetworkInterfaceTL-Replication
@@ -587,7 +587,7 @@ Output
587587
use/available/created/refreshing) grouped by the hosts.
588588

589589
Contains :term:`documents<document>` that represent a report of connections
590-
between the current :binary:`~bin.mongod`/:binary:`~bin.mongos` instance and
590+
between the current :binary:`mongod` / :binary:`mongos` instance and
591591
each member of the :term:`sharded cluster` or :term:`replica set`.
592592

593593
.. data:: connPoolStats.hosts.[host].available
@@ -622,12 +622,12 @@ Output
622622

623623
Contains :term:`documents <document>` that represent a report of
624624
information related to each replica set connected to the current
625-
:binary:`~bin.mongod`/:binary:`~bin.mongos`.
625+
:binary:`mongod` / :binary:`mongos`.
626626

627627
.. data:: connPoolStats.replicaSets.replicaSet
628628

629629
Reports on each :term:`replica set` connected to the
630-
current :binary:`~bin.mongod`/:binary:`~bin.mongos`.
630+
current :binary:`mongod` / :binary:`mongos`.
631631

632632
.. data:: connPoolStats.replicaSets.[replicaSets].hosts
633633

source/reference/command/dropConnections.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Definition
1818
.. versionadded:: 4.2
1919

2020
The :dbcommand:`dropConnections` command drops the
21-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance's outgoing
21+
:binary:`mongod` / :binary:`mongos` instance's outgoing
2222
connections to the specified hosts. The :dbcommand:`dropConnections`
2323
must be run against the ``admin`` database.
2424

source/reference/command/hello.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ roles:
140140

141141
.. data:: hello.connectionId
142142

143-
An identifier for the :binary:`~bin.mongod`/:binary:`~bin.mongos`
143+
An identifier for the :binary:`mongod` / :binary:`mongos`
144144
instance's outgoing connection to the client.
145145

146146
.. data:: hello.minWireVersion

source/reference/command/nav-sharding.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Sharding Commands
9292

9393
* - :dbcommand:`flushRouterConfig`
9494

95-
- Forces a :binary:`~bin.mongod`/:binary:`~bin.mongos` instance to update its cached routing metadata.
95+
- Forces a :binary:`mongod` / :binary:`mongos` instance to update its cached routing metadata.
9696

9797
* - :dbcommand:`getShardMap`
9898

source/reference/command/serverStatus.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3978,7 +3978,7 @@ security
39783978
to authenticate against the :binary:`~bin.mongod` or
39793979
:binary:`~bin.mongos` instance. (New in MongoDB 4.4)
39803980

3981-
- The :binary:`~bin.mongod`/:binary:`~bin.mongos` instance's TLS/SSL
3981+
- The :binary:`mongod` / :binary:`mongos` instance's TLS/SSL
39823982
certificate. (Only appears for :binary:`~bin.mongod` or
39833983
:binary:`~bin.mongos` instance with support for TLS)
39843984

@@ -4063,14 +4063,14 @@ security
40634063
.. serverstatus:: security.SSLServerSubjectName
40644064

40654065
The subject name associated with the
4066-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance's TLS/SSL
4066+
:binary:`mongod` / :binary:`mongos` instance's TLS/SSL
40674067
certificate.
40684068

40694069
.. serverstatus:: security.SSLServerHasCertificateAuthority
40704070

40714071
A boolean that is:
40724072

4073-
- ``true`` when the :binary:`~bin.mongod`/:binary:`~bin.mongos`
4073+
- ``true`` when the :binary:`mongod` / :binary:`mongos`
40744074
instance's TLS/SSL certificate is associated with a certificate
40754075
authority.
40764076

@@ -4079,7 +4079,7 @@ security
40794079
.. serverstatus:: security.SSLServerCertificateExpirationDate
40804080

40814081
The expiration date and time of the
4082-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance's TLS/SSL
4082+
:binary:`mongod` / :binary:`mongos` instance's TLS/SSL
40834083
certificate.
40844084

40854085
.. _server-status-sharding:

source/reference/configuration-options.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,9 @@ the :binary:`~bin.mongod` or :binary:`~bin.mongos`. For example:
143143
mongos --config /etc/mongos.conf --configExpand "rest,exec"
144144

145145
If the configuration file includes an expansion directive and you start
146-
the :binary:`~bin.mongod`/:binary:`~bin.mongos` without specifying
146+
the :binary:`mongod` / :binary:`mongos` without specifying
147147
that directive in the :option:`--configExpand <mongod --configExpand>`
148-
option, the :binary:`~bin.mongod`/:binary:`~bin.mongos` fails to start.
148+
option, the :binary:`mongod` / :binary:`mongos` fails to start.
149149

150150
For complete documentation, see :ref:`externally-sourced-values`.
151151

source/reference/connection-string.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -471,7 +471,7 @@ Alternatively, you can also use the equivalent :urioption:`ssl=true
471471
client's TLS/SSL certificate and key.
472472

473473
The client presents this file to the
474-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance.
474+
:binary:`mongod` / :binary:`mongos` instance.
475475

476476
.. include:: /includes/extracts/4.4-changes-certificate-expiry-warning.rst
477477

@@ -499,7 +499,7 @@ Alternatively, you can also use the equivalent :urioption:`ssl=true
499499
- Specifies the location of a local :file:`.pem` file that
500500
contains the root certificate chain from the Certificate
501501
Authority. This file is used to validate the certificate
502-
presented by the :binary:`~bin.mongod`/:binary:`~bin.mongos`
502+
presented by the :binary:`mongod` / :binary:`mongos`
503503
instance.
504504

505505
This option is not supported by all drivers. Refer to the
@@ -512,7 +512,7 @@ Alternatively, you can also use the equivalent :urioption:`ssl=true
512512
* - .. urioption:: tlsAllowInvalidCertificates
513513

514514
- Bypasses validation of the certificates presented by the
515-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance
515+
:binary:`mongod` / :binary:`mongos` instance
516516

517517
Set to ``true`` to connect to MongoDB instances even if the
518518
server's present invalid certificates.
@@ -531,7 +531,7 @@ Alternatively, you can also use the equivalent :urioption:`ssl=true
531531
* - .. urioption:: tlsAllowInvalidHostnames
532532

533533
- Disables hostname validation of the certificate presented by
534-
the :binary:`~bin.mongod`/:binary:`~bin.mongos` instance.
534+
the :binary:`mongod` / :binary:`mongos` instance.
535535

536536
Set to ``true`` to connect to MongoDB instances even if the
537537
hostname in the server certificates do not match the server's
@@ -603,7 +603,7 @@ Compression Options
603603

604604
- Comma-delimited string of compressors to enable
605605
network compression for communication between this
606-
client and a :binary:`~bin.mongod`/:binary:`~bin.mongos`
606+
client and a :binary:`mongod` / :binary:`mongos`
607607
instance.
608608

609609
You can specify the following compressors:
@@ -925,7 +925,7 @@ For details, see :ref:`read-preference-tag-order-matching`.
925925
To use ``maxStalenessSeconds``, all of the
926926
MongoDB instances in your deployment must be using MongoDB 3.4 or
927927
later. If any instances are on an earlier version of MongoDB, the
928-
driver or :binary:`~bin.mongod`/:binary:`~bin.mongos` will raise an error.
928+
driver or :binary:`mongod` / :binary:`mongos` will raise an error.
929929

930930
* - .. urioption:: readPreferenceTags
931931

source/reference/operator/aggregation/listLocalSessions.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Examples
8585
List All Local Sessions
8686
~~~~~~~~~~~~~~~~~~~~~~~
8787

88-
From the connected :binary:`~bin.mongod`/:binary:`~bin.mongos` instance's
88+
From the connected :binary:`mongod` / :binary:`mongos` instance's
8989
in-memory cache of sessions, the following aggregation operation lists
9090
all sessions:
9191

@@ -101,7 +101,7 @@ all sessions:
101101
List All Local Sessions for the Specified Users
102102
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103103

104-
From the connected :binary:`~bin.mongod`/:binary:`~bin.mongos` instance's
104+
From the connected :binary:`mongod` / :binary:`mongos` instance's
105105
in-memory cache, the following aggregation operation lists all the
106106
sessions for the specified user ``myAppReader@test``:
107107

@@ -118,7 +118,7 @@ sessions for the specified user ``myAppReader@test``:
118118
List All Local Sessions for the Current User
119119
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120120

121-
From the connected :binary:`~bin.mongod`/:binary:`~bin.mongos` instance's
121+
From the connected :binary:`mongod` / :binary:`mongos` instance's
122122
in-memory cache, the following aggregation operation lists all sessions
123123
for the current user **if** run with access control:
124124

source/reference/parameters.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -784,7 +784,7 @@ Authentication Parameters
784784
Available for Linux.
785785

786786
The maximum number of seconds the
787-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance should wait to
787+
:binary:`mongod` / :binary:`mongos` instance should wait to
788788
receive the OCSP status response for its certificates.
789789

790790
Specify an integer greater than or equal to (``>=``) 1. If unset,
@@ -816,7 +816,7 @@ Authentication Parameters
816816
*Default*: 5
817817

818818
The maximum number of seconds that the
819-
:binary:`~bin.mongod`/:binary:`~bin.mongos` should wait for the OCSP
819+
:binary:`mongod` / :binary:`mongos` should wait for the OCSP
820820
response when verifying client certificates.
821821

822822
Specify an integer greater than or equal to (``>=``) 1.
@@ -910,7 +910,7 @@ Authentication Parameters
910910

911911
|both|
912912

913-
Starting in MongoDB 4.4, :binary:`~bin.mongod`/:binary:`~bin.mongos`
913+
Starting in MongoDB 4.4, :binary:`mongod` / :binary:`mongos`
914914
logs a warning on connection if the presented x.509 certificate
915915
expires within ``30`` days of the ``mongod/mongos`` system clock.
916916
Use the :parameter:`tlsX509ExpirationWarningThresholdDays` parameter

source/reference/sharding.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ The following database commands support :term:`sharded clusters
247247

248248
* - :dbcommand:`flushRouterConfig`
249249

250-
- Forces a :binary:`~bin.mongod`/:binary:`~bin.mongos` instance to update its cached routing metadata.
250+
- Forces a :binary:`mongod` / :binary:`mongos` instance to update its cached routing metadata.
251251

252252
* - :dbcommand:`getShardMap`
253253

source/release-notes/4.2-downgrade-sharded-cluster.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ operations for each collection using the 4.0-incompatible keywords:
415415

416416
db.runComand({ "collMod" : "<collection>", "validator" : {} })
417417

418-
.. |binary| replace:: any :binary:`~bin.mongod`/:binary:`~bin.mongos` instance
418+
.. |binary| replace:: any :binary:`mongod` / :binary:`mongos` instance
419419

420420
Procedure
421421
---------
@@ -434,4 +434,3 @@ Downgrade a Sharded Cluster
434434
.. include:: /includes/steps/4.2-downgrade-sharded-cluster.rst
435435

436436
.. include:: /includes/4.2-upgrade-replacements.rst
437-

0 commit comments

Comments
 (0)