Skip to content

Commit 55f74ec

Browse files
(DOCSP-26626): Fix mongod/mongos formatting (#2170)
1 parent 9b10abf commit 55f74ec

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
@@ -755,15 +755,15 @@ content: |
755755
756756
If the configuration file includes the :configexpansion:`__rest`
757757
expansion, on Linux/macOS, the read access to the configuration file must be limited
758-
to the user running the :binary:`~bin.mongod`/:binary:`~bin.mongos`
758+
to the user running the :binary:`mongod` / :binary:`mongos`
759759
process only.
760760
---
761761
ref: 4.2-changes-expansion-configuration-file-permission-exec
762762
content: |
763763
If the configuration file includes the :configexpansion:`__exec`
764764
expansion, on Linux/macOS, the write access to the configuration file must be
765765
limited to the user running the
766-
:binary:`~bin.mongod`/:binary:`~bin.mongos` process only.
766+
:binary:`mongod` / :binary:`mongos` process only.
767767
---
768768
ref: 4.2-changes-ese-key-rollover
769769
content: |
@@ -802,7 +802,7 @@ content: |
802802
Starting in MongoDB 4.2, MongoDB adds the parameter
803803
:parameter:`ShardingTaskExecutorPoolReplicaSetMatching`. This
804804
parameter determines the minimum size of the
805-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance's
805+
:binary:`mongod` / :binary:`mongos` instance's
806806
connection pool to each member of the sharded cluster. This value
807807
can vary during runtime.
808808

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
@@ -316,32 +316,32 @@ Output
316316
.. data:: connPoolStats.totalAvailable
317317

318318
Reports the total number of available outgoing connections from the
319-
current :binary:`~bin.mongod`/:binary:`~bin.mongos` instance to other members
319+
current :binary:`mongod` / :binary:`mongos` instance to other members
320320
of the :term:`sharded cluster` or :term:`replica set`.
321321

322322
.. data:: connPoolStats.totalCreated
323323

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

328328
.. data:: connPoolStats.totalInUse
329329

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

334334
.. data:: connPoolStats.totalRefreshing
335335

336336
Reports the total number of outgoing connections from the
337-
current :binary:`~bin.mongod`/:binary:`~bin.mongos` instance to other
337+
current :binary:`mongod` / :binary:`mongos` instance to other
338338
members of the :term:`sharded cluster` or :term:`replica set` that
339339
are currently being refreshed.
340340

341341
.. data:: connPoolStats.totalWasNeverUsed
342342

343343
Reports the total number of outgoing connections from the
344-
current :binary:`~bin.mongod`/:binary:`~bin.mongos` instance to other
344+
current :binary:`mongod` / :binary:`mongos` instance to other
345345
members of the :term:`sharded cluster` or :term:`replica set` that
346346
were closed having never been used.
347347

@@ -380,7 +380,7 @@ Output
380380
.. data:: connPoolStats.numClientConnection
381381

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

386386
These connections are a part of a pool that is a subset of the data
@@ -391,7 +391,7 @@ Output
391391

392392
Reports the number of active and stored outgoing **scoped
393393
synchronous** connections from the current
394-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance to other members of the
394+
:binary:`mongod` / :binary:`mongos` instance to other members of the
395395
:term:`sharded cluster` or :term:`replica set`.
396396

397397
These connections are a part of a pool that is a subset of the data
@@ -447,7 +447,7 @@ Output
447447
*Available if the command is run on a member of a sharded cluster.*
448448

449449
Displays the pool statistics for the connections between the
450-
current :binary:`~bin.mongod`/:binary:`~bin.mongos` instance and other
450+
current :binary:`mongod` / :binary:`mongos` instance and other
451451
members of the sharded cluster.
452452

453453
.. data:: connPoolStats.pools.NetworkInterfaceTL-Replication
@@ -473,7 +473,7 @@ Output
473473
use/available/created/refreshing) grouped by the hosts.
474474

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

479479
.. data:: connPoolStats.hosts.[host].available
@@ -500,12 +500,12 @@ Output
500500

501501
Contains :term:`documents <document>` that represent a report of
502502
information related to each replica set connected to the current
503-
:binary:`~bin.mongod`/:binary:`~bin.mongos`.
503+
:binary:`mongod` / :binary:`mongos`.
504504

505505
.. data:: connPoolStats.replicaSets.replicaSet
506506

507507
Reports on each :term:`replica set` connected to the
508-
current :binary:`~bin.mongod`/:binary:`~bin.mongos`.
508+
current :binary:`mongod` / :binary:`mongos`.
509509

510510
.. data:: connPoolStats.replicaSets.[replicaSets].hosts
511511

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
@@ -3982,7 +3982,7 @@ security
39823982
to authenticate against the :binary:`~bin.mongod` or
39833983
:binary:`~bin.mongos` instance. (New in MongoDB 4.4)
39843984

3985-
- The :binary:`~bin.mongod`/:binary:`~bin.mongos` instance's TLS/SSL
3985+
- The :binary:`mongod` / :binary:`mongos` instance's TLS/SSL
39863986
certificate. (Only appears for :binary:`~bin.mongod` or
39873987
:binary:`~bin.mongos` instance with support for TLS)
39883988

@@ -4067,14 +4067,14 @@ security
40674067
.. serverstatus:: security.SSLServerSubjectName
40684068

40694069
The subject name associated with the
4070-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance's TLS/SSL
4070+
:binary:`mongod` / :binary:`mongos` instance's TLS/SSL
40714071
certificate.
40724072

40734073
.. serverstatus:: security.SSLServerHasCertificateAuthority
40744074

40754075
A boolean that is:
40764076

4077-
- ``true`` when the :binary:`~bin.mongod`/:binary:`~bin.mongos`
4077+
- ``true`` when the :binary:`mongod` / :binary:`mongos`
40784078
instance's TLS/SSL certificate is associated with a certificate
40794079
authority.
40804080

@@ -4083,7 +4083,7 @@ security
40834083
.. serverstatus:: security.SSLServerCertificateExpirationDate
40844084

40854085
The expiration date and time of the
4086-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance's TLS/SSL
4086+
:binary:`mongod` / :binary:`mongos` instance's TLS/SSL
40874087
certificate.
40884088

40894089
.. _server-status-sharding:

source/reference/configuration-options.txt

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

148148
If the configuration file includes an expansion directive and you start
149-
the :binary:`~bin.mongod`/:binary:`~bin.mongos` without specifying
149+
the :binary:`mongod` / :binary:`mongos` without specifying
150150
that directive in the :option:`--configExpand <mongod --configExpand>`
151-
option, the :binary:`~bin.mongod`/:binary:`~bin.mongos` fails to start.
151+
option, the :binary:`mongod` / :binary:`mongos` fails to start.
152152

153153
For complete documentation, see :ref:`externally-sourced-values`.
154154

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:
@@ -929,7 +929,7 @@ For details, see :ref:`read-preference-tag-order-matching`.
929929
To use ``maxStalenessSeconds``, all of the
930930
MongoDB instances in your deployment must be using MongoDB 3.4 or
931931
later. If any instances are on an earlier version of MongoDB, the
932-
driver or :binary:`~bin.mongod`/:binary:`~bin.mongos` will raise an error.
932+
driver or :binary:`mongod` / :binary:`mongos` will raise an error.
933933

934934
* - .. urioption:: readPreferenceTags
935935

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
@@ -755,7 +755,7 @@ Authentication Parameters
755755
Available for Linux.
756756

757757
The maximum number of seconds the
758-
:binary:`~bin.mongod`/:binary:`~bin.mongos` instance should wait to
758+
:binary:`mongod` / :binary:`mongos` instance should wait to
759759
receive the OCSP status response for its certificates.
760760

761761
Specify an integer greater than or equal to (``>=``) 1. If unset,
@@ -787,7 +787,7 @@ Authentication Parameters
787787
*Default*: 5
788788

789789
The maximum number of seconds that the
790-
:binary:`~bin.mongod`/:binary:`~bin.mongos` should wait for the OCSP
790+
:binary:`mongod` / :binary:`mongos` should wait for the OCSP
791791
response when verifying client certificates.
792792

793793
Specify an integer greater than or equal to (``>=``) 1.
@@ -881,7 +881,7 @@ Authentication Parameters
881881

882882
|both|
883883

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

source/reference/sharding.txt

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

244244
* - :dbcommand:`flushRouterConfig`
245245

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

248248
* - :dbcommand:`getShardMap`
249249

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

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

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

419-
.. |binary| replace:: any :binary:`~bin.mongod`/:binary:`~bin.mongos` instance
419+
.. |binary| replace:: any :binary:`mongod` / :binary:`mongos` instance
420420

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

437437
.. include:: /includes/4.2-upgrade-replacements.rst
438-

0 commit comments

Comments
 (0)