diff options
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/changes.rst | 33 | ||||
| -rw-r--r-- | doc/source/conf.py | 2 | ||||
| -rw-r--r-- | doc/source/reference.rst | 41 | ||||
| -rw-r--r-- | doc/source/tutorial.rst | 8 |
4 files changed, 78 insertions, 6 deletions
diff --git a/doc/source/changes.rst b/doc/source/changes.rst index 563fb46b..7b959532 100644 --- a/doc/source/changes.rst +++ b/doc/source/changes.rst @@ -2,16 +2,45 @@ Changelog ========= -0.3.2 Beta 1 +0.3.1 Beta 2 ============ -* Flattened directory structure to make development more convenient. +* Added **reflog support** ( reading and writing ) + + * New types: ``RefLog`` and ``RefLogEntry`` + * Reflog is maintained automatically when creating references and deleting them + * Non-intrusive changes to ``SymbolicReference``, these don't require your code to change. They allow to append messages to the reflog. + + * ``abspath`` property added, similar to ``abspath`` of Object instances + * ``log()`` method added + * ``log_append(...)`` method added + * ``set_reference(...)`` method added (reflog support) + * ``set_commit(...)`` method added (reflog support) + * ``set_object(...)`` method added (reflog support) + + * Intrusive Changes to ``Head`` type + + * ``create(...)`` method now supports the reflog, but will not raise ``GitCommandError`` anymore as it is a pure python implementation now. Instead, it raises ``OSError``. + +* Repo.rev_parse now supports the [ref]@{n} syntax, where n is the number of steps to look into the reference's past + +* **BugFixes** + + * Removed incorrect ORIG_HEAD handling + +* **Flattened directory** structure to make development more convenient. * .. note:: This alters the way projects using git-python as a submodule have to adjust their sys.path to be able to import git-python successfully. + * Misc smaller changes and bugfixes 0.3.1 Beta 1 ============ * Full Submodule-Support * Added unicode support for author names. Commit.author.name is now unicode instead of string. +* Head Type changes + + * config_reader() & config_writer() methods added for access to head specific options. + * tracking_branch() & set_tracking_branch() methods addded for easy configuration of tracking branches. + 0.3.0 Beta 2 ============ diff --git a/doc/source/conf.py b/doc/source/conf.py index e80bd0aa..469ab3b3 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -20,7 +20,7 @@ import sys, os # is relative to the documentation root, use os.path.abspath to make it # absolute, like shown here. #sys.path.append(os.path.abspath('.')) -sys.path.insert(0, os.path.abspath('../../lib')) +sys.path.insert(0, os.path.abspath('../../../')) # General configuration # --------------------- diff --git a/doc/source/reference.rst b/doc/source/reference.rst index 75e712a8..7adc5328 100644 --- a/doc/source/reference.rst +++ b/doc/source/reference.rst @@ -131,13 +131,48 @@ Exceptions :undoc-members: -Refs ----- +Refs.symbolic +------------- + +.. automodule:: git.refs.symbolic + :members: + :undoc-members: + +Refs.reference +-------------- -.. automodule:: git.refs +.. automodule:: git.refs.reference :members: :undoc-members: +Refs.head +--------- + +.. automodule:: git.refs.head + :members: + :undoc-members: + +Refs.tag +------------ + +.. automodule:: git.refs.tag + :members: + :undoc-members: + +Refs.remote +------------ + +.. automodule:: git.refs.remote + :members: + :undoc-members: + +Refs.log +------------ + +.. automodule:: git.refs.log + :members: + :undoc-members: + Remote ------ diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst index 9aadae47..642136ab 100644 --- a/doc/source/tutorial.rst +++ b/doc/source/tutorial.rst @@ -88,6 +88,14 @@ A symbolic reference is a special case of a reference as it points to another re head = repo.head # the head points to the active branch/ref master = head.reference # retrieve the reference the head points to master.commit # from here you use it as any other reference + +Access the reflog easily:: + + log = master.log() + log[0] # first (i.e. oldest) reflog entry + log[-1] # last (i.e. most recent) reflog entry + +For more information on the reflog, see the ``RefLog`` type's documentation. Modifying References ******************** |