Skip to content

Commit b0eda20

Browse files
authored
DOCSP-25406 Resolving Build Errors — WiredTiger journaling (#1897)
* DOCSP-25406 Resolve wiredTiger Journal Build Errors * fix accidental typo * resolve 3.6 release note errors + change out :docs: for :ref: links * mystery typo? * remove note for 4.2 * fix 5 that keeps changing to 1 * remove mention of storage.journal.enabled from monitoring.txt * fix language to remove mention of journaling option in monitoring * grammar fix
1 parent 7e139cf commit b0eda20

File tree

8 files changed

+31
-26
lines changed

8 files changed

+31
-26
lines changed

source/administration/monitoring.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -550,11 +550,15 @@ The Storage Node Watchdog monitors the following MongoDB directories to
550550
detect filesystem unresponsiveness:
551551

552552
* The :option:`--dbpath <mongod --dbpath>` directory
553-
* The ``journal`` directory inside the :option:`--dbpath <mongod --dbpath>` directory if
554-
:option:`journaling <mongod --journal>` is enabled
553+
* The ``journal`` directory inside the :option:`--dbpath <mongod --dbpath>`
554+
directory
555555
* The directory of :option:`--logpath <mongod --logpath>` file
556556
* The directory of :option:`--auditPath <mongod --auditPath>` file
557557

558+
.. note::
559+
560+
.. include:: /includes/journal-option-removed.rst
561+
558562
By default, the Storage Node Watchdog is disabled. You can only enable
559563
the Storage Node Watchdog on a :binary:`~bin.mongod` at startup time by
560564
setting the :parameter:`watchdogPeriodSeconds` parameter to an integer

source/core/replica-set-members.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _replica-set-members:
2+
13
===================
24
Replica Set Members
35
===================

source/core/storage-engines.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _storage-engines:
2+
13
===============
24
Storage Engines
35
===============
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
Starting in MongoDB 4.0, you cannot specify :option:`--nojournal
2-
<mongod --nojournal>` option or :setting:`storage.journal.enabled:
3-
false <storage.journal.enabled>` for replica set members that use the
1+
Starting in MongoDB 4.0, you cannot specify ``--nojournal`` option or
2+
``storage.journal.enabled: false`` for replica set members that use the
43
WiredTiger storage engine.

source/release-notes/2.0.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ for handling CSV input/output. This may break existing import/export
3131
workflows that relied on the previous behavior. For more information see
3232
:issue:`SERVER-1097`.
3333

34-
:doc:`Journaling </core/journaling/>` is **enabled by default** in 2.0 for 64-bit builds.
34+
:ref:`<journaling-internals>` is **enabled by default** in 2.0 for 64-bit builds.
3535
If you still prefer to run without journaling, start :binary:`~bin.mongod`
36-
with the :option:`--nojournal <mongod --nojournal>` run-time option.
37-
Otherwise, MongoDB creates journal files during startup. The first time you start :binary:`~bin.mongod` with
36+
with the ``--nojournal`` run-time option. Otherwise, MongoDB creates journal
37+
files during startup. The first time you start :binary:`~bin.mongod` with
3838
journaling, you will see a delay as :binary:`~bin.mongod` creates new files.
3939
In addition, you may see reduced write throughput.
4040

source/release-notes/3.6-compatibility.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -437,14 +437,14 @@ MongoDB 3.6 deprecates master-slave replication.
437437
``--nojournal`` Option with WiredTiger
438438
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
439439

440-
In version 3.6, the :option:`--nojournal <mongod --nojournal>` option is deprecated for
441-
:doc:`replica set members </core/replica-set-members/>`
442-
using the :doc:`WiredTiger storage engine </core/wiredtiger/>`.
443-
444-
:doc:`Replica set members </core/replica-set-members/>` which use the
445-
WiredTiger :doc:`storage engine </core/storage-engines/>` should not
446-
use the :option:`--nojournal <mongod --nojournal>` option. For more information about
447-
journaling, see :doc:`/tutorial/manage-journaling`.
440+
In version 3.6, the ``--nojournal`` option is deprecated for
441+
:ref:`<replica-set-members>` using the
442+
:ref:`WiredTiger storage engine <storage-wiredtiger>`.
443+
444+
:ref:`Replica set members <replica-set-members>` that use the
445+
WiredTiger :ref:`storage engine <storage-engines>` should not
446+
use the ``--nojournal`` option. For more information about
447+
journaling, see :ref:`<manage-journaling>`.
448448

449449
.. _aggregate-compatibility:
450450

source/release-notes/4.2-downgrade-replica-set.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ If the member uses ``zstd`` for journal compression only,
212212
</reference/configuration-options>` to prepare to restart as a
213213
standalone:
214214

215-
- Set :setting:`storage.journal.enabled` to ``false``.
215+
- Set ``storage.journal.enabled`` to ``false``.
216216

217217
- Comment out the :ref:`replication <replication-options>` settings
218218
for your deployment.
@@ -246,8 +246,7 @@ If the member uses ``zstd`` for journal compression only,
246246
- If you are using command-line options instead of a
247247
configuration file,
248248

249-
- Include the :option:`--nojournal <mongod
250-
--nojournal>` option
249+
- Include the ``--nojournal`` option
251250

252251
- Remove any :ref:`replication command-line options
253252
<cli-mongod-replica-set>` (such as :option:`--replSet
@@ -272,7 +271,7 @@ If the member uses ``zstd`` for journal compression only,
272271
#. Update the configuration file to prepare to restart as a replica set
273272
member with the new journal compressor:
274273

275-
- Remove the :setting:`storage.journal.enabled` setting.
274+
- Remove the ``storage.journal.enabled`` setting.
276275

277276
- Uncomment the :ref:`replication <replication-options>`
278277
settings for your deployment.
@@ -310,7 +309,7 @@ If the member uses ``zstd`` for journal compression only,
310309
- If you are using command-line options instead of a configuration
311310
file:
312311

313-
- Remove the :option:`--nojournal <mongod --nojournal>` option.
312+
- Remove the ``--nojournal`` option.
314313

315314
- Remove the :option:`--wiredTigerJournalCompressor <mongod
316315
--wiredTigerJournalCompressor>` command-line option to use

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ If the member only uses ``zstd`` for journal compression only,
184184
</reference/configuration-options>` to prepare to restart as a
185185
standalone:
186186

187-
- Set :setting:`storage.journal.enabled` to ``false``.
187+
- Set ``storage.journal.enabled`` to ``false``.
188188

189189
- Set parameter :parameter:`skipShardingConfigurationChecks` to true.
190190

@@ -230,8 +230,7 @@ If the member only uses ``zstd`` for journal compression only,
230230
- If you are using command-line options instead of a
231231
configuration file:
232232

233-
- Include the :option:`--nojournal <mongod --nojournal>`
234-
option.
233+
- Include the ``--nojournal`` option.
235234

236235
- Set parameter :parameter:`skipShardingConfigurationChecks` to true.
237236

@@ -263,7 +262,7 @@ If the member only uses ``zstd`` for journal compression only,
263262

264263
#. Update the configuration file to prepare to restart with the new journal compressor:
265264

266-
- Remove the :setting:`storage.journal.enabled` setting.
265+
- Remove the ``storage.journal.enabled`` setting.
267266

268267
- Remove the :parameter:`skipShardingConfigurationChecks` parameter setting.
269268

@@ -310,7 +309,7 @@ If the member only uses ``zstd`` for journal compression only,
310309
- If you are using command-line options instead of a configuration
311310
file:
312311

313-
- Remove the :option:`--nojournal <mongod --nojournal>` option.
312+
- Remove the ``--nojournal`` option.
314313

315314
- Remove the :parameter:`skipShardingConfigurationChecks` parameter setting.
316315

0 commit comments

Comments
 (0)