summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2015-06-10 13:46:11 +0200
committerSebastian Thiel <byronimo@gmail.com>2015-06-10 13:46:11 +0200
commitbafb4cc0a95428cbedaaa225abdceecee7533fac (patch)
tree3c1c102c2cf7e701ed5cfe3b070b4193d69b9f0e
parent1143e1c66b8b054a2fefca2a23b1f499522ddb76 (diff)
downloadgitpython-bafb4cc0a95428cbedaaa225abdceecee7533fac.tar.gz
docs(tutorial): fix typo, minor improvements
-rw-r--r--doc/source/tutorial.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst
index 5110a252..7cc296d8 100644
--- a/doc/source/tutorial.rst
+++ b/doc/source/tutorial.rst
@@ -343,13 +343,13 @@ This one sets a custom script to be executed in place of `ssh`, and can be used
with repo.git.custom_environment(GIT_SSH=ssh_executable):
repo.remotes.origin.fetch()
-Here's an executable used as GIT_SSH::
+Here's an example executable that can be used in place of the `ssh_executable` above::
#!/bin/sh
ID_RSA=/var/lib/openshift/5562b947ecdd5ce939000038/app-deployments/id_rsa
exec /usr/bin/ssh -o StrictHostKeyChecking=no -i $ID_RSA "$@"
-Please note script must have executable permissions. StrictHostKeyChecking=no is used to avoid prompts asking to save hots key to ~/.ssh/known_hosts (this is in case you run this in some service)
+Please note that the script must be executable (i.e. `chomd +x script.sh`). `StrictHostKeyChecking=no` is used to avoid prompts asking to save the hosts key to `~/.ssh/known_hosts`, which happens in case you run this as daemon.
You might also have a look at `Git.update_environment(...)` in case you want to setup a changed environment more permanently.