Repository navigation
Expand file tree
/
Copy pathindex.html
More file actions
341 lines (252 loc) · 19.3 KB
/
Copy pathindex.html
File metadata and controls
341 lines (252 loc) · 19.3 KB
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Introduction — CodeReview 0.1.0 documentation</title>
<link rel="stylesheet" href="static/css/theme.css" type="text/css" />
<link rel="top" title="CodeReview 0.1.0 documentation" href="#"/>
<link rel="next" title="1. Installation" href="installation.html"/>
<script src="static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="#" class="icon icon-home"> CodeReview
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">1. Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#dependencies">1.1. Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installation-from-pypi-repository">1.2. Installation from PyPi Repository</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installation-from-source">1.3. Installation from Source</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference-manual.html">2. API Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/CodeReview.html">2.1. <code class="docutils literal"><span class="pre">CodeReview</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Application.html">2.1.1. <code class="docutils literal"><span class="pre">Application</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Application/ApplicationBase.html">2.1.1.1. <code class="docutils literal"><span class="pre">ApplicationBase</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Config.html">2.1.2. <code class="docutils literal"><span class="pre">Config</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Config/Config.html">2.1.2.1. <code class="docutils literal"><span class="pre">Config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Config/ConfigInstall.html">2.1.2.2. <code class="docutils literal"><span class="pre">ConfigInstall</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Config/Messages.html">2.1.2.3. <code class="docutils literal"><span class="pre">Messages</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Diff.html">2.1.3. <code class="docutils literal"><span class="pre">Diff</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Diff/RawTextDocument.html">2.1.3.1. <code class="docutils literal"><span class="pre">RawTextDocument</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Diff/RawTextDocumentDiff.html">2.1.3.2. <code class="docutils literal"><span class="pre">RawTextDocumentDiff</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Diff/SyntaxHighlighter.html">2.1.3.3. <code class="docutils literal"><span class="pre">SyntaxHighlighter</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Diff/TextDocumentDiffModel.html">2.1.3.4. <code class="docutils literal"><span class="pre">TextDocumentDiffModel</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Diff/TextDocumentModel.html">2.1.3.5. <code class="docutils literal"><span class="pre">TextDocumentModel</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/GUI.html">2.1.4. <code class="docutils literal"><span class="pre">GUI</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/GUI/Base.html">2.1.4.1. <code class="docutils literal"><span class="pre">Base</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/GUI/DiffViewer.html">2.1.4.2. <code class="docutils literal"><span class="pre">DiffViewer</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/GUI/Forms.html">2.1.4.3. <code class="docutils literal"><span class="pre">Forms</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/GUI/LogBrowser.html">2.1.4.4. <code class="docutils literal"><span class="pre">LogBrowser</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/GUI/Widgets.html">2.1.4.5. <code class="docutils literal"><span class="pre">Widgets</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/GUI/ui.html">2.1.4.6. <code class="docutils literal"><span class="pre">ui</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Logging.html">2.1.5. <code class="docutils literal"><span class="pre">Logging</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Logging/ExceptionHook.html">2.1.5.1. <code class="docutils literal"><span class="pre">ExceptionHook</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Logging/Logging.html">2.1.5.2. <code class="docutils literal"><span class="pre">Logging</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Math.html">2.1.6. <code class="docutils literal"><span class="pre">Math</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Math/Functions.html">2.1.6.1. <code class="docutils literal"><span class="pre">Functions</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Math/Interval.html">2.1.6.2. <code class="docutils literal"><span class="pre">Interval</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/PatienceDiff.html">2.1.7. <code class="docutils literal"><span class="pre">PatienceDiff</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/PatienceDiff/_patiencediff_py.html">2.1.7.1. <code class="docutils literal"><span class="pre">_patiencediff_py</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Tools.html">2.1.8. <code class="docutils literal"><span class="pre">Tools</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Tools/BackTrace.html">2.1.8.1. <code class="docutils literal"><span class="pre">BackTrace</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Tools/EnumFactory.html">2.1.8.2. <code class="docutils literal"><span class="pre">EnumFactory</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Tools/IteratorTools.html">2.1.8.3. <code class="docutils literal"><span class="pre">IteratorTools</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Tools/Path.html">2.1.8.4. <code class="docutils literal"><span class="pre">Path</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Tools/Platform.html">2.1.8.5. <code class="docutils literal"><span class="pre">Platform</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Tools/ProgramOptions.html">2.1.8.6. <code class="docutils literal"><span class="pre">ProgramOptions</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Tools/RevisionVersion.html">2.1.8.7. <code class="docutils literal"><span class="pre">RevisionVersion</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Tools/Singleton.html">2.1.8.8. <code class="docutils literal"><span class="pre">Singleton</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Tools/Slice.html">2.1.8.9. <code class="docutils literal"><span class="pre">Slice</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="api/CodeReview/Tools/StringTools.html">2.1.8.10. <code class="docutils literal"><span class="pre">StringTools</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Version.html">2.1.9. <code class="docutils literal"><span class="pre">Version</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference-manual.html#indexes">2.2. Indexes</a></li>
</ul>
</li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">CodeReview</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>Introduction</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<br/><p>Welcome to the CodeReview documentation!</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>The official Home Page of CodeReview is located at <a class="reference external" href="http://fabricesalvaire.github.io/CodeReview">http://fabricesalvaire.github.io/CodeReview</a></p>
<p>If you are at <a class="reference external" href="http://readthedocs.org">http://readthedocs.org</a> then you are reading the so called <em>latest documentation</em>.</p>
<p>The <em>latest documentation</em> <a class="reference external" href="http://CodeReview.readthedocs.org/en/latest"><img alt="CodeReview@readthedocs-badge" src="https://readthedocs.org/projects/CodeReview/badge/?version=latest" /></a> is automatically built from the
git repository after each commit.</p>
<p class="last">As opposite the <a class="reference external" href="http://fabricesalvaire.github.io/CodeReview">CodeReview Home Page</a> is built manually and is thus less prone to errors.</p>
</div>
<div class="section" id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
<p>I started to write some pieces of code of CodeReview at the end of 2011, as a port of the Bzr Qt
plugin <a class="reference external" href="http://wiki.bazaar.canonical.com/QBzr">QBzr</a> for Git when Bzr started to seriously fall
down. I am an addict of code review and I cannot work without it. QBzr features two nice tools,
qlog and qdiff for this task. It was the main reason why I am still using Bzr in 2015. But now I
succeed to release an alternative.</p>
<p>The aim of CodeReview is to provide tools for code review tasks, like to show the difference between
two versions. However I am not a fan of any GUI that aims to deal with Git with only a mouse and
one finger. Thus CodeReview is not intended to compete with a “power” IDE like eclipse, idea,
pycharm, kate ... But just to provide features not available in Emacs (my editor) or github like a
diff side-by-side on local changes.</p>
<p>CodeReview is written in Python 3 and the GUI is based on the Qt5 framework. The libgit2 and
<a class="reference external" href="http://www.pygit2.org/install.html">pygit2</a> provides a Python API to deal with Git repositories. I tried to achieve a clever design
and to write a clean code.</p>
<p>Actually CodeReview has a limited number of features. The followings list gives some ideas to extend its
features:</p>
<blockquote>
<div><ul class="simple">
<li>Add Mercurial support. (Git and Mercurial are actually the most cool VCS)</li>
<li>Add a graphical representation of the branches. I don’t understand the crappy code of qlog and I
don’t know any algorithm on this topic (graphviz, qgit ?). To summarize I don’t what and how to do.</li>
<li>Implement the detection of code translocations. Sometimes we move code within a file or a
project. Such changes are related as deletion and addition in the code, which don’t help to
review code. We can do something clever by computing a distance between all the added and
deleted chuncks. The distance could be computed using a Levenshtein, Damerau–Levenshtein,
Needleman–Wunsch or Smith–Waterman algorithm (DNA alignment algorithms).</li>
<li>Implement code analyser/validator as language plugins. The idea is to annotate change as
cosmetic or dangerous modifications. For example a deleted or added space is a cosmetic change
in C, but it can be a regression in Python where the indentation is part of the grammar.</li>
<li>Implement blame wich is another important feature.</li>
<li>Implement comments and maybe as a client-server architecture.</li>
<li>look <a class="reference external" href="https://docs.python.org/3.4/library/difflib.html">https://docs.python.org/3.4/library/difflib.html</a></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="features">
<h1>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h1>
<p>The main features of CodeReview are:</p>
<blockquote>
<div><ul class="simple">
<li>display and browse the log and paches of a Git repository</li>
<li>diff side by side using Patience algorithm</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
<p>The procedure to install CodeReview is described in the <a class="reference internal" href="installation.html#installation-page"><span>Installation Manual</span></a>.</p>
</div>
<div class="section" id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
<p>The best way to know what we can do with CodeReview and learn it, is to start with the examples.</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="reference-manual.html#reference-manual-page"><span>CodeReview Reference Manual</span></a></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">1. Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#dependencies">1.1. Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installation-from-pypi-repository">1.2. Installation from PyPi Repository</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installation-from-source">1.3. Installation from Source</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference-manual.html">2. API Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/CodeReview.html">2.1. <code class="docutils literal"><span class="pre">CodeReview</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Application.html">2.1.1. <code class="docutils literal"><span class="pre">Application</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Config.html">2.1.2. <code class="docutils literal"><span class="pre">Config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Diff.html">2.1.3. <code class="docutils literal"><span class="pre">Diff</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/GUI.html">2.1.4. <code class="docutils literal"><span class="pre">GUI</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Logging.html">2.1.5. <code class="docutils literal"><span class="pre">Logging</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Math.html">2.1.6. <code class="docutils literal"><span class="pre">Math</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/PatienceDiff.html">2.1.7. <code class="docutils literal"><span class="pre">PatienceDiff</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Tools.html">2.1.8. <code class="docutils literal"><span class="pre">Tools</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api/CodeReview/Version.html">2.1.9. <code class="docutils literal"><span class="pre">Version</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference-manual.html#indexes">2.2. Indexes</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="installation.html" class="btn btn-neutral float-right" title="1. Installation" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014, Fabrice Salvaire.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.1.0',
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>
<script type="text/javascript" src="static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>