Skip to content

Commit e052409

Browse files
committed
Fixed up docs in preparation for the new 0.3.1 release
1 parent 36a9848 commit e052409

File tree

3 files changed

+33
-4
lines changed

3 files changed

+33
-4
lines changed

doc/source/changes.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,24 @@
22
Changelog
33
=========
44

5-
NEXT
6-
====
7-
* Blob Type
5+
0.3.1
6+
=====
7+
* **git** command wrapper
8+
9+
* Added ``version_info`` property which returns a tuple of integers representing the installed git version.
10+
11+
* **Blob** Type
12+
813
* Added mode constants to ease the manual creation of blobs
914

15+
* **More Changes**
16+
17+
* Configuration file parsing is more robust. It should now be able to handle everything that the git command can parse as well.
18+
* 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.
19+
* Parsing of tags was improved. Previously some parts of the name could not be parsed properly.
20+
* The rev-parse pure python implementation now handles branches correctly if they look like hexadecimal sha's.
21+
22+
1023
0.3.1 Beta 2
1124
============
1225
* Added **reflog support** ( reading and writing )

doc/source/tutorial.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,21 @@ The item returned is a DiffIndex which is essentially a list of Diff objects. It
385385

386386
for diff_added in wdiff.iter_change_type('A'): do_something_with(diff_added)
387387

388+
Use the diff framework if you want to implement git-status like functionality.
389+
390+
* A diff between the index and the commit's tree your HEAD points to
391+
392+
* use repo.index.diff(repo.head)
393+
394+
* A diff between the index and the working tree
395+
396+
* use repo.index.diff(None)
397+
398+
* A list of untracked files
399+
400+
* use repo.untracked_files
401+
402+
388403
Switching Branches
389404
******************
390405
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::

git/cmd.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,8 @@ def working_dir(self):
237237

238238
@property
239239
def version_info(self):
240-
""":return: tuple(int, ...) tuple with integers representing the major, minor
240+
"""
241+
:return: tuple(int, ...) tuple with integers representing the major, minor
241242
and additional version numbers as parsed from git version.
242243
This value is generated on demand and is cached"""
243244
return self._version_info

0 commit comments

Comments
 (0)