Skip to content

Commit 6cc1e7e

Browse files
committed
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
1 parent 158bc98 commit 6cc1e7e

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

Diff for: doc/source/tutorial.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -331,11 +331,17 @@ You can easily access configuration information for a remote by accessing option
331331
:start-after: # [26-test_references_and_objects]
332332
:end-before: # ![26-test_references_and_objects]
333333

334-
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.
334+
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*.
335335

336336
ssh_cmd = 'ssh -i id_deployment_key'
337337
with repo.git.custom_environment(GIT_SSH_COMMAND=ssh_cmd):
338338
repo.remotes.origin.fetch()
339+
340+
This one sets a custom script to be executed in place of `ssh`, and can be used in `git` prior to *v2.3*.
341+
342+
ssh_executable = os.path.join(rw_dir, 'my_ssh_executable.sh')
343+
with repo.git.custom_environment(GIT_SSH=ssh_executable):
344+
repo.remotes.origin.fetch()
339345

340346
Submodule Handling
341347
******************

0 commit comments

Comments
 (0)