From: Alfredo Deza <adeza@redhat.com>
Date: Wed, 27 May 2015 13:23:25 +0000 (-0400)
Subject: [BZ-1219310] add a doc section explaining sub-command overrides
X-Git-Tag: v1.5.26~21^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=4179369fa06ee47c569d19f679a6e5c278dd08dd;p=ceph-deploy.git

[BZ-1219310] add a doc section explaining sub-command overrides

Signed-off-by: Alfredo Deza <adeza@redhat.com>
---

diff --git a/docs/source/conf.rst b/docs/source/conf.rst
index cd45d97..28b88c8 100644
--- a/docs/source/conf.rst
+++ b/docs/source/conf.rst
@@ -80,6 +80,25 @@ a repository.
 Repositories can be very complex to describe and most of the time (specially
 for yum repositories) they can be very verbose too.
 
+Setting Default Flags or Values
+-------------------------------
+Because the configuration loading allows specifying the same flags as in the
+CLI it is possible to set defaults. For example, assuming that a user always
+wants to install Ceph the following way (that doesn't create/modify remote repo
+files)::
+
+    ceph-deploy install --no-adjust-repos {nodes}
+
+This can be the default behavior by setting it in the right section in the
+configuration file, which should look like this::
+
+    [ceph-deploy-install]
+    adjust_repos = False
+
+The default for ``adjust_repos`` is ``True``, but because we are changing this
+to ``False`` the CLI will now have this behavior changed without the need to
+pass any flag.
+
 Repository Sections
 -------------------
 Keys will depend on the type of package manager that will use it. Certain keys