/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: Szilveszter Farkas (Phanatic)
  • Date: 2006-07-16 16:27:59 UTC
  • mto: (0.14.1 main) (93.1.1 win32.bialix)
  • mto: This revision was merged to the branch mainline in revision 83.
  • Revision ID: Szilveszter.Farkas@gmail.com-20060716162759-f3e8596921edc374
2006-07-16  Szilveszter Farkas <Szilveszter.Farkas@gmail.com>

    * Done some directory reorganization.
    * setup.py: added some basic install script
    * Began to implement the GTK UI.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
bzr-gtk - GTK+ Frontends to various Bazaar commands
2
 
===================================================
3
 
 
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.
8
 
 
9
 
 
10
 
Dependencies
11
 
------------
12
 
 
13
 
bzr-gtk is written in Python, so doesn't need compiling, however you will
14
 
need the following runtime dependencies:
15
 
 
16
 
  * Python 2.4
17
 
  * Bazaar with the same major version as bzr-gtk
18
 
  * PyGTK 2.8 or later
19
 
 
20
 
In order to see graphs in the visualisation tool, you will also need:
21
 
 
22
 
  * PyCairo 1.0 or later
23
 
 
24
 
In order to see syntax highlighted diffs:
25
 
 
26
 
  * gtksourceview python bindings (on Debian and Ubuntu systems, these
27
 
    are in the python-gnome2-desktop package)
28
 
 
29
 
In order to use the nautilus integration, you will need:
30
 
 
31
 
 * python-nautilus
32
 
 
33
 
For Olive on Windows:
34
 
 
35
 
 * pyWin32 (tested with build 209)
36
 
 
37
 
Installation
38
 
------------
39
 
 
40
 
The easiest way to install bzr-gtk is to either copy or symlink the
41
 
directory into your ~/.bazaar/plugins directory.
42
 
 
43
 
Other ways include doing the same in the bzrlib/plugins directory of
44
 
your bzr working tree, or adding the location of bzr-gtk to your
45
 
BZR_PLUGIN_PATH environment variable.
46
 
 
47
 
Note: the plugin directory of bzr-gtk must be called 'gtk'.
48
 
 
49
 
To use the nautilus integration, either place the nautilus-bzr.py file in
50
 
~/.nautilus/python-extensions or in /usr/lib/nautilus/extensions-1.0/python
51
 
 
52
 
Usage - Visualisation
53
 
---------------------
54
 
 
55
 
Simply run "bzr visualise" (or "bzr viz") while in a bzr working tree or
56
 
branch, a window will appear with the history of the branch and a graph
57
 
connecting the individual revisions.
58
 
 
59
 
You can move through the revision history by clicking or with the arrow
60
 
keys.  You can also use the Back (shortcut '[') and Forward (shortcut ']')
61
 
buttons which move to the previous and next revision from that selected
62
 
(which may not be immediately adjacent in the list).
63
 
 
64
 
Details for the selected revision are shown in the pane at the bottom,
65
 
including the ids of the parent revisions.  Clicking on the go icon next
66
 
to a parent moves the list to that revision; clicking on the view icon
67
 
opens a window to display the difference between the two revisions.
68
 
 
69
 
Usage - annotate
70
 
----------------
71
 
 
72
 
Simply run "bzr gannotate FILENAME" while in a bzr working tree or branch.
73
 
 
74
 
The commit log message is shown in the lower window pane for the selected
75
 
line.  The line number column is searchable; jump to a specific line by typing
76
 
the line number while the annotation pane is in focus. Control-f will also
77
 
initiate a search.
78
 
 
79
 
By default, lines are highlighted according to age. This functionality is a
80
 
crib of emacs' VC-annotate highlighting, and thus works similarly: blue is
81
 
oldest and red is youngest, and an assortment of other colors in-between:
82
 
 
83
 
        blue --> green --> yellow --> orange --> red
84
 
 
85
 
Time spans are scaled; for instance by selecting "1 Day", lines older than a
86
 
day will be highlighted blue, but changes in the past hour will be red and
87
 
lines 2 hours old may be orange. Highlighting can be turned off with --plain
88
 
if overwhelming.
89
 
 
90
 
Usage - diff window
91
 
-------------------
92
 
 
93
 
If you have the gtksourceview python bindings installed, the diff window
94
 
will have syntax highlighting. If the python GConf bindings are installed, 
95
 
the colors will be read from gedit's syntax highlighting configuration
96
 
for the "Diff" language.
97
 
 
98
 
Afterwards, colors from the ~/.colordiffrc file will be read, and will
99
 
override gedit's. Since that file may be written for a dark background
100
 
environment, the file ~/.colordiffrc.bzr-gtk can be used to override
101
 
some values.
102
 
 
103
 
Because gtksourceview is more configurable that colordiff, in addition
104
 
to the 'oldtext', 'newtext', and 'diffstuff' keys, the following keys
105
 
are also accepted: 'location', 'file', 'specialcase'.
106
 
 
107
 
Colors can be specified with names (valid names are those in the
108
 
/usr/share/X11/rgb.txt file), or with a #RRGGBB notation.
109
 
 
110
 
Install on Windows
111
 
------------------
112
 
 
113
 
You can download the dependencies from the following locations:
114
 
 
115
 
 - Python: http://www.python.org/download/releases/2.4.3/
116
 
 - GTK: http://gladewin32.sourceforge.net/
117
 
 - PyGTK: http://www.mapr.ucl.ac.be/~gustin/win32_ports (pygtk, pygobject and pycairo)
118
 
 - Bazaar: http://bazaar-vcs.org/WindowsDownloads (Python-based should be okay)
119
 
 - pyWin32: http://sourceforge.net/project/showfiles.php?group_id=78018
120
 
 
121
 
As an Administrator, you can install Olive with the standard command:
122
 
 
123
 
 > c:\Python24\python.exe setup.py install
124
 
 
125
 
You can run Olive with this command:
126
 
 
127
 
 > c:\Python24\python.exe c:\Python\Scripts\olive-gtk
128
 
 
129