From 77cb576437af330176518e19255b09a9b6b23fd0 Mon Sep 17 00:00:00 2001 From: Kyle Suarez Date: Fri, 11 Dec 2015 18:10:34 -0500 Subject: [PATCH] DOCS-6736 fix unit spacing Ensures that a space is placed between a number and a unit; for example, "64 GB". In the GridFS documentation, "k" has been converted to "KB" when discussing chunk size. A hyphen is used for "32-bit" and "64-bit." --- source/administration/production-checklist-operations.txt | 4 ++-- source/administration/production-notes.txt | 2 +- source/applications/design-notes.txt | 4 ++-- source/core/data-model-operations.txt | 4 ++-- source/core/gridfs.txt | 8 ++++---- source/core/journaling.txt | 2 +- source/core/master-slave.txt | 2 +- source/core/mmapv1.txt | 4 ++-- source/core/sharding-introduction.txt | 4 ++-- source/faq/diagnostics.txt | 2 +- source/includes/extracts-wired-tiger.yaml | 4 ++-- source/includes/note-suse-ulimit.rst | 6 +++--- source/includes/toc-data-modeling-concepts.yaml | 2 +- source/reference/command/compact.txt | 2 +- source/reference/gridfs.txt | 2 +- source/reference/method/db.setProfilingLevel.txt | 2 +- source/tutorial/troubleshoot-replica-sets.txt | 2 +- 17 files changed, 28 insertions(+), 28 deletions(-) diff --git a/source/administration/production-checklist-operations.txt b/source/administration/production-checklist-operations.txt index df9c46e0a78..5f3a2b3b550 100644 --- a/source/administration/production-checklist-operations.txt +++ b/source/administration/production-checklist-operations.txt @@ -235,8 +235,8 @@ Monitoring In the absence of disk space monitoring, or as a precaution: - - Create a dummy 4GB file on the :setting:`storage.dbPath` drive to - ensure available space if the disk becomes full. + - Create a dummy 4 GB file on the :setting:`storage.dbPath` drive + to ensure available space if the disk becomes full. - A combination of ``cron+df`` can alert when disk space hits a high-water mark, if no other monitoring tool is available. diff --git a/source/administration/production-notes.txt b/source/administration/production-notes.txt index e06a693c176..5faacc5054b 100644 --- a/source/administration/production-notes.txt +++ b/source/administration/production-notes.txt @@ -518,7 +518,7 @@ For the MMAPv1 storage engine: - Ensure that readahead settings for the block devices that store the database files are appropriate. For random access use patterns, set - low readahead values. A readahead of 32 (16kb) often works well. + low readahead values. A readahead of 32 (16 KB) often works well. For a standard block device, you can run ``sudo blockdev --report`` to get the readahead settings and ``sudo blockdev --setra diff --git a/source/applications/design-notes.txt b/source/applications/design-notes.txt index 6eda04329cf..530f1ef398e 100644 --- a/source/applications/design-notes.txt +++ b/source/applications/design-notes.txt @@ -89,8 +89,8 @@ options. See: the :method:`update` method reference documentation. BSON Document Size Limit ~~~~~~~~~~~~~~~~~~~~~~~~ -The :limit:`BSON Document Size` limit is currently -set at 16MB per document. If you require larger documents, use :doc:`GridFS +The :limit:`BSON Document Size` limit is currently set at 16 MB per +document. If you require larger documents, use :doc:`GridFS `. No Fully Generalized Transactions diff --git a/source/core/data-model-operations.txt b/source/core/data-model-operations.txt index 67f90ab4b55..ddf2e2c9df3 100644 --- a/source/core/data-model-operations.txt +++ b/source/core/data-model-operations.txt @@ -110,7 +110,7 @@ sorted results. MongoDB automatically creates a unique index on the As you create indexes, consider the following behaviors of indexes: -- Each index requires at least 8KB of data space. +- Each index requires at least 8 KB of data space. - Adding an index has some negative performance impact for write operations. For collections with high write-to-read ratio, indexes @@ -160,7 +160,7 @@ the following behaviors: - Each collection has a certain minimum overhead of a few kilobytes. -- Each index, including the index on ``_id``, requires at least 8KB of +- Each index, including the index on ``_id``, requires at least 8 KB of data space. - For each :term:`database`, a single namespace file (i.e. diff --git a/source/core/gridfs.txt b/source/core/gridfs.txt index a956d39f0a5..c0053500fb7 100644 --- a/source/core/gridfs.txt +++ b/source/core/gridfs.txt @@ -8,12 +8,12 @@ GridFS :term:`GridFS` is a specification for storing and retrieving files that exceed the :term:`BSON`\-document :ref:`size limit -` of 16MB. +` of 16 MB. Instead of storing a file in a single document, GridFS divides a file into parts, or chunks, [#chunk-disambiguation]_ and stores each of those chunks as a separate document. By default GridFS limits chunk -size to 255k. GridFS uses two collections to store files. One +size to 255 KB. GridFS uses two collections to store files. One collection stores the file chunks, and the other stores file metadata. When you query a GridFS store for a file, the driver or client will @@ -22,7 +22,7 @@ files stored through GridFS. You also can access information from arbitrary sections of files, which allows you to "skip" into the middle of a video or audio file. -GridFS is useful not only for storing files that exceed 16MB but also +GridFS is useful not only for storing files that exceed 16 MB but also for storing any files for which you want access without having to load the entire file into memory. For more information on the indications of GridFS, see :ref:`faq-developers-when-to-use-gridfs`. @@ -32,7 +32,7 @@ of GridFS, see :ref:`faq-developers-when-to-use-gridfs`. the context of sharding. .. versionchanged:: 2.4.10 - The default chunk size changed from 256k to 255k. + The default chunk size changed from 256 KB to 255 KB. .. index:: GridFS; initialize .. _gridfs-implement: diff --git a/source/core/journaling.txt b/source/core/journaling.txt index b247f957958..3cd770363d6 100644 --- a/source/core/journaling.txt +++ b/source/core/journaling.txt @@ -60,7 +60,7 @@ following intervals or conditions: WiredTiger forces a sync of the WiredTiger log files. - Because MongoDB uses a log file size limit of 100 MB, WiredTiger - creates a new journal file approximately every 100MB of data. When + creates a new journal file approximately every 100 MB of data. When WiredTiger creates a new journal file, WiredTiger syncs the previous journal file. diff --git a/source/core/master-slave.txt b/source/core/master-slave.txt index b62305947ff..74040463824 100644 --- a/source/core/master-slave.txt +++ b/source/core/master-slave.txt @@ -124,7 +124,7 @@ you start the ``master`` instance, by adding the :program:`mongod`. If you do not specify :option:`--oplogSize `, :program:`mongod` will allocate 5% of available disk space on start up to the oplog, with a -minimum of 1GB for 64bit machines and 50MB for 32bit machines. +minimum of 1 GB for 64-bit machines and 50 MB for 32-bit machines. Run time Master-Slave Configuration ----------------------------------- diff --git a/source/core/mmapv1.txt b/source/core/mmapv1.txt index d6d0d06a2fb..650379c2f38 100644 --- a/source/core/mmapv1.txt +++ b/source/core/mmapv1.txt @@ -78,8 +78,8 @@ Power of 2 Sized Allocations MongoDB 3.0 uses the power of 2 sizes allocation as the default record allocation strategy for MMAPv1. With the power of 2 sizes allocation strategy, each record has a size in bytes that is a power of 2 (e.g. -32, 64, 128, 256, 512 ... 2MB). For documents larger than 2MB, the -allocation is rounded up to the nearest multiple of 2MB. +32, 64, 128, 256, 512 ... 2 MB). For documents larger than 2 MB, the +allocation is rounded up to the nearest multiple of 2 MB. The power of 2 sizes allocation strategy has the following key properties: diff --git a/source/core/sharding-introduction.txt b/source/core/sharding-introduction.txt index f3d2bd73ad8..2cbb2946114 100644 --- a/source/core/sharding-introduction.txt +++ b/source/core/sharding-introduction.txt @@ -53,8 +53,8 @@ and large data sets: Each shard stores less data as the cluster grows. For example, if a database has a 1 terabyte data set, and there are - 4 shards, then each shard might hold only 256GB of data. If there - are 40 shards, then each shard might hold only 25GB of data. + 4 shards, then each shard might hold only 256 GB of data. If there + are 40 shards, then each shard might hold only 25 GB of data. Sharding in MongoDB ------------------- diff --git a/source/faq/diagnostics.txt b/source/faq/diagnostics.txt index 281c2477f13..cc1d947a4ce 100644 --- a/source/faq/diagnostics.txt +++ b/source/faq/diagnostics.txt @@ -163,7 +163,7 @@ To calculate how much RAM you need, you must calculate your working set size, or the portion of your data that clients use most often. This depends on your access patterns, what indexes you have, and the size of your documents. Because MongoDB uses a thread per connection model, each -database connection also will need up to 1MB of RAM, whether active or idle. +database connection also will need up to 1 MB of RAM, whether active or idle. If page faults are infrequent, your working set fits in RAM. If fault rates rise higher than that, you risk diff --git a/source/includes/extracts-wired-tiger.yaml b/source/includes/extracts-wired-tiger.yaml index 1b7df7c6eb1..40405169106 100644 --- a/source/includes/extracts-wired-tiger.yaml +++ b/source/includes/extracts-wired-tiger.yaml @@ -30,7 +30,7 @@ content: | seconds or 2 GB of data, depending on which occurs first. - Because MongoDB uses a log file size limit of 100 MB, WiredTiger - creates a new journal file approximately every 100MB of data. When + creates a new journal file approximately every 100 MB of data. When WiredTiger creates a new journal file, WiredTiger syncs the previous journal file. @@ -149,6 +149,6 @@ content: | more than 10 GB of RAM, the configuration is greater than the 3.0 setting. - In MongoDB 3.0, the WiredTiger cache, by default, uses either 1GB + In MongoDB 3.0, the WiredTiger cache, by default, uses either 1 GB or half of the installed physical RAM, whichever is larger. ... diff --git a/source/includes/note-suse-ulimit.rst b/source/includes/note-suse-ulimit.rst index 9352daed253..46b1e7c9108 100644 --- a/source/includes/note-suse-ulimit.rst +++ b/source/includes/note-suse-ulimit.rst @@ -1,8 +1,8 @@ .. note:: - SUSE Linux Enterprise Server 11 and potentially other versions of SLES - and other SUSE distributions ship with virtual memory address space limited - to 8GB by default. This *must* be adjusted in order to prevent virtual memory + SUSE Linux Enterprise Server 11 and potentially other versions of SLES and + other SUSE distributions ship with virtual memory address space limited to 8 + GB by default. This *must* be adjusted in order to prevent virtual memory allocation failures as the database grows. The SLES packages for MongoDB adjust these limits in the default scripts, diff --git a/source/includes/toc-data-modeling-concepts.yaml b/source/includes/toc-data-modeling-concepts.yaml index bd9a65ae297..ff931c0f23c 100644 --- a/source/includes/toc-data-modeling-concepts.yaml +++ b/source/includes/toc-data-modeling-concepts.yaml @@ -12,5 +12,5 @@ description: | file: /core/gridfs description: | GridFS is a specification for storing documents that exceeds the - :term:`BSON`\-document size limit of 16MB. + :term:`BSON`\-document size limit of 16 MB. ... diff --git a/source/reference/command/compact.txt b/source/reference/command/compact.txt index ae712e004d4..1d34366424d 100644 --- a/source/reference/command/compact.txt +++ b/source/reference/command/compact.txt @@ -89,7 +89,7 @@ Specifying ``paddingBytes`` can be useful if your documents start small but then increase in size significantly. For example, if your documents -are initially 40 bytes long and you grow them by 1KB, using +are initially 40 bytes long and you grow them by 1 KB, using ``paddingBytes: 1024`` might be reasonable since using ``paddingFactor: 4.0`` would specify a record size of 160 bytes (``4.0`` times the initial document size), which would only provide a padding of 120 bytes diff --git a/source/reference/gridfs.txt b/source/reference/gridfs.txt index a3e14846f69..589c1a5ade1 100644 --- a/source/reference/gridfs.txt +++ b/source/reference/gridfs.txt @@ -115,7 +115,7 @@ following fields. Applications may create additional arbitrary fields: the size specified here. The default size is 255 kilobytes. .. versionchanged:: 2.4.10 - The default chunk size changed from 256k to 255k. + The default chunk size changed from 256 KB to 255 KB. .. data:: files.uploadDate diff --git a/source/reference/method/db.setProfilingLevel.txt b/source/reference/method/db.setProfilingLevel.txt index 5ab1128d363..60409bb1ea8 100644 --- a/source/reference/method/db.setProfilingLevel.txt +++ b/source/reference/method/db.setProfilingLevel.txt @@ -22,7 +22,7 @@ Definition Configure the :setting:`~operationProfiling.slowOpThresholdMs` option to set the threshold for the profiler to consider a query "slow." Specify this value in - milliseconds to override the default, 100ms. + milliseconds to override the default, 100 ms. :program:`mongod` writes the output of the database profiler to the ``system.profile`` collection. diff --git a/source/tutorial/troubleshoot-replica-sets.txt b/source/tutorial/troubleshoot-replica-sets.txt index b1a8ca84886..0f1df6f24c3 100644 --- a/source/tutorial/troubleshoot-replica-sets.txt +++ b/source/tutorial/troubleshoot-replica-sets.txt @@ -223,7 +223,7 @@ connect to the member in a :program:`mongo` shell and run the The output displays the size of the oplog and the date ranges of the operations contained in the oplog. In the following example, the oplog -is about 10MB and is able to fit about 26 hours (94400 seconds) of +is about 10 MB and is able to fit about 26 hours (94400 seconds) of operations: .. code-block:: javascript