Skip to content

minor: typo & link repair run #805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/administration/master-slave.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <mongod --oplog>` option when starting
:option:`--oplogSize <mongod --oplogSize>` option when starting
:program:`mongod`. If you do not specify
:option:`--oplogSize <mongod --oplogSize>`, :program:`mongod` will
allocate 5% of available disk space on start up to the oplog, with a
Expand Down
2 changes: 1 addition & 1 deletion source/administration/monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/administration/replica-set-architectures.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
5 changes: 3 additions & 2 deletions source/administration/replica-sets.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <members[n].slaveDelay>` value
of ``0`` and cannot become :term:`primary`. The
:data:`slaveDelay <local.system.replset.members[n].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
Expand Down Expand Up @@ -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.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.
Expand Down
6 changes: 3 additions & 3 deletions source/applications/aggregation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:pipeline:`$unwind` operator produces one output document per
tag. Finally, the :pipeline:`$group` operator pivots these fields.

Result
~~~~~~
Expand Down Expand Up @@ -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 :group:`$avg` expression
maintains a total and count for each shard; :program:`mongos` combines
these values and then divides.

Expand Down
2 changes: 1 addition & 1 deletion source/applications/indexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions source/applications/read.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <document>` from a
:term:`collection` in MongoDB. For general information about read
operations and the factors that affect their performance, see
Expand Down Expand Up @@ -386,7 +386,7 @@ 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
Expand Down
2 changes: 1 addition & 1 deletion source/applications/text-search.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 5 additions & 4 deletions source/core/replication-internals.txt
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ Replica sets can include members with the following four special
configurations that affect membership behavior:

- :ref:`Secondary-only <replica-set-secondary-only-members>` members have
their :data:`priority <members[n].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 <replica-set-hidden-members>` members do not appear in the
Expand Down Expand Up @@ -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
<members[n].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
Expand Down Expand Up @@ -222,7 +223,7 @@ aware of the following conditions and possible situations:
.. seealso:: :ref:`Non-voting members in a replica
set <replica-set-non-voting-members>`,
:ref:`replica-set-node-priority-configuration`, and
:data:`replica configuration <members[n].votes>`.
:data:`replica configuration <local.system.replset.members[n].votes>`.

.. [#imply-secondary-only] Remember that :ref:`hidden
<replica-set-hidden-members>` and :ref:`delayed
Expand Down Expand Up @@ -284,7 +285,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
Expand Down
2 changes: 1 addition & 1 deletion source/faq/concurrency.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ following methods:
- :doc:`mongostat </reference/mongostat>`, and/or
- the `MongoDB Monitoring Service (MMS) <http://mms.10gen.com/>`_

Specifically, the :data:`~server.Status.locks` document in the :doc:`output of
Specifically, the :data:`~serverStatus.locks` document in the :doc:`output of
serverStatus </reference/server-status>`, or the :data:`~currentOp.locks` field
in the :doc:`current operation reporting </reference/current-op>`
provides insight into the type of locks and amount of lock
Expand Down
7 changes: 4 additions & 3 deletions source/faq/replica-sets.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
<members[n].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 <replica-set-delayed-members>`, :ref:`hidden
<replica-set-hidden-members>` and :ref:`secondary-only
<replica-set-secondary-only-members>` members, as well as the
Expand All @@ -219,8 +219,9 @@ Do hidden members vote in replica set elections?

:ref:`Hidden members <replica-set-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
:<members[n].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`

Expand Down
3 changes: 2 additions & 1 deletion source/includes/example-server-status-projection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </reference/server-status>`
document that are not included by default. You
can exclude any field that |operation-name| includes by
default.
5 changes: 4 additions & 1 deletion source/includes/fact-authentication-source-tool.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
By default, |binary-name| assumes that the database specified to the
:option:`--db` argument holds the user's credentials, unless you
specify :option:`--authenticationDatabase`.
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
2 changes: 1 addition & 1 deletion source/includes/manpage-options-auth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/includes/note-rs-conf-array-index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions source/reference/aggregation/min.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion source/reference/aggregation/unwind.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions source/reference/command/buildInfo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/reference/command/hostInfo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/reference/command/isMaster.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion source/reference/command/journalLatencyTest.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions source/reference/command/text.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions source/reference/configuration-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -760,9 +760,9 @@ 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 <mongod --oplogSize>`
:term:`oplog` is too small (controlled by the :option:`--oplogSize
<mongod --oplogSize>` option.) If the :term:`oplog` is not large
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
resync itself unnecessarily. When you set the :setting:`autoresync`
Expand Down
2 changes: 1 addition & 1 deletion source/reference/database-profiler.txt
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ operation.
:method:`limit(5) <cursor.limit()>` 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() <db.collection.find()>` command with no limit
specified.
Expand Down
2 changes: 1 addition & 1 deletion source/reference/local-database.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion source/reference/method/db.addUser.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:`~<database>.system.users.otherDBRoles` and
the :data:`~admin.system.users.otherDBRoles` and
:data:`~<database>.system.users.userSource` fields to documents in the
:data:`system.users <<database>.system.users>` collection.
12 changes: 6 additions & 6 deletions source/reference/method/db.collection.ensureIndex.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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() <db.collection.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() <db.collection.ensureIndex()>` method
command with the same index fields and different options without
first dropping the index, :method:`ensureIndex()
<db.collection.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() <db.collection.ensureIndex()>`
Expand Down
4 changes: 2 additions & 2 deletions source/reference/method/db.collection.findAndModify.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions source/reference/method/load.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ load()

.. default-domain:: mongodb

.. method:: load("file")
.. method:: load( <file> )

: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,
Expand Down
14 changes: 2 additions & 12 deletions source/reference/mongod.txt
Original file line number Diff line number Diff line change
Expand Up @@ -600,25 +600,15 @@ 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
unnecessarily. When you set the :setting:`autoresync` option to
``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
````````````````````````

Expand Down
Loading