summaryrefslogtreecommitdiff
path: root/lib/git/cmd.py
diff options
context:
space:
mode:
authorMichael Trier <mtrier@gmail.com>2010-03-03 23:46:23 -0500
committerMichael Trier <mtrier@gmail.com>2010-03-03 23:46:23 -0500
commite3e2c8c14b861b4d4865a9574e812ef9f2609771 (patch)
treec71c7da3843389ea3b7041a0200d7abe3b0e580d /lib/git/cmd.py
parentacb0fa8b94ef421ad60c8507b634759a472cd56c (diff)
downloadgitpython-e3e2c8c14b861b4d4865a9574e812ef9f2609771.tar.gz
Corrected a bunch of whitespace that makes some folks crazy. Added Sebastian to the AUTHORS file.
Diffstat (limited to 'lib/git/cmd.py')
-rw-r--r--lib/git/cmd.py26
1 files changed, 13 insertions, 13 deletions
diff --git a/lib/git/cmd.py b/lib/git/cmd.py
index aef53350..98314191 100644
--- a/lib/git/cmd.py
+++ b/lib/git/cmd.py
@@ -1,5 +1,5 @@
# cmd.py
-# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
+# Copyright (C) 2008-2010 Michael Trier (mtrier@gmail.com) and contributors
#
# This module is part of GitPython and is released under
# the BSD License: http://www.opensource.org/licenses/bsd-license.php
@@ -23,24 +23,24 @@ if sys.platform == 'win32':
class Git(object):
"""
The Git class manages communication with the Git binary.
-
+
It provides a convenient interface to calling the Git binary, such as in::
-
+
g = Git( git_dir )
g.init() # calls 'git init' program
rval = g.ls_files() # calls 'git ls-files' program
-
+
``Debugging``
- Set the GIT_PYTHON_TRACE environment variable print each invocation
+ Set the GIT_PYTHON_TRACE environment variable print each invocation
of the command to stdout.
Set its value to 'full' to see details about the returned values.
"""
def __init__(self, git_dir=None):
"""
Initialize this instance with:
-
+
``git_dir``
- Git directory we should work in. If None, we always work in the current
+ Git directory we should work in. If None, we always work in the current
directory as returned by os.getcwd()
"""
super(Git, self).__init__()
@@ -48,7 +48,7 @@ class Git(object):
def __getattr__(self, name):
"""
- A convenience method as it allows to call the command as if it was
+ A convenience method as it allows to call the command as if it was
an object.
Returns
Callable object that will execute call _call_process with your arguments.
@@ -99,15 +99,15 @@ class Git(object):
Whether to avoid stripping off trailing whitespace.
Returns::
-
+
str(output) # extended_output = False (Default)
tuple(int(status), str(stdout), str(stderr)) # extended_output = True
-
+
Raise
- GitCommandError
-
+ GitCommandError
+
NOTE
- If you add additional keyword arguments to the signature of this method,
+ If you add additional keyword arguments to the signature of this method,
you must update the execute_kwargs tuple housed in this module.
"""
if GIT_PYTHON_TRACE and not GIT_PYTHON_TRACE == 'full':