Skip to content

Commit

Permalink
DOCSP-25321 Refactors the "wills" on Configuration Options (#7415)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
kennethdyer authored Apr 17, 2024
1 parent e63f6d0 commit aa6d0cc
Show file tree
Hide file tree
Showing 8 changed files with 104 additions and 94 deletions.
4 changes: 2 additions & 2 deletions source/includes/extracts-linux-config-expectations.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
ref: _linux-config-expectations
content: |
The Linux package init scripts do not expect {{option}} to change from the
defaults. If you use the Linux packages and change {{option}}, you will have
to use your own init scripts and disable the built-in scripts.
defaults. If you use the Linux packages and change {{option}}, you must
use your own init scripts and disable the built-in scripts.
---
ref: linux-config-expectations-systemlog-path
replacement:
Expand Down
8 changes: 4 additions & 4 deletions source/includes/extracts-wired-tiger-base.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ content: |
.. note::
The {{cachesetting}} limits the size of the WiredTiger internal
cache. The operating system will use the available free memory
cache. The operating system uses the available free memory
for filesystem cache, which allows the compressed MongoDB data
files to stay in memory. In addition, the operating system will
use any free RAM to buffer file system blocks and file system
files to stay in memory. In addition, the operating system
uses any free RAM to buffer file system blocks and file system
cache.
To accommodate the additional consumers of RAM, you may have to
Expand All @@ -37,7 +37,7 @@ content: |
accommodate the other :binary:`~bin.mongod`
instances.
If you run :binary:`~bin.mongod` in a container (e.g. ``lxc``,
If you run :binary:`~bin.mongod` in a container (for example, ``lxc``,
``cgroups``, Docker, etc.) that does *not* have access to all of the
RAM available in a system, you must set {{cachesetting}} to a value
less than the amount of RAM available in the container. The exact
Expand Down
13 changes: 7 additions & 6 deletions source/includes/extracts-wired-tiger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -176,11 +176,12 @@ content: |
- 256 MB.
For example, on a system with a total of 4GB of RAM the WiredTiger
cache will use 1.5GB of RAM (``0.5 * (4 GB - 1 GB) = 1.5 GB``).
Conversely, a system with a total of 1.25 GB of RAM will allocate 256
MB to the WiredTiger cache because that is more than half of the
total RAM minus one gigabyte (``0.5 * (1.25 GB - 1 GB) = 128 MB < 256 MB``).
For example, on a system with a total of 4GB of RAM the
WiredTiger cache uses 1.5GB of RAM (``0.5 * (4 GB - 1 GB) =
1.5 GB``). Conversely, on a system with a total of 1.25 GB of
RAM WiredTiger allocates 256 MB to the WiredTiger cache
because that is more than half of the total RAM minus one
gigabyte (``0.5 * (1.25 GB - 1 GB) = 128 MB < 256 MB``).
.. note::
Expand All @@ -194,7 +195,7 @@ content: |
---
ref: wt-filesystem-cache
content: |
Via the filesystem cache, MongoDB automatically uses all free memory
With the filesystem cache, MongoDB automatically uses all free memory
that is not used by the WiredTiger cache or by other processes.
---
ref: wt-snapshot-frequency
Expand Down
8 changes: 4 additions & 4 deletions source/includes/fact-default-conf-file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
- MSI Installer
- ``<install directory>\bin\mongod.cfg``

- If you :ref:`installed MongoDB <tutorial-installation>` via a downloaded
``TGZ`` or ``ZIP`` file, you will need to create your own configuration
file. The :ref:`basic example configuration <base-config>` is a good
place to start.
- If you :ref:`installed MongoDB <tutorial-installation>`
through a downloaded ``TGZ`` or ``ZIP`` file, you must create
your own configuration file. The :ref:`basic example
configuration <base-config>` is a good place to start.
2 changes: 1 addition & 1 deletion source/includes/fact-split-horizon-binding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ configuration commands.
:binary:`mongod` and :binary:`mongos` do not rely on
:parameter:`disableSplitHorizonIPCheck` for validation at startup.
Legacy :binary:`mongod` and :binary:`mongos` instances that use IP
addresses instead of host names will start after an upgrade.
addresses instead of host names can start after an upgrade.

Instances that are configured with IP addresses log a warning to use
host names instead of IP addresses.
Expand Down
2 changes: 1 addition & 1 deletion source/includes/fact-timeZoneInfo.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The full path from which to load the time zone database. If this option
is not provided, then MongoDB will use its built-in time zone database.
is not provided, then MongoDB uses its built-in time zone database.

The configuration file included with Linux and macOS packages sets the
time zone database path to ``/usr/share/zoneinfo`` by default.
Expand Down
3 changes: 1 addition & 2 deletions source/includes/important-hostnames.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,5 @@

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

Loading

0 comments on commit aa6d0cc

Please sign in to comment.