Skip to content

Commit

Permalink
Fixed up docs in preparation for the new 0.3.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Byron committed Jun 7, 2011
1 parent 36a9848 commit e052409
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 4 deletions.
19 changes: 16 additions & 3 deletions doc/source/changes.rst
Expand Up @@ -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 )
Expand Down
15 changes: 15 additions & 0 deletions doc/source/tutorial.rst
Expand Up @@ -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::
Expand Down
3 changes: 2 additions & 1 deletion git/cmd.py
Expand Up @@ -237,7 +237,8 @@ def working_dir(self):

@property
def version_info(self):
""":return: tuple(int, ...) tuple with integers representing the major, minor
"""
:return: tuple(int, ...) tuple with integers representing the major, minor
and additional version numbers as parsed from git version.
This value is generated on demand and is cached"""
return self._version_info
Expand Down

0 comments on commit e052409

Please sign in to comment.