From 68b9c2ffa7d998b3e87affa5e8699d79101a11db Mon Sep 17 00:00:00 2001 From: james-prior Date: Tue, 24 May 2016 23:50:33 -0400 Subject: [PATCH] Make explicit that virtualenv is created if needed for pip module. (#3731) packaging/language/pip.py: virtualenv option: Mention that virtualenv is created if it does not exist. (Explicit is better than implicit.) Mention other relevant options. notes: initialized -> created Wrap long lines. --- lib/ansible/modules/packaging/language/pip.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/lib/ansible/modules/packaging/language/pip.py b/lib/ansible/modules/packaging/language/pip.py index 45ca288fb37..e58252a37f9 100755 --- a/lib/ansible/modules/packaging/language/pip.py +++ b/lib/ansible/modules/packaging/language/pip.py @@ -52,7 +52,11 @@ options: virtualenv: description: - An optional path to a I(virtualenv) directory to install into. - It cannot be specified together with the 'executable' parameter (added in 2.1). + It cannot be specified together with the 'executable' parameter + (added in 2.1). + If the virtualenv does not exist, it will be created before installing + packages. The optional virtualenv_site_packages, virtualenv_command, + and virtualenv_python options affect the creation of the virtualenv. required: false default: null virtualenv_site_packages: @@ -129,7 +133,9 @@ options: default: null notes: - - Please note that virtualenv (U(http://www.virtualenv.org/)) must be installed on the remote host if the virtualenv parameter is specified and the virtualenv needs to be initialized. + - Please note that virtualenv (U(http://www.virtualenv.org/)) must be + installed on the remote host if the virtualenv parameter is specified and + the virtualenv needs to be created. requirements: [ "virtualenv", "pip" ] author: "Matt Wright (@mattupstate)" '''