cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Make explicit that virtualenv is created if needed for pip module. (#3731)

Browse source 
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.
This commit is contained in:
james-prior 2016-05-24 23:50:33 -04:00 committed by Matt Clay
parent 9167abdd10
commit 68b9c2ffa7
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
lib/ansible/modules/packaging/language/pip.py
View file

@ -52,7 +52,11 @@ options:
virtualenv: virtualenv:
description: description:
- An optional path to a I(virtualenv) directory to install into. - 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 required: false
default: null default: null
virtualenv_site_packages: virtualenv_site_packages:
@ -129,7 +133,9 @@ options:
default: null default: null
notes: 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" ] requirements: [ "virtualenv", "pip" ]
author: "Matt Wright (@mattupstate)" author: "Matt Wright (@mattupstate)"
''' '''