summaryrefslogtreecommitdiff
path: root/lib/git/index.py
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2009-11-04 17:11:19 +0100
committerSebastian Thiel <byronimo@gmail.com>2009-11-04 17:11:19 +0100
commitf1e9df152219e85798d78284beeda88f6baa9ec7 (patch)
tree857596e929556cd946518a4d1c404eb8e6d8cd87 /lib/git/index.py
parent52bb0046c0bf0e50598c513e43b76d593f2cbbff (diff)
parentfc2201e660014c5d91fec8e3c3a3fa5a66dcf33b (diff)
downloadgitpython-f1e9df152219e85798d78284beeda88f6baa9ec7.tar.gz
Merge branch 'docs' into improvements
* docs: Converted tabs to spaces. added paragraph about the diffing engine and how to switch branches, which once more shows the need for a real checkout for all the people who do not want to implement all the safety facilities themselves Added Index Object paragraph and wrote the Remote Handling paragraph. Updated repo area added paragraph about using the git-python command Worked on the tree object handling and realized an issue with attribute naming on index objects and the way the system handles these initial work on tutorial.rst added all new files to reference.rst and corrected the worst mistakes. There are still a few errors left that I cannot fix as it complains about whitespace in the end ... that is exactly what I hate restructured text for, its just a ... anyway.
Diffstat (limited to 'lib/git/index.py')
-rw-r--r--lib/git/index.py9
1 files changed, 5 insertions, 4 deletions
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