summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlicia Cozine <879121+acozine@users.noreply.github.com>2019-05-20 17:11:25 -0500
committerGitHub <noreply@github.com>2019-05-20 17:11:25 -0500
commit80d37638c6a54f816d4ed5287161061b0019fe33 (patch)
tree852b0966ec710f2856e683fcde2a4a48b0c4b12e
parent99fdfbe93f023dcf8f8aaf8133653d45bc3e7070 (diff)
downloadansible-80d37638c6a54f816d4ed5287161061b0019fe33.tar.gz
Update default roles_path documentation (#56320) (#56664)
(cherry picked from commit c1ebc8d9c2558ccdfa2011d7a1c5c4f1ea894f64)
-rw-r--r--docs/docsite/rst/reference_appendices/galaxy.rst9
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/docsite/rst/reference_appendices/galaxy.rst b/docs/docsite/rst/reference_appendices/galaxy.rst
index 52585909d1..ab7a99325d 100644
--- a/docs/docsite/rst/reference_appendices/galaxy.rst
+++ b/docs/docsite/rst/reference_appendices/galaxy.rst
@@ -43,12 +43,11 @@ Use the ``ansible-galaxy`` command to download roles from the `Galaxy website <h
roles_path
==========
-Be aware that by default Ansible downloads roles to the path specified by the environment variable :envvar:`ANSIBLE_ROLES_PATH`. This can be set to a series of
-directories (i.e. */etc/ansible/roles:~/.ansible/roles*), in which case the first writable path will be used. When Ansible is first installed it defaults
-to */etc/ansible/roles*, which requires *root* privileges.
+By default Ansible downloads roles to the first writable directory in the default list of paths ``~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles``. This will install roles in the home directory of the user running ``ansible-galaxy``.
-You can override this by setting the environment variable in your session, defining *roles_path* in an *ansible.cfg* file, or by using the *--roles-path* option.
-The following provides an example of using *--roles-path* to install the role into the current working directory:
+You can override this by setting the environment variable :envvar:`ANSIBLE_ROLES_PATH` in your session, defining ``roles_path`` in an ``ansible.cfg`` file, or by using the ``--roles-path`` option.
+
+The following provides an example of using ``--roles-path`` to install the role into the current working directory:
::