1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>GitPython Documentation — GitPython 2.0.9dev0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.0.9dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="GitPython 2.0.9dev0 documentation" href="#" />
<link rel="next" title="Overview / Install" href="intro.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="gitpython-documentation">
<h1>GitPython Documentation<a class="headerlink" href="#gitpython-documentation" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Overview / Install</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#installing-gitpython">Installing GitPython</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#limitations">Limitations</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#getting-started">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#api-reference">API Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#source-code">Source Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#questions-and-answers">Questions and Answers</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#issue-tracker">Issue Tracker</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#license-information">License Information</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">GitPython Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#meet-the-repo-type">Meet the Repo type</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#examining-references">Examining References</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#modifying-references">Modifying References</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#understanding-objects">Understanding Objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#the-commit-object">The Commit object</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#the-tree-object">The Tree object</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#the-index-object">The Index Object</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#handling-remotes">Handling Remotes</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#submodule-handling">Submodule Handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#obtaining-diff-information">Obtaining Diff Information</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#switching-branches">Switching Branches</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#initializing-a-repository">Initializing a repository</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#using-git-directly">Using git directly</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#object-databases">Object Databases</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#git-command-debugging-and-customization">Git Command Debugging and Customization</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#and-even-more">And even more ...</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.objects.base">Objects.Base</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.objects.blob">Objects.Blob</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.objects.commit">Objects.Commit</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.objects.tag">Objects.Tag</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.objects.tree">Objects.Tree</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.objects.fun">Objects.Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.objects.submodule.base">Objects.Submodule.base</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.objects.submodule.root">Objects.Submodule.root</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.objects.submodule.util">Objects.Submodule.util</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.objects.util">Objects.Util</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.index.base">Index.Base</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.index.fun">Index.Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.index.typ">Index.Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.index.util">Index.Util</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.cmd">GitCmd</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.config">Config</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.diff">Diff</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.exc">Exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.refs.symbolic">Refs.symbolic</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.refs.reference">Refs.reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.refs.head">Refs.head</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.refs.tag">Refs.tag</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.refs.remote">Refs.remote</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.refs.log">Refs.log</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.remote">Remote</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.repo.base">Repo.Base</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-git.repo.fun">Repo.Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#util">Util</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="roadmap.html">Roadmap</a></li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changes.html#bugfixes">2.0.9 - Bugfixes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#features-and-bugfixes">2.0.8 - Features and Bugfixes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#new-features">2.0.7 - New Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#fixes-and-features">2.0.6 - Fixes and Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#fixes">2.0.5 - Fixes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id1">2.0.4 - Fixes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id2">2.0.3 - Fixes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id3">2.0.2 - Fixes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id4">2.0.1 - Fixes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#features">2.0.0 - Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id5">1.0.2 - Fixes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id6">1.0.1 - Fixes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#notes">1.0.0 - Notes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id8">0.3.7 - Fixes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id10">0.3.6 - Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id12">0.3.5 - Bugfixes</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#python-3-support">0.3.4 - Python 3 Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id13">0.3.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id14">0.3.2.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id15">0.3.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#rc1">0.3.2 RC1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#beta-2">0.3.1 Beta 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#beta-1">0.3.1 Beta 1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id16">0.3.0 Beta 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id17">0.3.0 Beta 1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id18">0.2 Beta 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id19">0.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id21">0.1.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id26">0.1.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id32">0.1.4.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id33">0.1.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id37">0.1.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id39">0.1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#id40">0.1.0</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">GitPython Documentation</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="intro.html" title="next chapter">Overview / Install</a></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©Copyright (C) 2008, 2009 Michael Trier and contributors, 2010-2015 Sebastian Thiel.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.1</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
<a href="_sources/index.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|