Skip to content

Commit fd96cce

Browse files
ByronByron
committed
Merge branch 'docs'
2 parents 6917ae4 + c3bd05b commit fd96cce

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+7893
-199
lines changed

‎CHANGES

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,34 @@
11
=======
22
CHANGES
33
=======
4+
45
0.3
56
===
6-
* ConcurrentWriteOperation was removed, and replaced by LockedFD
7-
* IndexFile.get_entries_key was renamed to entry_key
8-
* IndexEntry instances contained in IndexFile.entries now use binary sha's. Use
9-
the .hexsha property to obtain the hexadecimal version. The .sha property
10-
was removed to make the use of the respective sha more explicit.
11-
* IndexFile.write_tree: removed missing_ok keyword, its always True now
12-
Instead of raising GitCommandError it raises UnmergedEntriesError
13-
* diff.Diff.null_hex_sha renamed to NULL_HEX_SHA, to be conforming with
14-
the naming in the Object base class
15-
* Object instances, and everything derived from it, now use binary sha's internally. The 'sha' member was removed, in favor of the 'binsha' member.
7+
Renamed Modules
8+
---------------
9+
* For consistency with naming conventions used in sub-modules like gitdb, the following modules have been renamed
10+
* git.utils -> git.util
11+
* git.errors -> git.exc
12+
* git.objects.utils -> git.objects.util
13+
14+
General
15+
-------
16+
* Object instances, and everything derived from it, now use binary sha's internally. The 'sha' member was removed, in favor of the 'binsha' member.
1617
An 'hexsha' property is available for convenient conversions.
1718
They may only be initialized using their binary shas, reference names or revision specs are not allowed anymore.
18-
* The .data attribute was removed from the Object type, it is only available
19-
on the Blob type.
19+
* IndexEntry instances contained in IndexFile.entries now use binary sha's. Use the .hexsha property to obtain the hexadecimal version. The .sha property was removed to make the use of the respective sha more explicit.
20+
* If objects are instantiated explicitly, a binary sha is required to identify the object, where previously any rev-spec could be used. The ref-spec compatible
21+
version still exists as Object.new or Repo.commit|Repo.tree respectively.
22+
* The .data attribute was removed from the Object type, to obtain plain data, use the data_stream property instead.
23+
* ConcurrentWriteOperation was removed, and replaced by LockedFD
24+
* IndexFile.get_entries_key was renamed to entry_key
25+
* IndexFile.write_tree: removed missing_ok keyword, its always True now
26+
Instead of raising GitCommandError it raises UnmergedEntriesError.
27+
This is required as the pure-python implementation doesn't support the missing_ok keyword yet.
28+
* diff.Diff.null_hex_sha renamed to NULL_HEX_SHA, to be conforming with
29+
the naming in the Object base class
30+
31+
2032

2133

2234
0.2 Beta 2

‎VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.2.0-beta1
1+
0.3.0-beta1

‎doc/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build/

‎doc/Makefile

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ PAPER =
99
# Internal variables.
1010
PAPEROPT_a4 = -D latex_paper_size=a4
1111
PAPEROPT_letter = -D latex_paper_size=letter
12-
ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
12+
ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
1313

1414
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
1515

@@ -24,52 +24,52 @@ help:
2424
@echo " linkcheck to check all external links for integrity"
2525

2626
clean:
27-
-rm -rf _build/*
27+
-rm -rf build/*
2828

2929
html:
30-
mkdir -p _build/html _build/doctrees
31-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
30+
mkdir -p build/html build/doctrees
31+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
3232
@echo
33-
@echo "Build finished. The HTML pages are in _build/html."
33+
@echo "Build finished. The HTML pages are in build/html."
3434

3535
pickle:
36-
mkdir -p _build/pickle _build/doctrees
37-
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
36+
mkdir -p build/pickle build/doctrees
37+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
3838
@echo
3939
@echo "Build finished; now you can process the pickle files."
4040

4141
web: pickle
4242

4343
json:
44-
mkdir -p _build/json _build/doctrees
45-
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
44+
mkdir -p build/json build/doctrees
45+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
4646
@echo
4747
@echo "Build finished; now you can process the JSON files."
4848

4949
htmlhelp:
50-
mkdir -p _build/htmlhelp _build/doctrees
51-
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
50+
mkdir -p build/htmlhelp build/doctrees
51+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
5252
@echo
5353
@echo "Build finished; now you can run HTML Help Workshop with the" \
54-
".hhp project file in _build/htmlhelp."
54+
".hhp project file in build/htmlhelp."
5555

5656
latex:
57-
mkdir -p _build/latex _build/doctrees
58-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
57+
mkdir -p build/latex build/doctrees
58+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
5959
@echo
60-
@echo "Build finished; the LaTeX files are in _build/latex."
60+
@echo "Build finished; the LaTeX files are in build/latex."
6161
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
6262
"run these through (pdf)latex."
6363

6464
changes:
65-
mkdir -p _build/changes _build/doctrees
66-
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
65+
mkdir -p build/changes build/doctrees
66+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
6767
@echo
68-
@echo "The overview file is in _build/changes."
68+
@echo "The overview file is in build/changes."
6969

7070
linkcheck:
71-
mkdir -p _build/linkcheck _build/doctrees
72-
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
71+
mkdir -p build/linkcheck build/doctrees
72+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
7373
@echo
7474
@echo "Link check complete; look for any errors in the above output " \
75-
"or in _build/linkcheck/output.txt."
75+
"or in build/linkcheck/output.txt."

‎doc/doc_index/0.1/_sources/index.txt

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. GitPython documentation master file, created by sphinx-quickstart on Sat Jan 24 11:51:01 2009.
2+
You can adapt this file completely to your liking, but it should at least
3+
contain the root `toctree` directive.
4+
5+
GitPython Documentation
6+
=======================
7+
8+
Contents:
9+
10+
.. toctree::
11+
:maxdepth: 3
12+
13+
intro
14+
tutorial
15+
reference
16+
17+
Indices and tables
18+
==================
19+
20+
* :ref:`genindex`
21+
* :ref:`modindex`
22+
* :ref:`search`
23+

‎doc/doc_index/0.1/_sources/intro.txt

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
.. _intro_toplevel:
2+
3+
==================
4+
Overview / Install
5+
==================
6+
7+
GitPython is a python library used to interact with Git repositories.
8+
9+
GitPython is a port of the grit_ library in Ruby created by
10+
Tom Preston-Werner and Chris Wanstrath.
11+
12+
.. _grit: http://grit.rubyforge.org
13+
14+
Requirements
15+
============
16+
17+
* Git_ tested with 1.5.3.7
18+
* `Python Nose`_ - used for running the tests
19+
* `Mock by Michael Foord`_ used for tests. Requires 0.5 or higher
20+
21+
.. _Git: http://git-scm.com/
22+
.. _Python Nose: http://code.google.com/p/python-nose/
23+
.. _Mock by Michael Foord: http://www.voidspace.org.uk/python/mock/
24+
25+
Installing GitPython
26+
====================
27+
28+
Installing GitPython is easily done using
29+
`setuptools`_. Assuming it is
30+
installed, just run the following from the command-line:
31+
32+
.. sourcecode:: none
33+
34+
# easy_install GitPython
35+
36+
This command will download the latest version of GitPython from the
37+
`Python Package Index <http://pypi.python.org/pypi/GitPython>`_ and install it
38+
to your system. More information about ``easy_install`` and pypi can be found
39+
here:
40+
41+
* `setuptools`_
42+
* `install setuptools <http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions>`_
43+
* `pypi <http://pypi.python.org/pypi/GitPython>`_
44+
45+
.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
46+
47+
Alternatively, you can install from the distribution using the ``setup.py``
48+
script:
49+
50+
.. sourcecode:: none
51+
52+
# python setup.py install
53+
54+
Getting Started
55+
===============
56+
57+
* :ref:`tutorial_toplevel` - This tutorial provides a walk-through of some of
58+
the basic functionality and concepts used in GitPython. It, however, is not
59+
exhaustive so you are encouraged to spend some time in the
60+
:ref:`api_reference_toplevel`.
61+
62+
API Reference
63+
=============
64+
65+
An organized section of the GitPthon API is at :ref:`api_reference_toplevel`.
66+
67+
Source Code
68+
===========
69+
70+
GitPython's git repo is available on Gitorious, which can be browsed at:
71+
72+
http://gitorious.org/git-python
73+
74+
and cloned from:
75+
76+
git://gitorious.org/git-python/mainline.git
77+
78+
License Information
79+
===================
80+
81+
GitPython is licensed under the New BSD License. See the LICENSE file for
82+
more information.
83+

‎doc/doc_index/0.1/_sources/reference.txt

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
.. _api_reference_toplevel:
2+
3+
API Reference
4+
=============
5+
6+
Actor
7+
-----
8+
9+
.. automodule:: git.actor
10+
:members:
11+
:undoc-members:
12+
13+
Blob
14+
----
15+
16+
.. automodule:: git.blob
17+
:members:
18+
:undoc-members:
19+
20+
Git
21+
---
22+
23+
.. automodule:: git.cmd
24+
:members:
25+
:undoc-members:
26+
27+
Commit
28+
------
29+
30+
.. automodule:: git.commit
31+
:members:
32+
:undoc-members:
33+
34+
Diff
35+
----
36+
37+
.. automodule:: git.diff
38+
:members:
39+
:undoc-members:
40+
41+
Errors
42+
------
43+
44+
.. automodule:: git.errors
45+
:members:
46+
:undoc-members:
47+
48+
Head
49+
----
50+
51+
.. automodule:: git.head
52+
:members:
53+
:undoc-members:
54+
55+
Lazy
56+
----
57+
58+
.. automodule:: git.lazy
59+
:members:
60+
:undoc-members:
61+
62+
Repo
63+
----
64+
65+
.. automodule:: git.repo
66+
:members:
67+
:undoc-members:
68+
69+
Stats
70+
-----
71+
72+
.. automodule:: git.stats
73+
:members:
74+
:undoc-members:
75+
76+
Tag
77+
---
78+
79+
.. automodule:: git.tag
80+
:members:
81+
:undoc-members:
82+
83+
Tree
84+
----
85+
86+
.. automodule:: git.tree
87+
:members:
88+
:undoc-members:
89+
90+
Utils
91+
-----
92+
93+
.. automodule:: git.utils
94+
:members:
95+
:undoc-members:

0 commit comments

Comments
 (0)