/b-gtk/fix-viz

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/b-gtk/fix-viz

« back to all changes in this revision

Viewing changes to README

  • Committer: Jelmer Vernooij
  • Date: 2006-05-19 16:56:46 UTC
  • mfrom: (0.1.25 gannotate)
  • Revision ID: jelmer@samba.org-20060519165646-0d867938fdbc9097
Merge in Dan Loda's gannotate plugin and put it in annotate/

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
bzrk - visualisation plugin for bzr
2
 
===================================
 
1
bzr-gtk - GTK+ Frontends to various Bazaar commands
 
2
===================================================
3
3
 
4
 
This is a plugin for bzr that allows you to see the history of a branch
5
 
and relationships between the revisions visually.
 
4
This is a plugin for bzr that contains various GTK+ frontends to 
 
5
Bazaar commands. It currently contains a tool to see the history
 
6
and relationships between the revisions visually and one to 
 
7
view annotated files.
6
8
 
7
9
 
8
10
Dependencies
9
11
------------
10
12
 
11
 
bzrk is written in Python, so doesn't need compiling, however you will
 
13
bzr-gtk is written in Python, so doesn't need compiling, however you will
12
14
need the following runtime dependencies:
13
15
 
14
16
  * Python 2.4
15
17
  * bzr 0.8 or later
16
18
  * PyGTK 2.8 or later
 
19
 
 
20
In order to see graphs in the visualisation tool, you will also need:
 
21
 
17
22
  * PyCairo 1.0 or later
18
23
 
19
24
 
20
25
Installation
21
26
------------
22
27
 
23
 
The easiest way to install bzrk is to either copy or symlink the
 
28
The easiest way to install bzr-gtk is to either copy or symlink the
24
29
directory into your ~/.bazaar/plugins directory.
25
30
 
26
31
Other ways include doing the same in the bzrlib/plugins directory of
27
 
your bzr working tree, or adding the location of bzrk to your
 
32
your bzr working tree, or adding the location of bzr-gtk to your
28
33
BZR_PLUGIN_PATH environment variable.
29
34
 
30
 
 
31
 
Usage
32
 
-----
 
35
Usage - Visualisation
 
36
---------------------
33
37
 
34
38
Simply run "bzr visualise" (or "bzr viz") while in a bzr working tree or
35
39
branch, a window will appear with the history of the branch and a graph
44
48
including the ids of the parent revisions.  Clicking on the go icon next
45
49
to a parent moves the list to that revision; clicking on the view icon
46
50
opens a window to display the difference between the two revisions.
 
51
 
 
52
Usage - annotate
 
53
----------------
 
54
 
 
55
Simply run "bzr gannotate FILENAME" while in a bzr working tree or branch.
 
56
 
 
57
The commit log message is shown in the lower window pane for the selected
 
58
line.  The line number column is searchable; jump to a specific line by typing
 
59
the line number while the annotation pane is in focus. Control-f will also
 
60
initiate a search.
 
61
 
 
62
By default, lines are highlighted according to age. This functionality is a
 
63
crib of emacs' VC-annotate highlighting, and thus works similarly: blue is
 
64
oldest and red is youngest, and an assortment of other colors in-between:
 
65
 
 
66
        blue --> green --> yellow --> orange --> red
 
67
 
 
68
Time spans are scaled; for instance by selecting "1 Day", lines older than a
 
69
day will be highlighted blue, but changes in the past hour will be red and
 
70
lines 2 hours old may be orange. Highlighting can be turned off with --plain
 
71
if overwhelming.