diff options
| author | Vincent Driessen <me@nvie.com> | 2016-07-18 09:20:10 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-07-18 09:20:10 +0200 |
| commit | a5e6676db845e10bdca47c3fcf8dca9dea75ec42 (patch) | |
| tree | b3688965506bfd1be5fb4ab85e0c9d63788009b6 /doc | |
| parent | 2ff3a3e72b1ff79e75777ccdddc86f8540ce833d (diff) | |
| download | gitpython-a5e6676db845e10bdca47c3fcf8dca9dea75ec42.tar.gz | |
Update tutorial
This mentions the instructions of what was discussed in #489.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/tutorial.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst index b0ef273d..92020975 100644 --- a/doc/source/tutorial.rst +++ b/doc/source/tutorial.rst @@ -474,8 +474,13 @@ Using environment variables, you can further adjust the behaviour of the git com * **GIT_PYTHON_TRACE** - * If set to non-0, all executed git commands will be logged using a python logger. - * if set to *full*, the executed git command and its output on stdout and stderr will be logged using a python logger. + * If set to non-0, all executed git commands will be shown as they happen + * If set to *full*, the executed git command _and_ its entire output on stdout and stderr will be shown as they happen + + **NOTE**: All logging is outputted using a Python logger, so make sure your program is configured to show INFO-level messages. If this is not the case, try adding the following to your program:: + + import logging + logging.basicConfig(level=logging.INFO) * **GIT_PYTHON_GIT_EXECUTABLE** |