From 10a32d88b38172b9a065d65df2b195b5f1a99739 Mon Sep 17 00:00:00 2001 From: Allison Moore Date: Fri, 12 Dec 2014 10:54:35 -0500 Subject: [PATCH 1/2] DOCS-4398: clarifies authenticationDatabase description - --authenticationDatabase is required for mongotop and mongostat when connecting to a mongod or mongos that uses auth --- source/includes/options-mongostat.yaml | 3 +++ source/includes/options-mongotop.yaml | 3 +++ source/includes/options-shared.yaml | 7 +------ 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/source/includes/options-mongostat.yaml b/source/includes/options-mongostat.yaml index d7dabdd733e..1568bd7aefb 100644 --- a/source/includes/options-mongostat.yaml +++ b/source/includes/options-mongostat.yaml @@ -112,6 +112,9 @@ inherit: name: authenticationDatabase program: _shared file: options-shared.yaml +post: | + {{role}} is required for :program:`mongod` + and :program:`mongos` instances that use :ref:`authentication`. --- program: mongostat name: authenticationMechanism diff --git a/source/includes/options-mongotop.yaml b/source/includes/options-mongotop.yaml index 87d17e72a0e..8599eb652e9 100644 --- a/source/includes/options-mongotop.yaml +++ b/source/includes/options-mongotop.yaml @@ -120,6 +120,9 @@ inherit: name: authenticationDatabase program: _shared file: options-shared.yaml +post: | + {{role}} is required for :program:`mongod` + and :program:`mongos` instances that use :ref:`authentication`. --- program: mongotop name: authenticationMechanism diff --git a/source/includes/options-shared.yaml b/source/includes/options-shared.yaml index ed07ee9fd6e..6fad9a46806 100644 --- a/source/includes/options-shared.yaml +++ b/source/includes/options-shared.yaml @@ -247,15 +247,10 @@ program: _shared name: authenticationDatabase args: directive: option -pre: | +description: | .. versionadded:: 2.4 Specifies the database that holds the user's credentials. -description: | - If you do not - specify an authentication database, {{program}} assumes that the - database specified as the argument to {{role}} holds - the user's credentials. optional: true --- program: _shared From 9fde480200c3e5efafaf72609feed96d18554e1e Mon Sep 17 00:00:00 2001 From: Allison Moore Date: Mon, 15 Dec 2014 10:41:28 -0500 Subject: [PATCH 2/2] DOCS-3400: further clarifies default for non-tools DOCS-3400: clarifies default for mongo --- source/includes/options-mongo.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/source/includes/options-mongo.yaml b/source/includes/options-mongo.yaml index 7809f66941f..9a0f916dc13 100644 --- a/source/includes/options-mongo.yaml +++ b/source/includes/options-mongo.yaml @@ -188,6 +188,9 @@ inherit: name: authenticationDatabase program: _shared file: options-shared.yaml +post: | + If you do not specify a value for {{role}}, {{program}} uses the database + specified in the connection string. --- program: mongo name: authenticationMechanism