~ubuntu-branches/debian/sid/geany-plugins/sid

« back to all changes in this revision

Viewing changes to geanyvc/README

  • Committer: Bazaar Package Importer
  • Author(s): Chow Loong Jin
  • Date: 2009-07-10 22:56:41 UTC
  • Revision ID: james.westby@ubuntu.com-20090710225641-xc1126t7pq0jmpos
Tags: upstream-0.17.1
ImportĀ upstreamĀ versionĀ 0.17.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.. |(version)| replace:: 0.5
 
2
 
 
3
=======
 
4
geanyvc
 
5
=======
 
6
 
 
7
.. contents::
 
8
 
 
9
About
 
10
=====
 
11
 
 
12
geanyvc is plugin that provides a uniform way of accessing the different
 
13
version-control systems inside Geany IDE. Only small subset of vc is
 
14
implemented, but, hey, you don't need anything besides diff, log, status,
 
15
revert and commit most time.
 
16
 
 
17
In order to use it you need Geany 0.16.
 
18
 
 
19
Features
 
20
========
 
21
 
 
22
geanyvc currently support the following version control systems:
 
23
 
 
24
Bazaar, GIT, Mercurial, Subversion, SVK::
 
25
 
 
26
 * diff file
 
27
 * diff directory
 
28
 * diff base directory
 
29
 * blame
 
30
 * log file
 
31
 * log directory
 
32
 * log base directory
 
33
 * status
 
34
 * revert file
 
35
 * revert directory
 
36
 * revert base directory
 
37
 * show unmodified original file
 
38
 * add file
 
39
 * remove file
 
40
 * update
 
41
 * commit
 
42
 
 
43
CVS::
 
44
 
 
45
 * diff file
 
46
 * diff directory
 
47
 * diff base directory
 
48
 * log file
 
49
 * log directory
 
50
 * log base directory
 
51
 * status
 
52
 * revert file
 
53
 * revert directory
 
54
 * revert base directory
 
55
 * update
 
56
 
 
57
Requirements
 
58
============
 
59
 
 
60
For compiling the plugin yourself, you will need the GTK (>= 2.6.0) libraries
 
61
and header files. You will also need its dependency libraries and header
 
62
files, such as Pango, Glib and ATK. All these files are available at
 
63
http://www.gtk.org.
 
64
If you like to use spellchecking for your commit
 
65
messages you will also need gtkspell (>=2.0), but this is only optional.
 
66
 
 
67
And obviously, you will need have Geany installed. If you have Geany installed
 
68
from the sources, you should be ready to go.
 
69
If you used a prepared package e.g. from your distribution you probably need
 
70
to install an additional package, this might be called geany-dev or geany-devel.
 
71
Please note that in order to compile and use this plugin, you need Geany 0.15
 
72
or later.
 
73
 
 
74
Furthermore you need, of course, a C compiler and the Make tool.
 
75
The GNU versions of these tools are recommended.
 
76
 
 
77
Usage
 
78
=====
 
79
 
 
80
After compiling and/or installing geanyvc, start Geany and go to menu
 
81
Tools->Plugin Manager and set checkbox at VC plugin.
 
82
 
 
83
You can configure the following options:
 
84
 
 
85
* Set Change flag for document tabs created with pluging.
 
86
 
 
87
If this option is activated, every new by the VC-plugin created document tab
 
88
will be marked as changed. Even thus this option is useful in some cases, it
 
89
could cause a big number of sometimes annoying "Do you want to save"-dialogs.
 
90
 
 
91
* Confirm adding new files to a VCS
 
92
 
 
93
Shows a confirmation dialog on adding a new (created) file to VCS. If not set
 
94
you will not see dialog "Do you want to add <file>?"
 
95
 
 
96
* Maximize commit dialog
 
97
 
 
98
If this option is activated, commit dialog will fit the full size of your
 
99
monitor. If it is not set commit dialog size will be 700x500.
 
100
 
 
101
* Use external diff viewer
 
102
 
 
103
If this option is activated and you have **meld**, **kompare**, **kdiff3**, 
 
104
**diffuse** or **tkdiff** available from command line, one of these program 
 
105
will be used to show differences for "Diff From Current File" command.
 
106
 
 
107
* Enable CVS/GIT/SVN/SVK/Bazaar/Mercurial
 
108
 
 
109
geanyvc detect if opened file is in version control by checking directories
 
110
and executing commands from version control systems toolchain. These options
 
111
disable checking for particular version control system. Disabling not
 
112
required ones can speed up things. So it is recommended to activate svk only
 
113
if you want to use it, since it is quiet slow.
 
114
 
 
115
License
 
116
=======
 
117
 
 
118
geanyvc is distributed under the terms of the GNU General Public License
 
119
as published by the Free Software Foundation; either version 2 of the
 
120
License, or (at your option) any later version. A copy of this license
 
121
can be found in the file COPYING included with the source code of this
 
122
program.
 
123
 
 
124
Ideas, questions, patches and bug reports
 
125
=========================================
 
126
 
 
127
If you add something, or fix a bug, please send a patch (in 'diff -u'
 
128
format) to the geany mailing list or to one of the authors listed bellow.
 
129
 
 
130
Coding
 
131
======
 
132
 
 
133
Use static functions where possible.
 
134
Try to use GLib types and functions - e.g. g_free instead of free and
 
135
try to use only GLib 2.6 and GTK 2.6 functions. At least for the moment,
 
136
we want to keep the minimum requirement for GTK at 2.6.
 
137
 
 
138
Style
 
139
=====
 
140
 
 
141
The file indent-all.sh contains information about
 
142
the current code style. Run this script before commit.
 
143
 
 
144
Download
 
145
========
 
146
 
 
147
The current version is:
 
148
 
 
149
============= =============== ==========================================================
 
150
Geany Version Geanyvc Version Download
 
151
============= =============== ==========================================================
 
152
0.16                      0.5 http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.5.tar.gz
 
153
============= =============== ==========================================================
 
154
 
 
155
Up to date source code can be downloaded here::
 
156
 
 
157
  svn checkout http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyvc
 
158
 
 
159
If you have old version of Geany installed you need old version of plugin as well. These versions of plugin
 
160
are no longer supported and if you find bug in one of them, it won't be fixed unless you do it yourself.
 
161
 
 
162
============= =============== ==========================================================
 
163
Geany Version Geanyvc Version Download
 
164
============= =============== ==========================================================
 
165
0.15                      0.4 http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.4.tar.gz
 
166
 
 
167
0.14                      0.3 http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.3.tar.gz
 
168
 
 
169
0.13                      0.2 http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.2.tar.gz
 
170
============= =============== ==========================================================
 
171
 
 
172
Gentoo
 
173
------
 
174
 
 
175
Gentoo ebuild is available here: http://bugs.gentoo.org/show_bug.cgi?id=218522
 
176
 
 
177
Arch linux
 
178
----------
 
179
 
 
180
A package for Arch Linux is available here: http://aur.archlinux.org/packages.php?ID=16484
 
181
 
 
182
Source Mage
 
183
-----------
 
184
 
 
185
To install geanyvc, just run the following command::
 
186
 
 
187
  cast geanyvc
 
188
 
 
189
Windows
 
190
-------
 
191
 
 
192
A windows installer is available here: http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.4_setup.exe
 
193
 
 
194
--
 
195
2007-2008 by Yura Siamashka and Frank Lanitz
 
196
yurand2(at)gmail(dot)com
 
197
frank(at)frank(dot)uvena(dot)de