Skip to content
This repository was archived by the owner on Aug 20, 2019. It is now read-only.

Commit 6f94b51

Browse files
schmallisoSam Kleinman
authored andcommitted
DOCS-4398: clarifies authenticationDatabase description
- --authenticationDatabase is required for mongotop and mongostat when connecting to a mongod or mongos that uses auth Signed-off-by: Sam Kleinman <samk@10gen.com>
1 parent a3565d1 commit 6f94b51

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

source/includes/options-mongostat.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,9 @@ inherit:
112112
name: authenticationDatabase
113113
program: _shared
114114
file: options-shared.yaml
115+
post: |
116+
{{role}} is required for :program:`mongod`
117+
and :program:`mongos` instances that use :ref:`authentication`.
115118
---
116119
program: mongostat
117120
name: authenticationMechanism

source/includes/options-mongotop.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,9 @@ inherit:
120120
name: authenticationDatabase
121121
program: _shared
122122
file: options-shared.yaml
123+
post: |
124+
{{role}} is required for :program:`mongod`
125+
and :program:`mongos` instances that use :ref:`authentication`.
123126
---
124127
program: mongotop
125128
name: authenticationMechanism

source/includes/options-shared.yaml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -247,15 +247,10 @@ program: _shared
247247
name: authenticationDatabase
248248
args: <dbname>
249249
directive: option
250-
pre: |
250+
description: |
251251
.. versionadded:: 2.4
252252
253253
Specifies the database that holds the user's credentials.
254-
description: |
255-
If you do not
256-
specify an authentication database, {{program}} assumes that the
257-
database specified as the argument to {{role}} holds
258-
the user's credentials.
259254
optional: true
260255
---
261256
program: _shared

0 commit comments

Comments
 (0)