Skip to content

Commit aa6d0cc

Browse files
authoredApr 17, 2024
DOCSP-25321 Refactors the "wills" on Configuration Options (#7415)
* Refactors the wills * Text adjustment * Text adjustment * Text adjustment in includes * Removes 'via' per Jeff * Removes 'via' per Jeff * Removes 'via' per Jeff * Fixes per Jeff * Fixes per Jeff * Fixes per Jeff
1 parent e63f6d0 commit aa6d0cc

8 files changed

+104
-94
lines changed
 

‎source/includes/extracts-linux-config-expectations.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
ref: _linux-config-expectations
22
content: |
33
The Linux package init scripts do not expect {{option}} to change from the
4-
defaults. If you use the Linux packages and change {{option}}, you will have
5-
to use your own init scripts and disable the built-in scripts.
4+
defaults. If you use the Linux packages and change {{option}}, you must
5+
use your own init scripts and disable the built-in scripts.
66
---
77
ref: linux-config-expectations-systemlog-path
88
replacement:

‎source/includes/extracts-wired-tiger-base.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ content: |
2222
.. note::
2323
2424
The {{cachesetting}} limits the size of the WiredTiger internal
25-
cache. The operating system will use the available free memory
25+
cache. The operating system uses the available free memory
2626
for filesystem cache, which allows the compressed MongoDB data
27-
files to stay in memory. In addition, the operating system will
28-
use any free RAM to buffer file system blocks and file system
27+
files to stay in memory. In addition, the operating system
28+
uses any free RAM to buffer file system blocks and file system
2929
cache.
3030
3131
To accommodate the additional consumers of RAM, you may have to
@@ -37,7 +37,7 @@ content: |
3737
accommodate the other :binary:`~bin.mongod`
3838
instances.
3939
40-
If you run :binary:`~bin.mongod` in a container (e.g. ``lxc``,
40+
If you run :binary:`~bin.mongod` in a container (for example, ``lxc``,
4141
``cgroups``, Docker, etc.) that does *not* have access to all of the
4242
RAM available in a system, you must set {{cachesetting}} to a value
4343
less than the amount of RAM available in the container. The exact

‎source/includes/extracts-wired-tiger.yaml

+7-6
Original file line numberDiff line numberDiff line change
@@ -176,11 +176,12 @@ content: |
176176
177177
- 256 MB.
178178
179-
For example, on a system with a total of 4GB of RAM the WiredTiger
180-
cache will use 1.5GB of RAM (``0.5 * (4 GB - 1 GB) = 1.5 GB``).
181-
Conversely, a system with a total of 1.25 GB of RAM will allocate 256
182-
MB to the WiredTiger cache because that is more than half of the
183-
total RAM minus one gigabyte (``0.5 * (1.25 GB - 1 GB) = 128 MB < 256 MB``).
179+
For example, on a system with a total of 4GB of RAM the
180+
WiredTiger cache uses 1.5GB of RAM (``0.5 * (4 GB - 1 GB) =
181+
1.5 GB``). Conversely, on a system with a total of 1.25 GB of
182+
RAM WiredTiger allocates 256 MB to the WiredTiger cache
183+
because that is more than half of the total RAM minus one
184+
gigabyte (``0.5 * (1.25 GB - 1 GB) = 128 MB < 256 MB``).
184185
185186
.. note::
186187
@@ -194,7 +195,7 @@ content: |
194195
---
195196
ref: wt-filesystem-cache
196197
content: |
197-
Via the filesystem cache, MongoDB automatically uses all free memory
198+
With the filesystem cache, MongoDB automatically uses all free memory
198199
that is not used by the WiredTiger cache or by other processes.
199200
---
200201
ref: wt-snapshot-frequency

‎source/includes/fact-default-conf-file.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
- MSI Installer
2828
- ``<install directory>\bin\mongod.cfg``
2929

30-
- If you :ref:`installed MongoDB <tutorial-installation>` via a downloaded
31-
``TGZ`` or ``ZIP`` file, you will need to create your own configuration
32-
file. The :ref:`basic example configuration <base-config>` is a good
33-
place to start.
30+
- If you :ref:`installed MongoDB <tutorial-installation>`
31+
through a downloaded ``TGZ`` or ``ZIP`` file, you must create
32+
your own configuration file. The :ref:`basic example
33+
configuration <base-config>` is a good place to start.

‎source/includes/fact-split-horizon-binding.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ configuration commands.
1313
:binary:`mongod` and :binary:`mongos` do not rely on
1414
:parameter:`disableSplitHorizonIPCheck` for validation at startup.
1515
Legacy :binary:`mongod` and :binary:`mongos` instances that use IP
16-
addresses instead of host names will start after an upgrade.
16+
addresses instead of host names can start after an upgrade.
1717

1818
Instances that are configured with IP addresses log a warning to use
1919
host names instead of IP addresses.

‎source/includes/fact-timeZoneInfo.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
The full path from which to load the time zone database. If this option
2-
is not provided, then MongoDB will use its built-in time zone database.
2+
is not provided, then MongoDB uses its built-in time zone database.
33

44
The configuration file included with Linux and macOS packages sets the
55
time zone database path to ``/usr/share/zoneinfo`` by default.

‎source/includes/important-hostnames.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,5 @@
77

88
Use hostnames instead of IP addresses to configure clusters across a
99
split network horizon. Starting in MongoDB 5.0, nodes that are only
10-
configured with an IP address will fail startup validation and will
11-
not start.
10+
configured with an IP address fail startup validation and do not start.
1211

‎source/reference/configuration-options.txt

+84-74
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)
Please sign in to comment.