DOCS-2655: fixing options in help order

Author: Sam Kleinman

source/includes/options-bsondump.yaml

@@ -14,7 +14,7 @@ name: filter
 directive: option
 args: '<JSON>'
 description: |
-  Limits the documents that :program:`bsondump` exports to only those
+  Limits the documents that {{program}} exports to only those
   documents that match the :term:`JSON document` specified as
   ``'<JSON>'``. Be sure to include the document in single quotes to avoid
   interaction with your system's shell environment.
@@ -33,7 +33,7 @@ directive: option
 args: null
 description: |
   Validates each :term:`BSON` object before outputting it in :term:`JSON`
-  format. By default, :program:`bsondump` enables :option:`--objcheck`.
+  format. By default, {{program}} enables :option:`--objcheck`.
   For objects with a high degree of sub-document nesting,
   :option:`--objcheck` can have a small impact on performance. You can set
   :option:`--noobjcheck` to disable object checking.
@@ -49,7 +49,7 @@ name: type
 directive: option
 args: <=json|=debug>
 description: |
-  Changes the operation of :program:`bsondump` from outputting
+  Changes the operation of {{program}} from outputting
   ":term:`JSON`" (the default) to a debugging format.
 optional: true
 ---
@@ -66,4 +66,12 @@ inherit:
   name: version
   program: _shared
   file: options-shared.yaml
+---
+program: bsondump
+name: <bsonFilename>
+description: |
+  The final argument to {{program}} is a document containing
+  :term:`BSON`. This data is typically generated by
+  {{program}} or by MongoDB in a :term:`rollback` operation.
+
 ...

source/includes/options-mongosniff.yaml

@@ -8,7 +8,7 @@ directive: option
 args: <host><:port>
 description: |
   Declares a host to forward all parsed requests that the
-  :program:`mongosniff` intercepts to another :program:`mongod` instance
+  {{program}} intercepts to another :program:`mongod` instance
   and issue those operations on that database instance.
 
   Specify the target host name and port in the ``<host><:port>`` format.
@@ -35,7 +35,7 @@ args: null
 description: |
   Displays invalid BSON objects only and nothing else. Use this option for
   troubleshooting driver development. This option has some performance
-  impact on the performance of :program:`mongosniff`.
+  impact on the performance of {{program}}.
 optional: true
 ---
 program: mongosniff
@@ -52,4 +52,14 @@ description: |
   output files produced by the :option:`--diaglog <mongod --diaglog>`
   option.
 optional: true
+---
+program: mongosniff
+name: <port>
+directive: option
+description: |
+  Specifies alternate ports to sniff for traffic. By default,
+  {{program}} watches for MongoDB traffic on port ``27017``. Append
+  multiple port numbers to the end of {{program}} to monitor
+  traffic on multiple ports.
+optional: true
 ...

source/includes/options-mongotop.yaml

@@ -130,4 +130,11 @@ inherit:
   name: version
   program: _shared
   file: options-shared.yaml
+---
+program: mongotop
+name: <sleeptime>
+description: |
+  The final argument is the length of time, in seconds, that
+  {{program}} waits in between calls. By default {{program}} returns
+  data every second.
 ...

source/reference/program/bsondump.txt

@@ -23,25 +23,23 @@ Options
 
 .. program:: bsondump
 
-.. include:: /includes/option/option-bsondump-filter.rst
-
 .. include:: /includes/option/option-bsondump-help.rst
 
-.. include:: /includes/option/option-bsondump-noobjcheck.rst
+.. include:: /includes/option/option-bsondump-verbose.rst
 
-.. include:: /includes/option/option-bsondump-objcheck.rst
+.. include:: /includes/option/option-bsondump-quiet.rst
 
-.. include:: /includes/option/option-bsondump-type.rst
+.. include:: /includes/option/option-bsondump-version.rst
 
-.. include:: /includes/option/option-bsondump-verbose.rst
+.. include:: /includes/option/option-bsondump-objcheck.rst
 
-.. include:: /includes/option/option-bsondump-version.rst
+.. include:: /includes/option/option-bsondump-noobjcheck.rst
 
-.. option:: <bsonfilename>
+.. include:: /includes/option/option-bsondump-filter.rst
+
+.. include:: /includes/option/option-bsondump-type.rst
 
-   The final argument to :program:`bsondump` is a document containing
-   :term:`BSON`. This data is typically generated by
-   :program:`mongodump` or by MongoDB in a :term:`rollback` operation.
+.. include:: /includes/option/option-bsondump-<bsonFilename>.rst
 
 Use
 ---

source/reference/program/mongodump.txt

@@ -63,59 +63,63 @@ Options
 
 .. program:: mongodump
 
-.. include:: /includes/option/option-mongodump-authenticationDatabase.rst
+.. include:: /includes/option/option-mongodump-help.rst
 
-.. include:: /includes/option/option-mongodump-authenticationMechanism.rst
+.. include:: /includes/option/option-mongodump-verbose.rst
 
-.. include:: /includes/option/option-mongodump-collection.rst
+.. include:: /includes/option/option-mongodump-quiet.rst
 
-.. include:: /includes/option/option-mongodump-db.rst
+.. include:: /includes/option/option-mongodump-version.rst
 
-.. include:: /includes/option/option-mongodump-dbpath.rst
+.. include:: /includes/option/option-mongodump-host.rst
 
-.. include:: /includes/option/option-mongodump-directoryperdb.rst
+.. include:: /includes/option/option-mongodump-port.rst
 
-.. include:: /includes/option/option-mongodump-forceTableScan.rst
+.. include:: /includes/option/option-mongodump-ipv6.rst
 
-.. include:: /includes/option/option-mongodump-help.rst
+.. include:: /includes/option/option-mongodump-ssl.rst
 
-.. include:: /includes/option/option-mongodump-host.rst
+.. include:: /includes/option/option-mongodump-sslCAFile.rst
 
-.. include:: /includes/option/option-mongodump-ipv6.rst
+.. include:: /includes/option/option-mongodump-sslPEMKeyFile.rst
 
-.. include:: /includes/option/option-mongodump-journal.rst
+.. include:: /includes/option/option-mongodump-sslPEMKeyPassword.rst
 
-.. include:: /includes/option/option-mongodump-oplog.rst
+.. include:: /includes/option/option-mongodump-sslCRLFile.rst
 
-.. include:: /includes/option/option-mongodump-out.rst
+.. include:: /includes/option/option-mongodump-sslAllowInvalidCertificates.rst
+
+.. include:: /includes/option/option-mongodump-sslFIPSMode.rst
+
+.. include:: /includes/option/option-mongodump-username.rst
 
 .. include:: /includes/option/option-mongodump-password.rst
 
-.. include:: /includes/option/option-mongodump-port.rst
+.. include:: /includes/option/option-mongodump-authenticationDatabase.rst
 
-.. include:: /includes/option/option-mongodump-query.rst
+.. include:: /includes/option/option-mongodump-authenticationMechanism.rst
 
-.. include:: /includes/option/option-mongodump-repair.rst
+.. include:: /includes/option/option-mongodump-dbpath.rst
 
-.. include:: /includes/option/option-mongodump-ssl.rst
+.. include:: /includes/option/option-mongodump-directoryperdb.rst
 
-.. include:: /includes/option/option-mongodump-sslAllowInvalidCertificates.rst
+.. include:: /includes/option/option-mongodump-journal.rst
 
-.. include:: /includes/option/option-mongodump-sslCAFile.rst
+.. include:: /includes/option/option-mongodump-db.rst
 
-.. include:: /includes/option/option-mongodump-sslCRLFile.rst
+.. include:: /includes/option/option-mongodump-collection.rst
 
-.. include:: /includes/option/option-mongodump-sslFIPSMode.rst
+.. include:: /includes/option/option-mongodump-out.rst
 
-.. include:: /includes/option/option-mongodump-sslPEMKeyFile.rst
+.. include:: /includes/option/option-mongodump-query.rst
 
-.. include:: /includes/option/option-mongodump-sslPEMKeyPassword.rst
+.. include:: /includes/option/option-mongodump-oplog.rst
 
-.. include:: /includes/option/option-mongodump-username.rst
+.. include:: /includes/option/option-mongodump-repair.rst
 
-.. include:: /includes/option/option-mongodump-verbose.rst
+.. include:: /includes/option/option-mongodump-forceTableScan.rst
 
-.. include:: /includes/option/option-mongodump-version.rst
+.. include:: /includes/option/option-mongodump-dumpDbUsersAndRoles.rst
 
 Use
 ---

source/reference/program/mongoexport.txt

@@ -32,71 +32,73 @@ Options
 
 .. program:: mongoexport
 
-.. include:: /includes/option/option-mongoexport-authenticationDatabase.rst
+.. include:: /includes/option/option-mongoexport-help.rst
 
-.. include:: /includes/option/option-mongoexport-authenticationMechanism.rst
+.. include:: /includes/option/option-mongoexport-verbose.rst
 
-.. include:: /includes/option/option-mongoexport-collection.rst
+.. include:: /includes/option/option-mongoexport-quiet.rst
 
-.. include:: /includes/option/option-mongoexport-csv.rst
+.. include:: /includes/option/option-mongoexport-version.rst
 
-.. include:: /includes/option/option-mongoexport-db.rst
+.. include:: /includes/option/option-mongoexport-host.rst
 
-.. include:: /includes/option/option-mongoexport-dbpath.rst
+.. include:: /includes/option/option-mongoexport-port.rst
 
-.. include:: /includes/option/option-mongoexport-directoryperdb.rst
+.. include:: /includes/option/option-mongoexport-ipv6.rst
 
-.. include:: /includes/option/option-mongoexport-fieldFile.rst
+.. include:: /includes/option/option-mongoexport-ssl.rst
 
-.. include:: /includes/option/option-mongoexport-fields.rst
+.. include:: /includes/option/option-mongoexport-sslCAFile.rst
 
-.. include:: /includes/option/option-mongoexport-forceTableScan.rst
+.. include:: /includes/option/option-mongoexport-sslPEMKeyFile.rst
 
-.. include:: /includes/option/option-mongoexport-help.rst
+.. include:: /includes/option/option-mongoexport-sslPEMKeyPassword.rst
 
-.. include:: /includes/option/option-mongoexport-host.rst
+.. include:: /includes/option/option-mongoexport-sslCRLFile.rst
 
-.. include:: /includes/option/option-mongoexport-ipv6.rst
+.. include:: /includes/option/option-mongoexport-sslAllowInvalidCertificates.rst
 
-.. include:: /includes/option/option-mongoexport-journal.rst
+.. include:: /includes/option/option-mongoexport-sslFIPSMode.rst
 
-.. include:: /includes/option/option-mongoexport-jsonArray.rst
+.. include:: /includes/option/option-mongoexport-username.rst
 
-.. include:: /includes/option/option-mongoexport-limit.rst
+.. include:: /includes/option/option-mongoexport-password.rst
 
-.. include:: /includes/option/option-mongoexport-out.rst
+.. include:: /includes/option/option-mongoexport-authenticationDatabase.rst
 
-.. include:: /includes/option/option-mongoexport-password.rst
+.. include:: /includes/option/option-mongoexport-authenticationMechanism.rst
 
-.. include:: /includes/option/option-mongoexport-port.rst
+.. include:: /includes/option/option-mongoexport-dbpath.rst
 
-.. include:: /includes/option/option-mongoexport-query.rst
+.. include:: /includes/option/option-mongoexport-directoryperdb.rst
 
-.. include:: /includes/option/option-mongoexport-skip.rst
+.. include:: /includes/option/option-mongoexport-journal.rst
 
-.. include:: /includes/option/option-mongoexport-slaveOk.rst
+.. include:: /includes/option/option-mongoexport-db.rst
 
-.. include:: /includes/option/option-mongoexport-sort.rst
+.. include:: /includes/option/option-mongoexport-collection.rst
 
-.. include:: /includes/option/option-mongoexport-ssl.rst
+.. include:: /includes/option/option-mongoexport-fields.rst
 
-.. include:: /includes/option/option-mongoexport-sslAllowInvalidCertificates.rst
+.. include:: /includes/option/option-mongoexport-fieldFile.rst
 
-.. include:: /includes/option/option-mongoexport-sslCAFile.rst
+.. include:: /includes/option/option-mongoexport-query.rst
 
-.. include:: /includes/option/option-mongoexport-sslCRLFile.rst
+.. include:: /includes/option/option-mongoexport-csv.rst
 
-.. include:: /includes/option/option-mongoexport-sslFIPSMode.rst
+.. include:: /includes/option/option-mongoexport-out.rst
 
-.. include:: /includes/option/option-mongoexport-sslPEMKeyFile.rst
+.. include:: /includes/option/option-mongoexport-jsonArray.rst
 
-.. include:: /includes/option/option-mongoexport-sslPEMKeyPassword.rst
+.. include:: /includes/option/option-mongoexport-slaveOk.rst
 
-.. include:: /includes/option/option-mongoexport-username.rst
+.. include:: /includes/option/option-mongoexport-forceTableScan.rst
 
-.. include:: /includes/option/option-mongoexport-verbose.rst
+.. include:: /includes/option/option-mongoexport-skip.rst
 
-.. include:: /includes/option/option-mongoexport-version.rst
+.. include:: /includes/option/option-mongoexport-limit.rst
+
+.. include:: /includes/option/option-mongoexport-sort.rst
 
 Use
 ---

source/reference/program/mongofiles.txt

@@ -51,55 +51,57 @@ Options
 
 .. program:: mongofiles
 
-.. include:: /includes/option/option-mongofiles-authenticationDatabase.rst
+.. include:: /includes/option/option-mongofiles-help.rst
 
-.. include:: /includes/option/option-mongofiles-authenticationMechanism.rst
+.. include:: /includes/option/option-mongofiles-verbose.rst
 
-.. include:: /includes/option/option-mongofiles-collection.rst
+.. include:: /includes/option/option-mongofiles-quiet.rst
 
-.. include:: /includes/option/option-mongofiles-db.rst
+.. include:: /includes/option/option-mongofiles-version.rst
 
-.. include:: /includes/option/option-mongofiles-dbpath.rst
+.. include:: /includes/option/option-mongofiles-host.rst
 
-.. include:: /includes/option/option-mongofiles-directoryperdb.rst
+.. include:: /includes/option/option-mongofiles-port.rst
 
-.. include:: /includes/option/option-mongofiles-help.rst
+.. include:: /includes/option/option-mongofiles-ipv6.rst
 
-.. include:: /includes/option/option-mongofiles-host.rst
+.. include:: /includes/option/option-mongofiles-ssl.rst
 
-.. include:: /includes/option/option-mongofiles-ipv6.rst
+.. include:: /includes/option/option-mongofiles-sslCAFile.rst
 
-.. include:: /includes/option/option-mongofiles-journal.rst
+.. include:: /includes/option/option-mongofiles-sslPEMKeyFile.rst
 
-.. include:: /includes/option/option-mongofiles-local.rst
+.. include:: /includes/option/option-mongofiles-sslPEMKeyPassword.rst
 
-.. include:: /includes/option/option-mongofiles-password.rst
+.. include:: /includes/option/option-mongofiles-sslCRLFile.rst
 
-.. include:: /includes/option/option-mongofiles-port.rst
+.. include:: /includes/option/option-mongofiles-sslAllowInvalidCertificates.rst
 
-.. include:: /includes/option/option-mongofiles-replace.rst
+.. include:: /includes/option/option-mongofiles-sslFIPSMode.rst
 
-.. include:: /includes/option/option-mongofiles-ssl.rst
+.. include:: /includes/option/option-mongofiles-username.rst
 
-.. include:: /includes/option/option-mongofiles-sslAllowInvalidCertificates.rst
+.. include:: /includes/option/option-mongofiles-password.rst
 
-.. include:: /includes/option/option-mongofiles-sslCAFile.rst
+.. include:: /includes/option/option-mongofiles-authenticationDatabase.rst
 
-.. include:: /includes/option/option-mongofiles-sslCRLFile.rst
+.. include:: /includes/option/option-mongofiles-authenticationMechanism.rst
 
-.. include:: /includes/option/option-mongofiles-sslFIPSMode.rst
+.. include:: /includes/option/option-mongofiles-dbpath.rst
 
-.. include:: /includes/option/option-mongofiles-sslPEMKeyFile.rst
+.. include:: /includes/option/option-mongofiles-directoryperdb.rst
 
-.. include:: /includes/option/option-mongofiles-sslPEMKeyPassword.rst
+.. include:: /includes/option/option-mongofiles-journal.rst
 
-.. include:: /includes/option/option-mongofiles-type.rst
+.. include:: /includes/option/option-mongofiles-db.rst
 
-.. include:: /includes/option/option-mongofiles-username.rst
+.. include:: /includes/option/option-mongofiles-collection.rst
 
-.. include:: /includes/option/option-mongofiles-verbose.rst
+.. include:: /includes/option/option-mongofiles-local.rst
 
-.. include:: /includes/option/option-mongofiles-version.rst
+.. include:: /includes/option/option-mongofiles-type.rst
+
+.. include:: /includes/option/option-mongofiles-replace.rst
 
 .. _mongofiles-commands: