diff options
| -rw-r--r-- | doc/reference.rst | 84 | ||||
| -rw-r--r-- | lib/git/index.py | 9 | ||||
| -rw-r--r-- | lib/git/refs.py | 5 | ||||
| -rw-r--r-- | lib/git/remote.py | 21 |
4 files changed, 75 insertions, 44 deletions
diff --git a/doc/reference.rst b/doc/reference.rst index 078cbdf6..9cc32b71 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -10,27 +10,63 @@ Actor :members: :undoc-members: -Blob ----- +Objects.Base +------------ + +.. automodule:: git.objects.base + :members: + :undoc-members: + +Objects.Blob +------------ -.. automodule:: git.blob +.. automodule:: git.objects.blob :members: :undoc-members: + +Objects.Commit +-------------- -Git ---- +.. automodule:: git.objects.commit + :members: + :undoc-members: + +Objects.Tag +----------- -.. automodule:: git.cmd +.. automodule:: git.objects.tag :members: :undoc-members: -Commit +Objects.Tree +------------ + +.. automodule:: git.objects.tree + :members: + :undoc-members: + +Objects.Utils +------------- + +.. automodule:: git.objects.utils + :members: + :undoc-members: + +GitCmd ------ -.. automodule:: git.commit +.. automodule:: git.cmd :members: :undoc-members: + +Config +------ + +.. automodule:: git.config + :members: + :undoc-members: + Diff ---- @@ -45,17 +81,25 @@ Errors :members: :undoc-members: -Head +Index +------ + +.. automodule:: git.index + :members: + :undoc-members: + + +Refs ---- -.. automodule:: git.head +.. automodule:: git.refs :members: :undoc-members: -Lazy ----- +Remote +------ -.. automodule:: git.lazy +.. automodule:: git.remote :members: :undoc-members: @@ -73,20 +117,6 @@ Stats :members: :undoc-members: -Tag ---- - -.. automodule:: git.tag - :members: - :undoc-members: - -Tree ----- - -.. automodule:: git.tree - :members: - :undoc-members: - Utils ----- diff --git a/lib/git/index.py b/lib/git/index.py index 705b1ae7..e368f531 100644 --- a/lib/git/index.py +++ b/lib/git/index.py @@ -44,11 +44,12 @@ class _TemporaryFileSwap(object): class BaseIndexEntry(tuple): """ - Small Brother of an index entry which can be created to describe changes + + Small Brother of an index entry which can be created to describe changes done to the index in which case plenty of additional information is not requried. - As the first 4 data members match exactly to the IndexEntry type, methods - expecting a BaseIndexEntry can also handle full IndexEntries even if they + As the first 4 data members match exactly to the IndexEntry type, methods + expecting a BaseIndexEntry can also handle full IndexEntries even if they use numeric indices for performance reasons. """ @@ -396,7 +397,7 @@ class IndexFile(LazyMixin, diff.Diffable): If 2 Trees are given, they will be merged into a new index using a two way merge algorithm. Tree 1 is the 'current' tree, tree 2 is the 'other' one. It behaves like a fast-forward. - If 3 Trees are given, a 3-way merge will be performed with the first tree + If 3 Trees are given, a 3-way merge will be performed with the first tree being the common ancestor of tree 2 and tree 3. Tree 2 is the 'current' tree, tree 3 is the 'other' one diff --git a/lib/git/refs.py b/lib/git/refs.py index 352c14f4..1900c6ce 100644 --- a/lib/git/refs.py +++ b/lib/git/refs.py @@ -3,9 +3,8 @@ # # This module is part of GitPython and is released under # the BSD License: http://www.opensource.org/licenses/bsd-license.php -""" -Module containing all ref based objects -""" +""" Module containing all ref based objects """ + import os from objects import Object, Commit from objects.utils import get_object_type_by_name diff --git a/lib/git/remote.py b/lib/git/remote.py index b4413cce..9141fc3b 100644 --- a/lib/git/remote.py +++ b/lib/git/remote.py @@ -3,9 +3,7 @@ # # This module is part of GitPython and is released under # the BSD License: http://www.opensource.org/licenses/bsd-license.php -""" -Module implementing a remote object allowing easy access to git remotes -""" +"""Module implementing a remote object allowing easy access to git remotes""" from errors import GitCommandError from git.utils import LazyMixin, Iterable, IterableList @@ -137,6 +135,7 @@ class PushProgress(object): ``message`` In case of the 'WRITING' operation, it contains the amount of bytes transferred. It may possibly be used for other purposes as well. + You may read the contents of the current line in self._cur_line """ pass @@ -145,15 +144,17 @@ class PushProgress(object): class PushInfo(object): """ Carries information about the result of a push operation of a single head:: - info = remote.push()[0] - info.flags # bitflags providing more information about the result - info.local_ref # Reference pointing to the local reference that was pushed - # It is None if the ref was deleted. - info.remote_ref_string # path to the remote reference located on the remote side - info.remote_ref # Remote Reference on the local side corresponding to + + info = remote.push()[0] + info.flags # bitflags providing more information about the result + info.local_ref # Reference pointing to the local reference that was pushed + # It is None if the ref was deleted. + info.remote_ref_string # path to the remote reference located on the remote side + info.remote_ref # Remote Reference on the local side corresponding to # the remote_ref_string. It can be a TagReference as well. - info.old_commit # commit at which the remote_ref was standing before we pushed + info.old_commit # commit at which the remote_ref was standing before we pushed # it to local_ref.commit. Will be None if an error was indicated + """ __slots__ = ('local_ref', 'remote_ref_string', 'flags', 'old_commit', '_remote') |