diff options
author | Sebastian Thiel <byronimo@gmail.com> | 2015-04-08 14:58:33 +0200 |
---|---|---|
committer | Sebastian Thiel <byronimo@gmail.com> | 2015-04-08 14:58:33 +0200 |
commit | 6cc1e7e08094494916db1aadda17e03ce695d049 (patch) | |
tree | 70e85cbaaf282f23d8e1c69fbe5fe6d848c2edfe | |
parent | 158bc981130bfbe214190cac19da228d1f321fe1 (diff) | |
download | gitpython-6cc1e7e08094494916db1aadda17e03ce695d049.tar.gz |
docs(tutorial): add pre-v2.3 GIT_SSH example
It goes along with the new one advertising the GIT_SSH_COMMAND
environment variable.
Related to #256
-rw-r--r-- | doc/source/tutorial.rst | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst index e86fd8d5..84b3b5f5 100644 --- a/doc/source/tutorial.rst +++ b/doc/source/tutorial.rst @@ -331,11 +331,17 @@ You can easily access configuration information for a remote by accessing option :start-after: # [26-test_references_and_objects] :end-before: # ![26-test_references_and_objects] -You can also specify per-call custom environments using a new context manager on the Git command, e.g. for using a specific SSH key. +You can also specify per-call custom environments using a new context manager on the Git command, e.g. for using a specific SSH key. The following example works with `git` starting at *v2.3*. ssh_cmd = 'ssh -i id_deployment_key' with repo.git.custom_environment(GIT_SSH_COMMAND=ssh_cmd): repo.remotes.origin.fetch() + +This one sets a custom script to be executed in place of `ssh`, and can be used in `git` prior to *v2.3*. + + ssh_executable = os.path.join(rw_dir, 'my_ssh_executable.sh') + with repo.git.custom_environment(GIT_SSH=ssh_executable): + repo.remotes.origin.fetch() Submodule Handling ****************** |