summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Trappenberg <jonas@trappenberg.ch>2015-02-09 15:15:15 -0800
committerJonas Trappenberg <jonas@trappenberg.ch>2015-02-09 15:16:16 -0800
commit158bc981130bfbe214190cac19da228d1f321fe1 (patch)
tree88906acf67c9b742d0f73bc8266641cbb0cada5c
parentf51fe3e66d358e997f4af4e91a894a635f7cb601 (diff)
downloadgitpython-158bc981130bfbe214190cac19da228d1f321fe1.tar.gz
Replace GIT_SSH with GIT_SSH_COMMAND for SSH key management.
Also move untestable documentation out of test. Related: #234, #242
-rw-r--r--doc/source/tutorial.rst9
-rw-r--r--git/test/test_docs.py9
2 files changed, 4 insertions, 14 deletions
diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst
index 0d60f0aa..e86fd8d5 100644
--- a/doc/source/tutorial.rst
+++ b/doc/source/tutorial.rst
@@ -331,12 +331,11 @@ 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
+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.
-.. literalinclude:: ../../git/test/test_docs.py
- :language: python
- :start-after: # [32-test_references_and_objects]
- :end-before: # ![32-test_references_and_objects]
+ ssh_cmd = 'ssh -i id_deployment_key'
+ with repo.git.custom_environment(GIT_SSH_COMMAND=ssh_cmd):
+ repo.remotes.origin.fetch()
Submodule Handling
******************
diff --git a/git/test/test_docs.py b/git/test/test_docs.py
index 8dfef1c6..586f0ce4 100644
--- a/git/test/test_docs.py
+++ b/git/test/test_docs.py
@@ -437,15 +437,6 @@ class Tutorials(TestBase):
git.for_each_ref() # '-' becomes '_' when calling it
# ![31-test_references_and_objects]
- # [32-test_references_and_objects]
- ssh_executable = os.path.join(rw_dir, 'my_ssh_executable.sh')
- with repo.git.custom_environment(GIT_SSH=ssh_executable):
- # Note that we don't actually make the call here, as our test-setup doesn't permit it to
- # succeed.
- # It will in your case :)
- repo.remotes.origin.fetch
- # ![32-test_references_and_objects]
-
def test_submodules(self):
# [1-test_submodules]
repo = self.rorepo