summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpawel <pawelredzynski@gmail.com>2019-09-30 15:38:08 +0200
committerSebastian Thiel <sebastian.thiel@icloud.com>2019-09-30 16:37:08 +0200
commitcf237db554f8e84eaecf0fad1120cbd75718c695 (patch)
treec7a411861579ad53bce585d49f05df2063f9703c
parent66bb01306e8f0869436a2dee95e6dbba0c470bc4 (diff)
downloadgitpython-cf237db554f8e84eaecf0fad1120cbd75718c695.tar.gz
git: repo: base: update clone_from env argument description
-rw-r--r--git/repo/base.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/git/repo/base.py b/git/repo/base.py
index c19fbe29..4d701153 100644
--- a/git/repo/base.py
+++ b/git/repo/base.py
@@ -1012,6 +1012,11 @@ class Repo(object):
:param to_path: Path to which the repository should be cloned to
:param progress: See 'git.remote.Remote.push'.
:param env: Optional dictionary containing the desired environment variables.
+ Note: Provided variables will be used to update the execution
+ environment for `git`. If some variable is not specified in `env`
+ and is defined in `os.environ`, value from `os.environ` will be used.
+ If you want to unset some variable, consider providing empty string
+ as its value.
:param multi_options: See ``clone`` method
:param kwargs: see the ``clone`` method
:return: Repo instance pointing to the cloned directory"""