summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/changes.rst4
-rw-r--r--doc/source/conf.py2
-rw-r--r--doc/source/reference.rst41
-rw-r--r--doc/source/tutorial.rst8
4 files changed, 51 insertions, 4 deletions
diff --git a/doc/source/changes.rst b/doc/source/changes.rst
index 563fb46b..de872e2d 100644
--- a/doc/source/changes.rst
+++ b/doc/source/changes.rst
@@ -2,6 +2,10 @@
Changelog
=========
+0.3.2 Beta 2
+============
+* Added reflog support ( reading and writing )
+
0.3.2 Beta 1
============
* Flattened directory structure to make development more convenient.
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
********************