summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2011-06-07 22:26:19 +0200
committerSebastian Thiel <byronimo@gmail.com>2011-06-07 22:26:19 +0200
commite0524096fa9f3add551abbf68ee22904b249d82f (patch)
treed238d4e8cf89ecd76ef79c31762f6dd1c8e2c07a /doc/source
parent36a984803df08b0f6eb5f8a73254dd64bc616b67 (diff)
downloadgitpython-e0524096fa9f3add551abbf68ee22904b249d82f.tar.gz
Fixed up docs in preparation for the new 0.3.1 release
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/changes.rst19
-rw-r--r--doc/source/tutorial.rst15
2 files changed, 31 insertions, 3 deletions
diff --git a/doc/source/changes.rst b/doc/source/changes.rst
index 2433d00e..22568e3d 100644
--- a/doc/source/changes.rst
+++ b/doc/source/changes.rst
@@ -2,11 +2,24 @@
Changelog
=========
-NEXT
-====
-* Blob Type
+0.3.1
+=====
+* **git** command wrapper
+
+ * Added ``version_info`` property which returns a tuple of integers representing the installed git version.
+
+* **Blob** Type
+
* Added mode constants to ease the manual creation of blobs
+* **More Changes**
+
+ * Configuration file parsing is more robust. It should now be able to handle everything that the git command can parse as well.
+ * The progress parsing was updated to support git 1.7.0.3 and newer. Previously progress was not enabled for the git command or only worked with ssh in case of older git versions.
+ * Parsing of tags was improved. Previously some parts of the name could not be parsed properly.
+ * The rev-parse pure python implementation now handles branches correctly if they look like hexadecimal sha's.
+
+
0.3.1 Beta 2
============
* Added **reflog support** ( reading and writing )
diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst
index 5530cedd..a9a3f81d 100644
--- a/doc/source/tutorial.rst
+++ b/doc/source/tutorial.rst
@@ -385,6 +385,21 @@ The item returned is a DiffIndex which is essentially a list of Diff objects. It
for diff_added in wdiff.iter_change_type('A'): do_something_with(diff_added)
+Use the diff framework if you want to implement git-status like functionality.
+
+* A diff between the index and the commit's tree your HEAD points to
+
+ * use repo.index.diff(repo.head)
+
+* A diff between the index and the working tree
+
+ * use repo.index.diff(None)
+
+* A list of untracked files
+
+ * use repo.untracked_files
+
+
Switching Branches
******************
To switch between branches, you effectively need to point your HEAD to the new branch head and reset your index and working copy to match. A simple manual way to do it is the following one::