From 026256ef3a54fc2290b6d2279f15e4f246596f4e Mon Sep 17 00:00:00 2001 From: Ed Costello Date: Mon, 1 Apr 2013 23:50:17 -0500 Subject: [PATCH 1/8] minor typo cleanup after building doc with NITPICK=1 set --- source/administration/master-slave.txt | 2 +- source/administration/monitoring.txt | 2 +- .../administration/replica-set-architectures.txt | 2 +- source/administration/replica-sets.txt | 5 +++-- source/applications/aggregation.txt | 14 +++++++------- source/applications/indexes.txt | 2 +- source/applications/read.txt | 4 ++-- source/applications/text-search.txt | 2 +- source/core/replication-internals.txt | 4 ++-- source/includes/note-rs-conf-array-index.rst | 2 +- 10 files changed, 20 insertions(+), 19 deletions(-) diff --git a/source/administration/master-slave.txt b/source/administration/master-slave.txt index 7a7b6193525..917dd04d8f6 100644 --- a/source/administration/master-slave.txt +++ b/source/administration/master-slave.txt @@ -120,7 +120,7 @@ the slave will only attempt to re-sync once in a ten minute period. To prevent these situations you should specify the a larger oplog when you start the :setting:`master` instance, by adding the -:option:`--oplogSize ` option when starting +:option:`--oplogSize ` option when starting :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 diff --git a/source/administration/monitoring.txt b/source/administration/monitoring.txt index 4bb2aa81a2c..47d0e765f84 100644 --- a/source/administration/monitoring.txt +++ b/source/administration/monitoring.txt @@ -507,7 +507,7 @@ the following helper in the shell: See the :doc:`/reference/replica-status` document for a more in depth overview view of this output. In general watch the value of -:data:`~serverStatus.optimeDate`. Pay particular attention to the difference in +:data:`~replSetGetStatus.members.optimeDate`. Pay particular attention to the difference in time between the :term:`primary` and the :term:`secondary` members. The size of the operation log is only configurable during the first diff --git a/source/administration/replica-set-architectures.txt b/source/administration/replica-set-architectures.txt index 868319226d6..fea5fede290 100644 --- a/source/administration/replica-set-architectures.txt +++ b/source/administration/replica-set-architectures.txt @@ -65,7 +65,7 @@ conditions are true: If a member cannot function as a primary because of resource or network latency constraints a - :data:`~local.system.replset.members[n].priority>` value of ``0`` + :data:`~local.system.replset.members[n].priority` value of ``0`` prevents it from being a primary. Any member with a ``priority`` value greater than ``0`` is available to be a primary. diff --git a/source/administration/replica-sets.txt b/source/administration/replica-sets.txt index 6e244001e67..be54a0ee42c 100644 --- a/source/administration/replica-sets.txt +++ b/source/administration/replica-sets.txt @@ -241,7 +241,8 @@ following sequence of operations in the :program:`mongo` shell: After the replica set reconfigures, the first member of the set in the :data:`~local.system.replset.members` array will have a priority -of ``0`` and cannot become :term:`primary`. The :data:`slaveDelay ` value +of ``0`` and cannot become :term:`primary`. The +:data:`slaveDelay ` value delays both replication and the member's :term:`oplog` by 3600 seconds (1 hour). Setting :data:`~local.system.replset.members[n].slaveDelay` to a non-zero value also sets :data:`~local.system.replset.members[n].hidden` to @@ -1098,7 +1099,7 @@ operational errors: application systems. - No member is eligible to become primary. Members must have a - :data:`~local.system.replset.settings.gmembers[n].priority` setting greater than ``0``, have a state + :data:`~local.system.replset.settings.members[n].priority` setting greater than ``0``, have a state that is less than ten seconds behind the last operation to the :term:`replica set`, and generally be *more* up to date than the voting members. diff --git a/source/applications/aggregation.txt b/source/applications/aggregation.txt index c65c7b66096..9ac868c6fde 100644 --- a/source/applications/aggregation.txt +++ b/source/applications/aggregation.txt @@ -73,8 +73,8 @@ through the pipeline. - :pipeline:`$match` - :pipeline:`$limit` - :pipeline:`$skip` - - :pipeline:`$unwind` - - :pipeline:`$group` + - :pipeline:`~stage.$unwind` + - :pipeline:`~stage.$group` - :pipeline:`$sort` - :pipeline:`$geoNear` @@ -93,7 +93,7 @@ aggregation process. All aggregation expressions can only operate on the current document in the pipeline, and cannot integrate data from other documents. -The :term:`accumulator` expressions used in the :pipeline:`$group` +The :term:`accumulator` expressions used in the :pipeline:`~stage.$group` operator maintain that state (e.g. totals, maximums, minimums, and related data) as documents progress through the :term:`pipeline`. @@ -155,8 +155,8 @@ command: The aggregation pipeline begins with the :term:`collection` ``articles`` and selects the ``author`` and ``tags`` fields using the :pipeline:`$project` aggregation operator. The -:expression:`$unwind` operator produces one output document per -tag. Finally, the :expression:`$group` operator pivots these fields. +:expression:`~stage.$unwind` operator produces one output document per +tag. Finally, the :expression:`~stage.$group` operator pivots these fields. Result ~~~~~~ @@ -202,7 +202,7 @@ The above operators can also use an index when placed **before** the following aggregation operators: - :pipeline:`$project` -- :pipeline:`$unwind` +- :pipeline:`~stage.$unwind` - :pipeline:`$group`. .. versionadded:: 2.4 @@ -372,7 +372,7 @@ on the results received from the shards. The :pipeline:`$group` operator brings in any "sub-totals" from the shards and combines them: in some cases these may be -structures. For example, the :expression:`$avg` expression +structures. For example, the :expression:`~grp.$avg` expression maintains a total and count for each shard; :program:`mongos` combines these values and then divides. diff --git a/source/applications/indexes.txt b/source/applications/indexes.txt index 0590d65ad3d..2a9019408d4 100644 --- a/source/applications/indexes.txt +++ b/source/applications/indexes.txt @@ -215,7 +215,7 @@ An index **cannot** cover a query if: To determine whether a query is a covered query, use the :method:`~cursor.explain()` method. If the :method:`~cursor.explain()` -output displays ``true`` for the :data:`indexOnly` field, the query is +output displays ``true`` for the :data:`~explain.indexOnly` field, the query is covered by an index, and MongoDB queries only that index to match the query **and** return the results. diff --git a/source/applications/read.txt b/source/applications/read.txt index 8308ec702cf..c701c8e2100 100644 --- a/source/applications/read.txt +++ b/source/applications/read.txt @@ -386,10 +386,10 @@ first two elements in the ``contribs`` array: - :ref:`read-operations-subdocuments` for more examples on accessing subdocuments. - - :method:`$elemMatch` query operator for more information on + - :method:`~op.$elemMatch` query operator for more information on matching array elements. - - :projection:`$elemMatch` projection operator for additional + - :projection:`~prj.$elemMatch` projection operator for additional information on restricting array elements to return. .. _crud-read-cursor: diff --git a/source/applications/text-search.txt b/source/applications/text-search.txt index aa56a6cafce..ab04dc81805 100644 --- a/source/applications/text-search.txt +++ b/source/applications/text-search.txt @@ -94,7 +94,7 @@ documents in descending order, but you can specify a ``limit`` option to change the maximum number to return. Given a collection with a ``text`` index, use the -:method:`~db.collection.runCommand()` method to execute the +:method:`~db.runCommand()` method to execute the :dbcommand:`text` command, as in: .. code-block:: javascript diff --git a/source/core/replication-internals.txt b/source/core/replication-internals.txt index 9cee4a1d508..056e1c0ecdb 100644 --- a/source/core/replication-internals.txt +++ b/source/core/replication-internals.txt @@ -86,7 +86,7 @@ Replica sets can include members with the following four special configurations that affect membership behavior: - :ref:`Secondary-only ` members have - their :data:`priority ` values set to ``0`` and thus + their :data:`priority ` values set to ``0`` and thus are not eligible for election as primaries. - :ref:`Hidden ` members do not appear in the @@ -163,7 +163,7 @@ Any :program:`mongod` can veto an election. In the default configuration, all members have an equal chance of becoming primary; however, it's possible to set :data:`priority -` values that weight the election. In some +` values that weight the election. In some architectures, there may be operational reasons for increasing the likelihood of a specific replica set member becoming primary. For instance, a member located in a remote data center should *not* become diff --git a/source/includes/note-rs-conf-array-index.rst b/source/includes/note-rs-conf-array-index.rst index 052899b678e..cad2e7e673d 100644 --- a/source/includes/note-rs-conf-array-index.rst +++ b/source/includes/note-rs-conf-array-index.rst @@ -4,7 +4,7 @@ of the set using the index value in the array. The array index begins with ``0``. Do not confuse this index value with the value of the :data:`~local.system.replset.members[n]._id` field in each document in the - :data:`~local.system.replset.members[n].members` array. + :data:`~local.system.replset.members` array. The :data:`~local.system.replset.members[n]._id` rarely corresponds to the array index. From 91a8889fceffc63f8dc71f8045b0f05d21698df2 Mon Sep 17 00:00:00 2001 From: Ed Costello Date: Tue, 2 Apr 2013 11:48:37 -0400 Subject: [PATCH 2/8] minor: fix non resolving links --- source/core/replication-internals.txt | 8 ++++---- source/faq/concurrency.txt | 2 +- source/faq/replica-sets.txt | 7 ++++--- source/reference/aggregation/min.txt | 4 ++-- source/reference/aggregation/unwind.txt | 2 +- 5 files changed, 12 insertions(+), 11 deletions(-) diff --git a/source/core/replication-internals.txt b/source/core/replication-internals.txt index 056e1c0ecdb..3c8932da612 100644 --- a/source/core/replication-internals.txt +++ b/source/core/replication-internals.txt @@ -86,7 +86,7 @@ Replica sets can include members with the following four special configurations that affect membership behavior: - :ref:`Secondary-only ` members have - their :data:`priority ` values set to ``0`` and thus + their :data:`priority <~local.system.replset.members[n].priority>` values set to ``0`` and thus are not eligible for election as primaries. - :ref:`Hidden ` members do not appear in the @@ -163,7 +163,7 @@ Any :program:`mongod` can veto an election. In the default configuration, all members have an equal chance of becoming primary; however, it's possible to set :data:`priority -` values that weight the election. In some +<~local.system.replset.members[n].priority>` values that weight the election. In some architectures, there may be operational reasons for increasing the likelihood of a specific replica set member becoming primary. For instance, a member located in a remote data center should *not* become @@ -222,7 +222,7 @@ aware of the following conditions and possible situations: .. seealso:: :ref:`Non-voting members in a replica set `, :ref:`replica-set-node-priority-configuration`, and - :data:`replica configuration `. + :data:`replica configuration <~local.system.replset.members[n].votes>`. .. [#imply-secondary-only] Remember that :ref:`hidden ` and :ref:`delayed @@ -284,7 +284,7 @@ behaviors: - For one member to sync from another, both members must have the same value, either ``true`` or ``false``, for the - :data:`members[n].buildIndexes` field. + :data:`~local.system.replset.members[n].buildIndexes` field. .. [#connection-drop] Secondaries will stop syncing from a member if the connection used to poll oplog entries is unresponsive for 30 diff --git a/source/faq/concurrency.txt b/source/faq/concurrency.txt index da94a5b431b..5ff2118b9b1 100644 --- a/source/faq/concurrency.txt +++ b/source/faq/concurrency.txt @@ -68,7 +68,7 @@ following methods: - :doc:`mongostat `, and/or - the `MongoDB Monitoring Service (MMS) `_ -Specifically, the :data:`~server.Status.locks` document in the :doc:`output of +Specifically, the :data:`~serverStatus.locks` document in the :doc:`output of serverStatus `, or the :data:`~currentOp.locks` field in the :doc:`current operation reporting ` provides insight into the type of locks and amount of lock diff --git a/source/faq/replica-sets.txt b/source/faq/replica-sets.txt index 4a43a635de6..7f967b8065c 100644 --- a/source/faq/replica-sets.txt +++ b/source/faq/replica-sets.txt @@ -206,7 +206,7 @@ Which members of a replica set vote in elections? ------------------------------------------------- All members of a replica set, unless the value of :data:`votes -` is equal to ``0``, vote in elections. This includes +<~local.system.replset.members[n].votes>` is equal to ``0``, vote in elections. This includes all :ref:`delayed `, :ref:`hidden ` and :ref:`secondary-only ` members, as well as the @@ -219,8 +219,9 @@ Do hidden members vote in replica set elections? :ref:`Hidden members ` of term:`replica :sets` *do* vote in elections. To exclude a member from voting in an -:election, change the value of the member's :data:`votes -:` configuration to ``0``. +:election, change the value of the member's +:data:`~local.system.replset.members[n].votes` +configuration to ``0``. .. seealso:: :ref:`replica-set-elections` diff --git a/source/reference/aggregation/min.txt b/source/reference/aggregation/min.txt index 241e52be785..01278d0bc61 100644 --- a/source/reference/aggregation/min.txt +++ b/source/reference/aggregation/min.txt @@ -109,8 +109,8 @@ $min (aggregation) { $group: { _id: 0, minAge: { $min: "$age"} } } ] ) - The :pipeline:`$min` operation returns ``null`` for the minimum - age since **all** documents for the :pipeline:`$min` operation + The :group:`$min` operation returns ``null`` for the minimum + age since **all** documents for the :group:`$min` operation have ``null`` value for the field ``age`` or are missing the field: diff --git a/source/reference/aggregation/unwind.txt b/source/reference/aggregation/unwind.txt index ad29c58a848..22aa622cfac 100644 --- a/source/reference/aggregation/unwind.txt +++ b/source/reference/aggregation/unwind.txt @@ -81,7 +81,7 @@ $unwind (aggregation) input document, and will generate no result documents. - If you specify a target field for :pipeline:`$unwind` that is - not an array, :method:`aggregate()` generates an error. + not an array, :method:`db.collection.aggregate()` generates an error. - If you specify a target field for :pipeline:`$unwind` that holds an empty array (``[]``) in an input document, the From efcfacc4e520e611fd34b4c63ff32dc4be0d0fd4 Mon Sep 17 00:00:00 2001 From: Ed Costello Date: Tue, 2 Apr 2013 11:48:59 -0400 Subject: [PATCH 3/8] minor: fix erroneous hostInfo field --- source/reference/command/hostInfo.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/command/hostInfo.txt b/source/reference/command/hostInfo.txt index e92eed47ef7..098ad6269a1 100644 --- a/source/reference/command/hostInfo.txt +++ b/source/reference/command/hostInfo.txt @@ -154,7 +154,7 @@ hostInfo .. data:: hostInfo.extra.nfsAsync - :data:`~hostInfo.extra.nfsFullSync` only appears on OS X + :data:`~hostInfo.extra.nfsAsync` only appears on OS X systems. .. data:: hostInfo.extra.cpuFrequencyMHz From 6e5e38fe2d4ae71def67b3f1b82b4dbf7e568594 Mon Sep 17 00:00:00 2001 From: Ed Costello Date: Tue, 2 Apr 2013 14:59:23 -0400 Subject: [PATCH 4/8] minor: link resolution fixed and minor copy editing --- .../example-server-status-projection.rst | 3 ++- .../includes/fact-authentication-source-tool.rst | 4 ++-- source/includes/manpage-options-auth.rst | 2 +- source/reference/command/isMaster.txt | 2 +- source/reference/command/journalLatencyTest.txt | 2 +- source/reference/command/text.txt | 4 ++-- source/reference/configuration-options.txt | 2 +- source/reference/database-profiler.txt | 2 +- source/reference/local-database.txt | 2 +- source/reference/method/db.addUser.txt | 2 +- .../method/db.collection.ensureIndex.txt | 12 ++++++------ .../method/db.collection.findAndModify.txt | 4 ++-- source/reference/method/load.txt | 6 +++--- source/reference/mongod.txt | 16 +++------------- source/reference/mongoperf.txt | 6 +++--- source/reference/parameters.txt | 8 ++++---- source/reference/replica-configuration.txt | 2 +- source/reference/replica-status.txt | 2 +- source/reference/server-status.txt | 10 +++++----- source/reference/text-search.txt | 6 +++--- source/reference/user-privileges.txt | 6 +++--- source/release-notes/2.4-overview.txt | 2 +- source/release-notes/2.4.txt | 12 ++++++------ source/tutorial/aggregation-examples.txt | 14 +++++++------- ...s-to-mongodb-with-kerberos-authentication.txt | 2 +- ...e-text-index-on-multi-language-collection.txt | 4 ++-- source/tutorial/enable-text-search.txt | 2 +- source/tutorial/expand-replica-set.txt | 4 ++-- source/tutorial/force-member-to-be-primary.txt | 4 ++-- source/tutorial/install-mongodb-on-windows.txt | 6 +++--- .../manage-chunks-in-sharded-cluster.txt | 5 +++-- source/tutorial/manage-the-database-profiler.txt | 4 ++-- source/tutorial/remove-shards-from-cluster.txt | 4 ++-- 33 files changed, 79 insertions(+), 87 deletions(-) diff --git a/source/includes/example-server-status-projection.rst b/source/includes/example-server-status-projection.rst index 40471b66037..1c4d86c06ad 100644 --- a/source/includes/example-server-status-projection.rst +++ b/source/includes/example-server-status-projection.rst @@ -4,6 +4,7 @@ .. note:: You may only dynamically include top-level fields from the - :data:`serverStatus` document that are not included by default. You + :doc:`serverStatus ` + document that are not included by default. You can exclude any field that |operation-name| includes by default. diff --git a/source/includes/fact-authentication-source-tool.rst b/source/includes/fact-authentication-source-tool.rst index 68ca7aa1d1c..30d9293642e 100644 --- a/source/includes/fact-authentication-source-tool.rst +++ b/source/includes/fact-authentication-source-tool.rst @@ -1,3 +1,3 @@ By default, |binary-name| assumes that the database specified to the -:option:`--db` argument holds the user's credentials, unless you -specify :option:`--authenticationDatabase`. +:option:`|binary-name| --db` argument holds the user's credentials, unless you +specify :option:`|binary-name| --authenticationDatabase`. diff --git a/source/includes/manpage-options-auth.rst b/source/includes/manpage-options-auth.rst index 1c4953a0672..42bc5c8510f 100644 --- a/source/includes/manpage-options-auth.rst +++ b/source/includes/manpage-options-auth.rst @@ -5,7 +5,7 @@ .. versionadded:: 2.4 Specifies the database that holds the user's (e.g - :option:`--username`) credentials. + :option:`--username <|binary-name| --username>`) credentials. .. build system replaces this with /includes/fact-authentication-source-mongo on the mongo shell diff --git a/source/reference/command/isMaster.txt b/source/reference/command/isMaster.txt index d3624a5a910..6bd2d27afa2 100644 --- a/source/reference/command/isMaster.txt +++ b/source/reference/command/isMaster.txt @@ -83,7 +83,7 @@ isMaster .. versionadded:: 2.1.1 Returns the local server time in UTC. This value is a - :term:`ISOdate`. You can use the :method:`toString()` + :term:`ISOdate`. You can use the :js:func:`toString()` JavaScript method to convert this value to a local date string, as in the following example: diff --git a/source/reference/command/journalLatencyTest.txt b/source/reference/command/journalLatencyTest.txt index 113a64617a1..4d8a27755b9 100644 --- a/source/reference/command/journalLatencyTest.txt +++ b/source/reference/command/journalLatencyTest.txt @@ -20,5 +20,5 @@ journalLatencyTest The value (i.e. ``1`` above), does not affect the operation of the command. - .. |dbcommand| replace:: :dbcommand:`_journalLatencyTest` + .. |dbcommand| replace:: :dbcommand:`journalLatencyTest` .. include:: /includes/note-enabletestcommands.rst diff --git a/source/reference/command/text.txt b/source/reference/command/text.txt index 661e19286c7..2394d89c5ee 100644 --- a/source/reference/command/text.txt +++ b/source/reference/command/text.txt @@ -96,8 +96,8 @@ text an array of the highest scoring documents, in descending order by score. See :ref:`text-search-output` for details. - The returned document must fit within the :limit:`BSON - Document Size`. Otherwise, the command will return as many + The returned document must fit within the + :limit:`BSON Document Size`. Otherwise, the command will return as many results as not to exceed the :limit:`BSON Document Size`. Use the ``limit`` and the ``project`` parameters to limit the size of the result set. diff --git a/source/reference/configuration-options.txt b/source/reference/configuration-options.txt index b5227ecbe52..c8279a779d0 100644 --- a/source/reference/configuration-options.txt +++ b/source/reference/configuration-options.txt @@ -760,7 +760,7 @@ Master/Slave Replication Used with the :setting:`slave` setting, set :setting:`autoresync` to ``true`` to force the :term:`slave` to automatically resync if it is more than 10 seconds behind the master. This setting may be - problematic if the :setting:`--oplogSize ` + problematic if the :setting:`--oplogSize` of the :term:`oplog` is too small (controlled by the :option:`--oplogSize ` option.) If the :term:`oplog` is not large enough to store the difference in changes between the master's diff --git a/source/reference/database-profiler.txt b/source/reference/database-profiler.txt index b3c0b7694aa..ce72b6b440c 100644 --- a/source/reference/database-profiler.txt +++ b/source/reference/database-profiler.txt @@ -129,7 +129,7 @@ operation. :method:`limit(5) ` command would return five documents so the :data:`~system.profile.ntoreturn` value would be ``5``. - If the :data:`ntoreturn` value is ``0``, the command did not specify a + If the :data:`~system.profile.ntoreturn` value is ``0``, the command did not specify a number of documents to return, as would be the case with a simple :method:`find() ` command with no limit specified. diff --git a/source/reference/local-database.txt b/source/reference/local-database.txt index a678011f98d..ee643a2e889 100644 --- a/source/reference/local-database.txt +++ b/source/reference/local-database.txt @@ -105,7 +105,7 @@ Collection on all ``mongod`` Instances A sub-document that reports information about the build environment and settings used to compile this :program:`mongod`. This is the same output as - :dbcommand:`buildInfo`. See :data:`buildinfo` + :dbcommand:`buildInfo`. See :data:`buildInfo`. Collections on Replica Set Members ---------------------------------- diff --git a/source/reference/method/db.addUser.txt b/source/reference/method/db.addUser.txt index cf7a931b96e..c7c103214af 100644 --- a/source/reference/method/db.addUser.txt +++ b/source/reference/method/db.addUser.txt @@ -104,6 +104,6 @@ db.addUser() .. deprecated:: 2.4 The ``roles`` parameter replaces the ``readOnly`` parameter for :method:`db.addUser()`. 2.4 also adds - the :data:`~.system.users.otherDBRoles` and + the :data:`~admin.system.users.otherDBRoles` and :data:`~.system.users.userSource` fields to documents in the :data:`system.users <.system.users>` collection. diff --git a/source/reference/method/db.collection.ensureIndex.txt b/source/reference/method/db.collection.ensureIndex.txt index c0cf9956478..4b11a729033 100644 --- a/source/reference/method/db.collection.ensureIndex.txt +++ b/source/reference/method/db.collection.ensureIndex.txt @@ -216,15 +216,15 @@ db.collection.ensureIndex() :method:`~db.collection.ensureIndex()`: - To add or change index options you must drop the index using the - :method:`db.collection.dropIndex()` and issue another - :method:`ensureIndex() ` operation + :method:`~db.collection.dropIndex()` method and issue another + :method:`~db.collection.ensureIndex()` operation with the new options. If you create an index with one set of options, and then issue - :method:`ensureIndex() ` method - command with the same index fields and different options without - first dropping the index, :method:`ensureIndex() - ` will *not* rebuild the existing + the :method:`~db.collection.ensureIndex()` method + with the same index fields and different options without + first dropping the index, + :method:`~db.collection.ensureIndex()` will *not* rebuild the existing index with the new options. - If you call multiple :method:`ensureIndex() ` diff --git a/source/reference/method/db.collection.findAndModify.txt b/source/reference/method/db.collection.findAndModify.txt index 2de5632d6bd..b043997623d 100644 --- a/source/reference/method/db.collection.findAndModify.txt +++ b/source/reference/method/db.collection.findAndModify.txt @@ -10,11 +10,11 @@ db.collection.findAndModify() .. method:: db.collection.findAndModify - The :method:`db.collection.findAndModify()` method atomically + The :method:`~db.collection.findAndModify()` method atomically modifies and returns a single document. By default, the returned document does not include the modifications made on the update. To return the document with the modifications made on the update, use - the ``new`` option. The :method:`~findAndModify()` method is a shell + the ``new`` option. The :method:`~db.collection.findAndModify()` method is a shell helper around the :dbcommand:`findAndModify` command. .. code-block:: none diff --git a/source/reference/method/load.txt b/source/reference/method/load.txt index 8f697e88b66..f5648271060 100644 --- a/source/reference/method/load.txt +++ b/source/reference/method/load.txt @@ -4,10 +4,10 @@ load() .. default-domain:: mongodb -.. method:: load("file") +.. method:: load( ) - :para string file: Specify a path and file name containing - JavaScript. + :param string file: Specify a path and file name containing + JavaScript. This native function loads and runs a JavaScript file into the current shell environment. To run JavaScript with the mongo shell, diff --git a/source/reference/mongod.txt b/source/reference/mongod.txt index 4749117040f..e6faa061b83 100644 --- a/source/reference/mongod.txt +++ b/source/reference/mongod.txt @@ -404,7 +404,7 @@ Options for the :option:`--repair` operation. Defaults to a ``_tmp`` directory within the :setting:`dbpath`. -.. option:: --setParameter +.. option:mongod: --setParameter .. versionadded:: 2.4 @@ -600,8 +600,8 @@ replica sets are the preferred configuration for database replication. For use with the :option:`--slave` option. When set, :option:`--autoresync` option allows this slave to automatically resync if it is more than 10 seconds behind the master. This - setting may be problematic if the :setting:`--oplogSize` specifies - a too small oplog (controlled by the :option:`--oplogSize` option.) + setting may be problematic if the :option:`--oplogSize` specifies + a too small oplog. If the :term:`oplog` is not large enough to store the difference in changes between the master's current state and the state of the slave, this instance will forcibly resync itself @@ -609,16 +609,6 @@ replica sets are the preferred configuration for database replication. ``false``, the slave will not attempt an automatic resync more than once in a ten minute period. - - resync if the local data is more than 10 seconds behind the - master. This option may be problematic if the :term:`oplog` is too - small (controlled by the :option:`--oplogSize` option.) If the - :term:`oplog` not large enough to store the difference in changes - between the master's current state and the state of the slave, this - node will forcibly resync itself unnecessarily. When you set the If - the :option:`--autoresync` option the slave will not attempt an - automatic resync more than once in a ten minute period. - Sharding Cluster Options ```````````````````````` diff --git a/source/reference/mongoperf.txt b/source/reference/mongoperf.txt index a2f5c590eee..2abee6b0b39 100644 --- a/source/reference/mongoperf.txt +++ b/source/reference/mongoperf.txt @@ -123,7 +123,7 @@ Configuration Fields tests direct, physical, I/O, without caching. Use a large file size to test heavy random I/O load and to avoid I/O coalescing. - - when :setting:`~mongoperf.mmf` is ``true``, :program:`mongoperf` + - when :setting:`mongoperf.mmf` is ``true``, :program:`mongoperf` runs tests of the caching system, and can use normal file system cache. Use :program:`mmf` in this mode to test file system cache behavior with memory mapped files. @@ -166,8 +166,8 @@ Configuration Fields *Default:* 0 - Seconds between disk flushes. :setting:`~mongoperf.syncDelay` is - similar to :setting:`syncDelay` for :program:`mongod`. + Seconds between disk flushes. :setting:`mongoperf.syncDelay` is + similar to :option:`--syncdelay ` for :program:`mongod`. The :setting:`~mongoperf.syncDelay` controls how frequently :program:`mongoperf` performs an asynchronous disk flush the memory diff --git a/source/reference/parameters.txt b/source/reference/parameters.txt index 2ac0ed16d9b..190aab52ba2 100644 --- a/source/reference/parameters.txt +++ b/source/reference/parameters.txt @@ -126,7 +126,7 @@ Parameters .. versionadded:: 2.4 Specify the number of oplog entries to apply as a single batch. - :option:`replApplyBatchSize` must be an integer between 1 and 1024. + :param:`replApplyBatchSize` must be an integer between 1 and 1024. Only specify this option on :term:`secondary` members of :term:`replica sets `. @@ -137,15 +137,15 @@ Parameters .. versionadded:: 2.4 - :parameter:`saslHostname` overrides MongoDB's default hostname + :parameter:`saslHostName` overrides MongoDB's default hostname detection for the purpose of configuring SASL and Kerberos authentication. - :parameter:`saslHostname` does not affect the hostname of the + :parameter:`saslHostName` does not affect the hostname of the :program:`mongod` or :program:`mongos` instance for any purpose beyond the configuration of SASL and Kerberos. - You can only set :setting:`saslHostName` during start-up, and + You can only set :parameter:`saslHostName` during start-up, and cannot change this setting using the :dbcommand:`setParameter` database command. diff --git a/source/reference/replica-configuration.txt b/source/reference/replica-configuration.txt index 609967c84ab..62c0a4f6c2a 100644 --- a/source/reference/replica-configuration.txt +++ b/source/reference/replica-configuration.txt @@ -262,7 +262,7 @@ Configuration Variables **Type**: :term:`MongoDB Document ` Defines the names and combination of - :data:`~local.system.replset.members[n]` for use by the application layer + :data:`~local.system.replset.members` for use by the application layer to guarantee :term:`write concern` to database using the :dbcommand:`getLastError` command to provide :term:`data-center awareness`. diff --git a/source/reference/replica-status.txt b/source/reference/replica-status.txt index 0218e466929..35aa5fd280a 100644 --- a/source/reference/replica-status.txt +++ b/source/reference/replica-status.txt @@ -41,7 +41,7 @@ Fields The ``set`` value is the name of the replica set, configured in the :setting:`replSet` setting. This is the same value as - :data:`~local.system.replset.settings._id` in :method:`rs.conf()`. + :data:`~local.system.replset._id` in :method:`rs.conf()`. .. data:: replSetGetStatus.date diff --git a/source/reference/server-status.txt b/source/reference/server-status.txt index e0430302b85..1ca8d1cdfb3 100644 --- a/source/reference/server-status.txt +++ b/source/reference/server-status.txt @@ -1239,7 +1239,7 @@ metrics .. data:: serverStatus.metrics.document.deleted - :data:`~serverStatus.metrics.document.related` reports the total + :data:`~serverStatus.metrics.document.deleted` reports the total number of documents deleted. .. data:: serverStatus.metrics.document.inserted @@ -1278,7 +1278,7 @@ metrics .. data:: serverStatus.metrics.getLastError.wtime.totalMillis` - :data:`~serverStatus.metrics.getLastError.wtime.totalMills` reports + :data:`~serverStatus.metrics.getLastError.wtime.totalMillis` reports the total amount of time in milliseconds that the :program:`mongod` has spent performing :dbcommand:`getLastError` operations with write concern (i.e. ``w``) that wait for one or more members of a @@ -1375,9 +1375,9 @@ metrics :data:`~serverStatus.metrics.repl.apply.batches.num` reports the total number of batches applied across all databases. -.. data:: serverStatus.metrics.repl.apply.batches.totalMills +.. data:: serverStatus.metrics.repl.apply.batches.totalMillis - :data:`~serverStatus.metrics.repl.apply.batches.totalMills` reports + :data:`~serverStatus.metrics.repl.apply.batches.totalMillis` reports the total amount of time the :program:`mongod` has spent applying operations from the oplog. @@ -1408,7 +1408,7 @@ metrics .. data:: serverStatus.metrics.repl.buffer.sizeBytes - :data:`~serverStatus.metrics.repl.sizeBytes` reports the current + :data:`~serverStatus.metrics.repl.buffer.sizeBytes` reports the current size of the contents of the oplog buffer. .. data:: serverStatus.metrics.repl.network diff --git a/source/reference/text-search.txt b/source/reference/text-search.txt index b0d3aeb567e..56f2e136298 100644 --- a/source/reference/text-search.txt +++ b/source/reference/text-search.txt @@ -16,8 +16,8 @@ example: The complete results of the :dbcommand:`text` command must fit within the :limit:`BSON Document Size`. Otherwise, the command will - limit the results to fit within the :limit:`BSON Document - Size`. Use the ``limit`` and the ``project`` parameters with the + limit the results to fit within the :limit:`BSON Document Size`. + Use the ``limit`` and the ``project`` parameters with the :dbcommand:`text` command to limit the size of the result set. .. code-block:: javascript @@ -93,7 +93,7 @@ The returned document contains the following fields: .. data:: text.stats.nscanned - The :data:`~data::text.stats.nscanned` field returns the total + The :data:`~text.stats.nscanned` field returns the total number of index entries scanned. .. data:: text.stats.nscannedObjects diff --git a/source/reference/user-privileges.txt b/source/reference/user-privileges.txt index b0fa913d427..69f09bb48dd 100644 --- a/source/reference/user-privileges.txt +++ b/source/reference/user-privileges.txt @@ -110,12 +110,12 @@ Database Administration Roles - :dbcommand:`collStats` - :dbcommand:`compact` - :dbcommand:`convertToCapped` - - :dbcommand:`createCollection` - :dbcommand:`create` + - :method:`db.createCollection()` - :dbcommand:`dbStats` - :method:`~db.collection.drop()` - :dbcommand:`dropIndexes` - - :dbcommand:`ensureIndex` + - :method:`db.collection.ensureIndex()` - :dbcommand:`profile` - :dbcommand:`reIndex` - :dbcommand:`renameCollection` (within a single database.) @@ -226,7 +226,7 @@ Any Database Roles You must specify the following "any" database roles on the ``admin`` databases. These roles apply to all databases in a - :program:`MongoDB` instance, and are roughly equivalent to their + :program:`mongod` instance, and are roughly equivalent to their single-database equivalents. If you add any of these roles to a :doc:`user privilege document diff --git a/source/release-notes/2.4-overview.txt b/source/release-notes/2.4-overview.txt index 43f7053d2a2..d5b42788884 100644 --- a/source/release-notes/2.4-overview.txt +++ b/source/release-notes/2.4-overview.txt @@ -19,7 +19,7 @@ Developer Productivity leverage real-time, in-place analytics. MongoDB 2.4 includes significant performance improvements, additional support for binary data, support for :operator:`$geoWithin` and :operator:`$near` geospatial - queries, improved string concatenation with the new :operator:`$concat` + queries, improved string concatenation with the new :expression:`$concat` operator, and improved date calculation semantics. - Geospatial enhancements support new use cases with support for diff --git a/source/release-notes/2.4.txt b/source/release-notes/2.4.txt index 55e70b330a5..46837c2967b 100644 --- a/source/release-notes/2.4.txt +++ b/source/release-notes/2.4.txt @@ -144,8 +144,8 @@ provides more granular privileges to MongoDB users. See :doc:`/reference/user-privileges` for more information. To support the new access control system, 2.4 also introduces a new -format for documents in a database's :data:`system.user -<.system.user>` collection. See +format for documents in a database's +:data:`system.user <.system.users>` collection. See :doc:`/reference/privilege-documents` for more information. Use :parameter:`supportCompatibilityFormPrivilegeDocuments` to disable @@ -177,7 +177,7 @@ Administration Changes ``--setParameter`` Option Available on the ``mongos`` and ``mongod`` Command Line ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You can now use :option:`--setParameter ` on the command line +You can now use :option:`--setParameter ` on the command line and :setting:`setParameter` in the configuration file. Currently :setting:`setParameter` provides the following options: @@ -208,7 +208,7 @@ output of the :dbcommand:`serverStatus` command, including: documentation. Additionally, in 2.4, the :dbcommand:`serverStatus` command can -dynamically construct the :data:`serverStatus` document by excluding +dynamically construct the :doc:`serverStatus ` document by excluding any top-level sections included by default, or including any top-level section not included by default (e.g. :data:`~serverStatus.workingSet`.) @@ -349,9 +349,9 @@ behavior including the :dbcommand:`mapReduce`, :dbcommand:`group`, and :dbcommand:`eval` commands, as well as the :operator:`$where` query operator. -Use the new :method:`interpreterVersion()` method in the +Use the new :js:func:`interpreterVersion()` method in the :program:`mongo` shell and the -:data:`~serverBuildInfo.javascriptEngine` field in the output of +:data:`~buildInfo.javascriptEngine` field in the output of :method:`db.serverBuildInfo()` to determine which JavaScript engine a MongoDB binary uses. diff --git a/source/tutorial/aggregation-examples.txt b/source/tutorial/aggregation-examples.txt index 8c3cae36345..b8c87137af7 100644 --- a/source/tutorial/aggregation-examples.txt +++ b/source/tutorial/aggregation-examples.txt @@ -95,7 +95,7 @@ In the above example, the pipeline passes all documents in the These new per-state documents have one field in addition the ``_id`` field: ``totalPop`` which is a generated field using the - :expression:`$sum` operation to calculate the total value of all + :group:`$sum` operation to calculate the total value of all ``pop`` fields in the source documents. After the :pipeline:`$group` operation the documents in the @@ -168,7 +168,7 @@ In the above example, the pipeline passes all documents in the } - the second :pipeline:`$group` operator collects documents by the - ``state`` field and use the :expression:`$avg` expression to + ``state`` field and use the :group:`$avg` expression to compute a value for the ``avgCityPop`` field. The final output of this aggregation operation is: @@ -231,7 +231,7 @@ which consists of the following steps: both fields, the operation preserves the ``state`` field for use later in the pipeline. The documents produced by this stage of the pipeline have a second field, ``pop``, which uses the - :expression:`$sum` operator to provide the total of the ``pop`` + :group:`$sum` operator to provide the total of the ``pop`` fields in the source document. At this stage in the pipeline, the documents resemble the following: @@ -255,10 +255,10 @@ which consists of the following steps: nested ``_id`` document. Within each per-state document this :pipeline:`$group` operator - specifies four fields: Using the :expression:`$last` expression, + specifies four fields: Using the :group:`$last` expression, the :pipeline:`$group` operator creates the ``biggestcity`` and ``biggestpop`` fields that store the city with the largest - population and that population. Using the :expression:`$first` + population and that population. Using the :group:`$first` expression, the :pipeline:`$group` operator creates the ``smallestcity`` and ``smallestpop`` fields that store the city with the smallest population and that population. @@ -572,7 +572,7 @@ the following operations: - ``_id``, which contains a nested document with the ``month_joined`` field and its value. - - ``number``, which is a generated field. The :expression:`$sum` + - ``number``, which is a generated field. The :group:`$sum` operator increments this field by 1 for every document containing the given ``month_joined`` value. @@ -663,7 +663,7 @@ and passes these documents through the following operations: - ``_id``, which contains the ``likes`` value. - - ``number``, which is a generated field. The :expression:`$sum` + - ``number``, which is a generated field. The :group:`$sum` operator increments this field by 1 for every document containing the given ``likes`` value. diff --git a/source/tutorial/control-access-to-mongodb-with-kerberos-authentication.txt b/source/tutorial/control-access-to-mongodb-with-kerberos-authentication.txt index 573400fd3eb..cd764d6cb04 100644 --- a/source/tutorial/control-access-to-mongodb-with-kerberos-authentication.txt +++ b/source/tutorial/control-access-to-mongodb-with-kerberos-authentication.txt @@ -127,7 +127,7 @@ Once you have provisioned privileges to users in the For successful operation with :program:`mongod` use the following run time options in addition to your normal default configuration options: -- :option:`--setParameter ` with the +- :option:`--setParameter ` with the ``authenticationMechanisms=GSSAPI`` argument to enable support for Kerberos. diff --git a/source/tutorial/create-text-index-on-multi-language-collection.txt b/source/tutorial/create-text-index-on-multi-language-collection.txt index c9be86d88ae..a61f517c43d 100644 --- a/source/tutorial/create-text-index-on-multi-language-collection.txt +++ b/source/tutorial/create-text-index-on-multi-language-collection.txt @@ -11,12 +11,12 @@ If a collection contains documents that are in different languages, include a field in the documents that contain the language to use: - If you include a field named ``language`` in the document, by - default, the :dbcommand:`db.collection.ensureIndex()` method will use + default, the :method:`db.collection.ensureIndex()` method will use the value of this field to override the default language. - To use a field with a name other than ``language``, you must specify the name of this field to the - :dbcommand:`db.collection.ensureIndex()` method with the + :method:`db.collection.ensureIndex()` method with the ``language_override`` option. See :ref:`text-search-languages` for a list of supported languages. diff --git a/source/tutorial/enable-text-search.txt b/source/tutorial/enable-text-search.txt index 96b89cf9e02..0454dd7b416 100644 --- a/source/tutorial/enable-text-search.txt +++ b/source/tutorial/enable-text-search.txt @@ -17,7 +17,7 @@ You can enable the text search feature at startup with the mongod --setParameter textSearchEnabled=true -You may prefer to set the :setting:`textSearchEnabled` parameter in the +You may prefer to set the :parameter:`textSearchEnabled` parameter in the :doc:`configuration file `. Additionally, you can enable the feature in the :program:`mongo` shell diff --git a/source/tutorial/expand-replica-set.txt b/source/tutorial/expand-replica-set.txt index c62bb7ab4d7..7cd21dcd4ae 100644 --- a/source/tutorial/expand-replica-set.txt +++ b/source/tutorial/expand-replica-set.txt @@ -164,7 +164,7 @@ This configures a :term:`hidden member` that is accessible at ``mongodb3.example.net:27017``. See :data:`host `, :data:`priority `, and :data:`hidden -` for more information about +` for more information about these settings. When you specify a full configuration object with :method:`rs.add()`, you must declare the ``_id`` field, which is not automatically populated in this case. @@ -201,4 +201,4 @@ Production Notes - add the new member as a :ref:`non-voting members ` or, - - remove votes from an :data:`existing member `. + - remove votes from an :data:`existing member `. diff --git a/source/tutorial/force-member-to-be-primary.txt b/source/tutorial/force-member-to-be-primary.txt index f60cec2b4d5..b4083a7cd04 100644 --- a/source/tutorial/force-member-to-be-primary.txt +++ b/source/tutorial/force-member-to-be-primary.txt @@ -71,7 +71,7 @@ This procedure assumes this configuration: rs.reconfig(cfg) This sets ``m3.example.net`` to have a higher - :data:`members[n].priority` value than the other :program:`mongod` + :data:`local.system.replset.members[n].priority` value than the other :program:`mongod` instances. The following sequence of events occur: @@ -88,7 +88,7 @@ This procedure assumes this configuration: - The step down forces on election in which ``m3.example.net`` becomes primary based on its :data:`priority - ` setting. + ` setting. #. Optionally, if ``m3.example.net`` is more than 10 seconds behind ``m1.example.net``'s optime, and if you don't need to have a primary diff --git a/source/tutorial/install-mongodb-on-windows.txt b/source/tutorial/install-mongodb-on-windows.txt index 94ec4bbaee4..43e1d964c29 100644 --- a/source/tutorial/install-mongodb-on-windows.txt +++ b/source/tutorial/install-mongodb-on-windows.txt @@ -161,7 +161,7 @@ indicates that the mongod.exe process is running successfully. database does not enable authentication or "Secure Mode" by default. -Connect to MongoDB using the :program:`mongo.exe` shell. Open another +Connect to MongoDB using the :program:`mongo.exe ` shell. Open another :guilabel:`Command Prompt` and issue the following command: .. code-block:: powershell @@ -174,9 +174,9 @@ Connect to MongoDB using the :program:`mongo.exe` shell. Open another automatically start the :program:`mongo.exe` shell in a separate :guilabel:`Command Prompt` window. -The :program:`mongo.exe` shell will connect to :program:`mongod.exe` running on +The :program:`mongo.exe ` shell will connect to :program:`mongod.exe` running on the localhost interface and port ``27017`` by default. At the -:program:`mongo.exe` prompt, issue the following two commands to +:program:`mongo.exe ` prompt, issue the following two commands to insert a record in the ``test`` :term:`collection` of the default ``test`` database and then retrieve that record: diff --git a/source/tutorial/manage-chunks-in-sharded-cluster.txt b/source/tutorial/manage-chunks-in-sharded-cluster.txt index 6783a107928..a9c5440efa3 100644 --- a/source/tutorial/manage-chunks-in-sharded-cluster.txt +++ b/source/tutorial/manage-chunks-in-sharded-cluster.txt @@ -206,8 +206,9 @@ to modify the chunk size, use the following procedure: .. note:: - The :setting:`chunkSize` and :option:`--chunkSize ` options, passed at runtime to the :program:`mongos` + The :setting:`chunkSize` and + :option:`--chunkSize ` + options, passed at runtime to the :program:`mongos` **do not** affect the chunk size after you have initialized the cluster. [#mongos-initialization]_ diff --git a/source/tutorial/manage-the-database-profiler.txt b/source/tutorial/manage-the-database-profiler.txt index d7fb26da387..e72f9872076 100644 --- a/source/tutorial/manage-the-database-profiler.txt +++ b/source/tutorial/manage-the-database-profiler.txt @@ -41,8 +41,8 @@ The following profiling levels are available: slow operations are those slower than 100 milliseconds. You can modify the threshold for "slow" operations with the - :setting:`slowms` runtime option or the :dbcommand:`set Parameter` - method. See the :ref:`database-profiling-specify-slowms-threshold` + :setting:`slowms` runtime option or the :dbcommand:`setParameter` + command. See the :ref:`database-profiling-specify-slowms-threshold` section for more information. - ``2`` - collects profiling data for all database operations. diff --git a/source/tutorial/remove-shards-from-cluster.txt b/source/tutorial/remove-shards-from-cluster.txt index ccdda3c82c0..26f3a0b11b5 100644 --- a/source/tutorial/remove-shards-from-cluster.txt +++ b/source/tutorial/remove-shards-from-cluster.txt @@ -53,7 +53,7 @@ To determine the name of the shard, do one of the following: - From the ``admin`` database, run the :dbcommand:`listShards` command. - Run either the :method:`sh.status()` method or the - :method:`sh.printShardingStatus()` method. + :method:`db.printShardingStatus()` method. The ``shards._id`` field lists the name of each shard. @@ -129,7 +129,7 @@ primary shards.) - :method:`sh.status()` - - :method:`sh.printShardingStatus()` + - :method:`db.printShardingStatus()` In the resulting document, the ``databases`` field lists each database and its primary shard. For example, the following From 92254b655557166b632883c99bf8cef14562c506 Mon Sep 17 00:00:00 2001 From: Ed Costello Date: Tue, 2 Apr 2013 15:00:43 -0400 Subject: [PATCH 5/8] minor: copy edit oplogSize reference --- source/reference/configuration-options.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/configuration-options.txt b/source/reference/configuration-options.txt index c8279a779d0..67e78d2b28e 100644 --- a/source/reference/configuration-options.txt +++ b/source/reference/configuration-options.txt @@ -761,8 +761,8 @@ Master/Slave Replication ``true`` to force the :term:`slave` to automatically resync if it is more than 10 seconds behind the master. This setting may be problematic if the :setting:`--oplogSize` of the - :term:`oplog` is too small (controlled by the :option:`--oplogSize - ` option.) If the :term:`oplog` is not large + :term:`oplog` is too small + If the :term:`oplog` is not large enough to store the difference in changes between the master's current state and the state of the slave, this instance will forcibly resync itself unnecessarily. When you set the :setting:`autoresync` From bae336a0cba8bb53437bbc32c90dc684629177f7 Mon Sep 17 00:00:00 2001 From: Ed Costello Date: Tue, 2 Apr 2013 15:01:25 -0400 Subject: [PATCH 6/8] minor copy edit more cleanup --- source/administration/replica-sets.txt | 2 +- source/applications/aggregation.txt | 14 +++++++------- source/applications/read.txt | 2 +- source/core/replication-internals.txt | 7 ++++--- source/faq/replica-sets.txt | 2 +- .../includes/fact-authentication-source-tool.rst | 5 ++++- source/reference/command/buildInfo.txt | 2 ++ source/reference/configuration-options.txt | 4 ++-- source/reference/mongod.txt | 2 +- source/reference/mongoperf.txt | 4 ++-- source/reference/parameters.txt | 2 +- source/reference/server-status.txt | 6 ++++-- source/reference/text-search.txt | 4 ++-- ...ate-text-index-on-multi-language-collection.txt | 4 ++-- 14 files changed, 34 insertions(+), 26 deletions(-) diff --git a/source/administration/replica-sets.txt b/source/administration/replica-sets.txt index be54a0ee42c..74c0cd26ca7 100644 --- a/source/administration/replica-sets.txt +++ b/source/administration/replica-sets.txt @@ -1099,7 +1099,7 @@ operational errors: application systems. - No member is eligible to become primary. Members must have a - :data:`~local.system.replset.settings.members[n].priority` setting greater than ``0``, have a state + :data:`~local.system.replset.members[n].priority` setting greater than ``0``, have a state that is less than ten seconds behind the last operation to the :term:`replica set`, and generally be *more* up to date than the voting members. diff --git a/source/applications/aggregation.txt b/source/applications/aggregation.txt index 9ac868c6fde..eca00589112 100644 --- a/source/applications/aggregation.txt +++ b/source/applications/aggregation.txt @@ -73,8 +73,8 @@ through the pipeline. - :pipeline:`$match` - :pipeline:`$limit` - :pipeline:`$skip` - - :pipeline:`~stage.$unwind` - - :pipeline:`~stage.$group` + - :pipeline:`$unwind` + - :pipeline:`$group` - :pipeline:`$sort` - :pipeline:`$geoNear` @@ -93,7 +93,7 @@ aggregation process. All aggregation expressions can only operate on the current document in the pipeline, and cannot integrate data from other documents. -The :term:`accumulator` expressions used in the :pipeline:`~stage.$group` +The :term:`accumulator` expressions used in the :pipeline:`$group` operator maintain that state (e.g. totals, maximums, minimums, and related data) as documents progress through the :term:`pipeline`. @@ -155,8 +155,8 @@ command: The aggregation pipeline begins with the :term:`collection` ``articles`` and selects the ``author`` and ``tags`` fields using the :pipeline:`$project` aggregation operator. The -:expression:`~stage.$unwind` operator produces one output document per -tag. Finally, the :expression:`~stage.$group` operator pivots these fields. +:pipeline:`$unwind` operator produces one output document per +tag. Finally, the :pipeline:`$group` operator pivots these fields. Result ~~~~~~ @@ -202,7 +202,7 @@ The above operators can also use an index when placed **before** the following aggregation operators: - :pipeline:`$project` -- :pipeline:`~stage.$unwind` +- :pipeline:`$unwind` - :pipeline:`$group`. .. versionadded:: 2.4 @@ -372,7 +372,7 @@ on the results received from the shards. The :pipeline:`$group` operator brings in any "sub-totals" from the shards and combines them: in some cases these may be -structures. For example, the :expression:`~grp.$avg` expression +structures. For example, the :group:`$avg` expression maintains a total and count for each shard; :program:`mongos` combines these values and then divides. diff --git a/source/applications/read.txt b/source/applications/read.txt index c701c8e2100..c489cbc06f8 100644 --- a/source/applications/read.txt +++ b/source/applications/read.txt @@ -389,7 +389,7 @@ first two elements in the ``contribs`` array: - :method:`~op.$elemMatch` query operator for more information on matching array elements. - - :projection:`~prj.$elemMatch` projection operator for additional + - :projection:`$elemMatch` projection operator for additional information on restricting array elements to return. .. _crud-read-cursor: diff --git a/source/core/replication-internals.txt b/source/core/replication-internals.txt index 3c8932da612..52d8bacfddb 100644 --- a/source/core/replication-internals.txt +++ b/source/core/replication-internals.txt @@ -86,7 +86,8 @@ Replica sets can include members with the following four special configurations that affect membership behavior: - :ref:`Secondary-only ` members have - their :data:`priority <~local.system.replset.members[n].priority>` values set to ``0`` and thus + their :data:`priority ` + values set to ``0`` and thus are not eligible for election as primaries. - :ref:`Hidden ` members do not appear in the @@ -163,7 +164,7 @@ Any :program:`mongod` can veto an election. In the default configuration, all members have an equal chance of becoming primary; however, it's possible to set :data:`priority -<~local.system.replset.members[n].priority>` values that weight the election. In some +` values that weight the election. In some architectures, there may be operational reasons for increasing the likelihood of a specific replica set member becoming primary. For instance, a member located in a remote data center should *not* become @@ -222,7 +223,7 @@ aware of the following conditions and possible situations: .. seealso:: :ref:`Non-voting members in a replica set `, :ref:`replica-set-node-priority-configuration`, and - :data:`replica configuration <~local.system.replset.members[n].votes>`. + :data:`replica configuration `. .. [#imply-secondary-only] Remember that :ref:`hidden ` and :ref:`delayed diff --git a/source/faq/replica-sets.txt b/source/faq/replica-sets.txt index 7f967b8065c..9a9d78c6efa 100644 --- a/source/faq/replica-sets.txt +++ b/source/faq/replica-sets.txt @@ -206,7 +206,7 @@ Which members of a replica set vote in elections? ------------------------------------------------- All members of a replica set, unless the value of :data:`votes -<~local.system.replset.members[n].votes>` is equal to ``0``, vote in elections. This includes +` is equal to ``0``, vote in elections. This includes all :ref:`delayed `, :ref:`hidden ` and :ref:`secondary-only ` members, as well as the diff --git a/source/includes/fact-authentication-source-tool.rst b/source/includes/fact-authentication-source-tool.rst index 30d9293642e..9fa2a2c6247 100644 --- a/source/includes/fact-authentication-source-tool.rst +++ b/source/includes/fact-authentication-source-tool.rst @@ -1,3 +1,6 @@ By default, |binary-name| assumes that the database specified to the -:option:`|binary-name| --db` argument holds the user's credentials, unless you +:option:`--db` argument holds the user's credentials, unless you specify :option:`|binary-name| --authenticationDatabase`. + +.. there is no way to get the :option: ref to resolve correctly + as |binary-name| substitution does not appear to work inside roles diff --git a/source/reference/command/buildInfo.txt b/source/reference/command/buildInfo.txt index 6cfe41983ce..7136cc51697 100644 --- a/source/reference/command/buildInfo.txt +++ b/source/reference/command/buildInfo.txt @@ -85,6 +85,8 @@ buildInfo :program:`mongod` instance. See :data:`~buildInfo.version` for a more readable version of this string. + .. TODO:: document buildInfo.version + .. data:: buildInfo.javascriptEngine .. versionchanged:: 2.4 diff --git a/source/reference/configuration-options.txt b/source/reference/configuration-options.txt index 67e78d2b28e..622accab4c3 100644 --- a/source/reference/configuration-options.txt +++ b/source/reference/configuration-options.txt @@ -760,8 +760,8 @@ Master/Slave Replication Used with the :setting:`slave` setting, set :setting:`autoresync` to ``true`` to force the :term:`slave` to automatically resync if it is more than 10 seconds behind the master. This setting may be - problematic if the :setting:`--oplogSize` of the - :term:`oplog` is too small + problematic if the :setting:`oplogSize` of the + :term:`oplog` is too small. If the :term:`oplog` is not large enough to store the difference in changes between the master's current state and the state of the slave, this instance will forcibly diff --git a/source/reference/mongod.txt b/source/reference/mongod.txt index e6faa061b83..c81ba9ada44 100644 --- a/source/reference/mongod.txt +++ b/source/reference/mongod.txt @@ -404,7 +404,7 @@ Options for the :option:`--repair` operation. Defaults to a ``_tmp`` directory within the :setting:`dbpath`. -.. option:mongod: --setParameter +.. option:: --setParameter .. versionadded:: 2.4 diff --git a/source/reference/mongoperf.txt b/source/reference/mongoperf.txt index 2abee6b0b39..c3055d8e112 100644 --- a/source/reference/mongoperf.txt +++ b/source/reference/mongoperf.txt @@ -123,9 +123,9 @@ Configuration Fields tests direct, physical, I/O, without caching. Use a large file size to test heavy random I/O load and to avoid I/O coalescing. - - when :setting:`mongoperf.mmf` is ``true``, :program:`mongoperf` + - when :setting:`~mongoperf.mmf` is ``true``, :program:`mongoperf` runs tests of the caching system, and can use normal file system - cache. Use :program:`mmf` in this mode to test file system cache + cache. Use :setting:`~mongoperf.mmf` in this mode to test file system cache behavior with memory mapped files. .. setting:: mongoperf.r diff --git a/source/reference/parameters.txt b/source/reference/parameters.txt index 190aab52ba2..bbbd58ede5f 100644 --- a/source/reference/parameters.txt +++ b/source/reference/parameters.txt @@ -126,7 +126,7 @@ Parameters .. versionadded:: 2.4 Specify the number of oplog entries to apply as a single batch. - :param:`replApplyBatchSize` must be an integer between 1 and 1024. + :parameter:`replApplyBatchSize` must be an integer between 1 and 1024. Only specify this option on :term:`secondary` members of :term:`replica sets `. diff --git a/source/reference/server-status.txt b/source/reference/server-status.txt index 1ca8d1cdfb3..dbf6709b5c8 100644 --- a/source/reference/server-status.txt +++ b/source/reference/server-status.txt @@ -500,11 +500,13 @@ extra_info .. data:: serverStatus.extra_info.page_faults - The :data:`~serverStatus.extra_info.page_faults` field is only available on Unix/Linux + The :data:`~serverStatus.extra_info.page_faults` + field is only available on Unix/Linux systems, and reports the total number of page faults that require disk operations. Page faults refer to operations that require the database server to access data which isn't available in active - memory. The :data:`~serverStatus.page_fault.extra_info.page_faults` counter may increase dramatically during + memory. The :data:`~serverStatus.extra_info.page_faults` counter may + increase dramatically during moments of poor performance and may correlate with limited memory environments and larger data sets. Limited and sporadic page faults do not necessarily indicate an issue. diff --git a/source/reference/text-search.txt b/source/reference/text-search.txt index 56f2e136298..7228ba72933 100644 --- a/source/reference/text-search.txt +++ b/source/reference/text-search.txt @@ -114,8 +114,8 @@ The returned document contains the following fields: The :data:`~text.stats.nfound` field returns the total number number of documents that match. This number may be greater than the size of the :data:`~text.results` array, i.e. - :data:`~text.stats.n`, if the result set exceeds the :limit:`BSON - Document Size`. + :data:`~text.stats.n`, if the result set exceeds the + :limit:`BSON Document Size`. .. data:: text.stats.timeMicros diff --git a/source/tutorial/create-text-index-on-multi-language-collection.txt b/source/tutorial/create-text-index-on-multi-language-collection.txt index a61f517c43d..853584495f2 100644 --- a/source/tutorial/create-text-index-on-multi-language-collection.txt +++ b/source/tutorial/create-text-index-on-multi-language-collection.txt @@ -11,12 +11,12 @@ If a collection contains documents that are in different languages, include a field in the documents that contain the language to use: - If you include a field named ``language`` in the document, by - default, the :method:`db.collection.ensureIndex()` method will use + default, the :method:`~db.collection.ensureIndex()` method will use the value of this field to override the default language. - To use a field with a name other than ``language``, you must specify the name of this field to the - :method:`db.collection.ensureIndex()` method with the + :method:`~db.collection.ensureIndex()` method with the ``language_override`` option. See :ref:`text-search-languages` for a list of supported languages. From 71f2b8aa30ca135d4fae0e237153aff9290a84da Mon Sep 17 00:00:00 2001 From: Ed Costello Date: Tue, 2 Apr 2013 17:46:48 -0400 Subject: [PATCH 7/8] DOCS-1317 c/operation/operations --- source/applications/read.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/applications/read.txt b/source/applications/read.txt index c489cbc06f8..69b88f176c3 100644 --- a/source/applications/read.txt +++ b/source/applications/read.txt @@ -4,7 +4,7 @@ Read .. default-domain:: mongodb -Of the four basic database operations (i.e. CRUD), read operation are +Of the four basic database operations (i.e. CRUD), read operations are those that retrieve records or :term:`documents ` from a :term:`collection` in MongoDB. For general information about read operations and the factors that affect their performance, see From 96acef2cf31bce1755dc9fb14866c1b919c89e77 Mon Sep 17 00:00:00 2001 From: Ed Costello Date: Tue, 2 Apr 2013 17:57:55 -0400 Subject: [PATCH 8/8] DOCS-1307 correct version of perl driver for writeconcern change \#backport --- source/release-notes/drivers-write-concern.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/drivers-write-concern.txt b/source/release-notes/drivers-write-concern.txt index df22077c8c6..ffb6a56830b 100644 --- a/source/release-notes/drivers-write-concern.txt +++ b/source/release-notes/drivers-write-concern.txt @@ -62,7 +62,7 @@ driver-specific changes. - C#, version 0.7 - Java, version 2.10.0 - Node.js, version 1.2 -- Perl, version 0.601.1 +- Perl, version 0.501.1 - PHP, version 1.4 - Python, version 2.4 - Ruby, version 1.8