~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric4.VCS.vcsPySvn.subversion.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="utf-8"?>
 
2
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
 
3
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
 
4
<html><head>
 
5
<title>eric4.VCS.vcsPySvn.subversion</title>
 
6
<style>
 
7
body {
 
8
    background:white;
 
9
    margin: 0em 1em 10em 1em;
 
10
    color: black;
 
11
}
 
12
 
 
13
h1 { color: white; background: #4FA4FF; }
 
14
h2 { color: white; background: #4FA4FF; }
 
15
h3 { color: white; background: #00557F; }
 
16
h4 { color: white; background: #00557F; }
 
17
    
 
18
a { color: #AA5500; }
 
19
 
 
20
</style>
 
21
</head>
 
22
<body><a NAME="top" ID="top"></a>
 
23
<h1>eric4.VCS.vcsPySvn.subversion</h1>
 
24
<p>
 
25
Module implementing the version control systems interface to Subversion.
 
26
</p>
 
27
<h3>Classes</h3>
 
28
<table>
 
29
<tr>
 
30
<td><a href="#Subversion">Subversion</a></td>
 
31
<td>Class implementing the version control systems interface to Subversion.</td>
 
32
</tr>
 
33
</table>
 
34
<h3>Functions</h3>
 
35
<table>
 
36
<tr><td>None</td></tr>
 
37
</table>
 
38
<hr /><hr />
 
39
<a NAME="Subversion" ID="Subversion"></a>
 
40
<h2>Subversion</h2>
 
41
<p>
 
42
    Class implementing the version control systems interface to Subversion.
 
43
</p><h4>Signals</h4>
 
44
<dl>
 
45
<dt>committed()</dt>
 
46
<dd>
 
47
emitted after the commit action has completed
 
48
</dd>
 
49
</dl>
 
50
<h3>Derived from</h3>
 
51
VersionControl
 
52
<h3>Methods</h3>
 
53
<table>
 
54
<tr>
 
55
<td><a href="#Subversion.__init__">Subversion</a></td>
 
56
<td>Constructor</td>
 
57
</tr><tr>
 
58
<td><a href="#Subversion.__svnURL">__svnURL</a></td>
 
59
<td>Private method to format a url for subversion.</td>
 
60
</tr><tr>
 
61
<td><a href="#Subversion.__vcsCommit_Step2">__vcsCommit_Step2</a></td>
 
62
<td>Private slot performing the second step of the commit action.</td>
 
63
</tr><tr>
 
64
<td><a href="#Subversion.clearStatusCache">clearStatusCache</a></td>
 
65
<td>Public method to clear the status cache.</td>
 
66
</tr><tr>
 
67
<td><a href="#Subversion.getClient">getClient</a></td>
 
68
<td>Public method to create and initialize the pysvn client object.</td>
 
69
</tr><tr>
 
70
<td><a href="#Subversion.svnBlame">svnBlame</a></td>
 
71
<td>Public method to show the output of the svn blame command.</td>
 
72
</tr><tr>
 
73
<td><a href="#Subversion.svnCopy">svnCopy</a></td>
 
74
<td>Public method used to copy a file/directory.</td>
 
75
</tr><tr>
 
76
<td><a href="#Subversion.svnDelProp">svnDelProp</a></td>
 
77
<td>Public method used to delete a property of a file/directory.</td>
 
78
</tr><tr>
 
79
<td><a href="#Subversion.svnExtendedDiff">svnExtendedDiff</a></td>
 
80
<td>Public method used to view the difference of a file/directory to the Subversion repository.</td>
 
81
</tr><tr>
 
82
<td><a href="#Subversion.svnGetReposName">svnGetReposName</a></td>
 
83
<td>Public method used to retrieve the URL of the subversion repository path.</td>
 
84
</tr><tr>
 
85
<td><a href="#Subversion.svnInfo">svnInfo</a></td>
 
86
<td>Public method to show repository information about a file or directory.</td>
 
87
</tr><tr>
 
88
<td><a href="#Subversion.svnListProps">svnListProps</a></td>
 
89
<td>Public method used to list the properties of a file/directory.</td>
 
90
</tr><tr>
 
91
<td><a href="#Subversion.svnListTagBranch">svnListTagBranch</a></td>
 
92
<td>Public method used to list the available tags or branches.</td>
 
93
</tr><tr>
 
94
<td><a href="#Subversion.svnLock">svnLock</a></td>
 
95
<td>Public method used to lock a file in the Subversion repository.</td>
 
96
</tr><tr>
 
97
<td><a href="#Subversion.svnLogLimited">svnLogLimited</a></td>
 
98
<td>Public method used to view the (limited) log of a file/directory from the Subversion repository.</td>
 
99
</tr><tr>
 
100
<td><a href="#Subversion.svnMove">svnMove</a></td>
 
101
<td>Public method used to move a file/directory.</td>
 
102
</tr><tr>
 
103
<td><a href="#Subversion.svnNormalizeURL">svnNormalizeURL</a></td>
 
104
<td>Public method to normalize a url for subversion.</td>
 
105
</tr><tr>
 
106
<td><a href="#Subversion.svnRelocate">svnRelocate</a></td>
 
107
<td>Public method to relocate the working copy to a new repository URL.</td>
 
108
</tr><tr>
 
109
<td><a href="#Subversion.svnResolve">svnResolve</a></td>
 
110
<td>Public method used to resolve conflicts of a file/directory.</td>
 
111
</tr><tr>
 
112
<td><a href="#Subversion.svnSetProp">svnSetProp</a></td>
 
113
<td>Public method used to add a property to a file/directory.</td>
 
114
</tr><tr>
 
115
<td><a href="#Subversion.svnUnlock">svnUnlock</a></td>
 
116
<td>Public method used to unlock a file in the Subversion repository.</td>
 
117
</tr><tr>
 
118
<td><a href="#Subversion.svnUrlDiff">svnUrlDiff</a></td>
 
119
<td>Public method used to view the difference of a file/directory of two repository URLs.</td>
 
120
</tr><tr>
 
121
<td><a href="#Subversion.vcsAdd">vcsAdd</a></td>
 
122
<td>Public method used to add a file/directory to the Subversion repository.</td>
 
123
</tr><tr>
 
124
<td><a href="#Subversion.vcsAddBinary">vcsAddBinary</a></td>
 
125
<td>Public method used to add a file/directory in binary mode to the Subversion repository.</td>
 
126
</tr><tr>
 
127
<td><a href="#Subversion.vcsAddTree">vcsAddTree</a></td>
 
128
<td>Public method to add a directory tree rooted at path to the Subversion repository.</td>
 
129
</tr><tr>
 
130
<td><a href="#Subversion.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
 
131
<td>Public method used to get the registered states of a number of files in the vcs.</td>
 
132
</tr><tr>
 
133
<td><a href="#Subversion.vcsCheckout">vcsCheckout</a></td>
 
134
<td>Public method used to check the project out of the Subversion repository.</td>
 
135
</tr><tr>
 
136
<td><a href="#Subversion.vcsCleanup">vcsCleanup</a></td>
 
137
<td>Public method used to cleanup the working copy.</td>
 
138
</tr><tr>
 
139
<td><a href="#Subversion.vcsCommandLine">vcsCommandLine</a></td>
 
140
<td>Public method used to execute arbitrary subversion commands.</td>
 
141
</tr><tr>
 
142
<td><a href="#Subversion.vcsCommit">vcsCommit</a></td>
 
143
<td>Public method used to make the change of a file/directory permanent in the Subversion repository.</td>
 
144
</tr><tr>
 
145
<td><a href="#Subversion.vcsConvertProject">vcsConvertProject</a></td>
 
146
<td>Public method to convert an uncontrolled project to a version controlled project.</td>
 
147
</tr><tr>
 
148
<td><a href="#Subversion.vcsDiff">vcsDiff</a></td>
 
149
<td>Public method used to view the difference of a file/directory to the Subversion repository.</td>
 
150
</tr><tr>
 
151
<td><a href="#Subversion.vcsExists">vcsExists</a></td>
 
152
<td>Public method used to test for the presence of the svn executable.</td>
 
153
</tr><tr>
 
154
<td><a href="#Subversion.vcsExport">vcsExport</a></td>
 
155
<td>Public method used to export a directory from the Subversion repository.</td>
 
156
</tr><tr>
 
157
<td><a href="#Subversion.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
 
158
<td>Public method to instanciate a helper object for the different project browsers.</td>
 
159
</tr><tr>
 
160
<td><a href="#Subversion.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
 
161
<td>Public method to instanciate a helper object for the project.</td>
 
162
</tr><tr>
 
163
<td><a href="#Subversion.vcsImport">vcsImport</a></td>
 
164
<td>Public method used to import the project into the Subversion repository.</td>
 
165
</tr><tr>
 
166
<td><a href="#Subversion.vcsInit">vcsInit</a></td>
 
167
<td>Public method used to initialize the subversion repository.</td>
 
168
</tr><tr>
 
169
<td><a href="#Subversion.vcsLog">vcsLog</a></td>
 
170
<td>Public method used to view the log of a file/directory from the Subversion repository.</td>
 
171
</tr><tr>
 
172
<td><a href="#Subversion.vcsMerge">vcsMerge</a></td>
 
173
<td>Public method used to merge a URL/revision into the local project.</td>
 
174
</tr><tr>
 
175
<td><a href="#Subversion.vcsName">vcsName</a></td>
 
176
<td>Public method returning the name of the vcs.</td>
 
177
</tr><tr>
 
178
<td><a href="#Subversion.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td>
 
179
<td>Public method to get a dialog to enter repository info for getting a new project.</td>
 
180
</tr><tr>
 
181
<td><a href="#Subversion.vcsOptionsDialog">vcsOptionsDialog</a></td>
 
182
<td>Public method to get a dialog to enter repository info.</td>
 
183
</tr><tr>
 
184
<td><a href="#Subversion.vcsRegisteredState">vcsRegisteredState</a></td>
 
185
<td>Public method used to get the registered state of a file in the vcs.</td>
 
186
</tr><tr>
 
187
<td><a href="#Subversion.vcsRemove">vcsRemove</a></td>
 
188
<td>Public method used to remove a file/directory from the Subversion repository.</td>
 
189
</tr><tr>
 
190
<td><a href="#Subversion.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
 
191
<td>Public method to retrieve information about the repository.</td>
 
192
</tr><tr>
 
193
<td><a href="#Subversion.vcsRevert">vcsRevert</a></td>
 
194
<td>Public method used to revert changes made to a file/directory.</td>
 
195
</tr><tr>
 
196
<td><a href="#Subversion.vcsShutdown">vcsShutdown</a></td>
 
197
<td>Public method used to shutdown the Subversion interface.</td>
 
198
</tr><tr>
 
199
<td><a href="#Subversion.vcsStatus">vcsStatus</a></td>
 
200
<td>Public method used to view the status of files/directories in the Subversion repository.</td>
 
201
</tr><tr>
 
202
<td><a href="#Subversion.vcsSwitch">vcsSwitch</a></td>
 
203
<td>Public method used to switch a directory to a different tag/branch.</td>
 
204
</tr><tr>
 
205
<td><a href="#Subversion.vcsTag">vcsTag</a></td>
 
206
<td>Public method used to set the tag of a file/directory in the Subversion repository.</td>
 
207
</tr><tr>
 
208
<td><a href="#Subversion.vcsUpdate">vcsUpdate</a></td>
 
209
<td>Public method used to update a file/directory with the Subversion repository.</td>
 
210
</tr>
 
211
</table>
 
212
<p><a NAME="Subversion.__init__" ID="Subversion.__init__"></a>
 
213
<h4>Subversion (Constructor)</h4>
 
214
<b>Subversion</b>(<i>parent=None, name=None</i>)
 
215
<p>
 
216
        Constructor
 
217
</p><dl>
 
218
<dt><i>parent</i></dt>
 
219
<dd>
 
220
parent widget (QWidget)
 
221
</dd><dt><i>name</i></dt>
 
222
<dd>
 
223
name of this object (string or QString)
 
224
</dd>
 
225
</dl><a NAME="Subversion.__svnURL" ID="Subversion.__svnURL"></a>
 
226
<h4>Subversion.__svnURL</h4>
 
227
<b>__svnURL</b>(<i>url</i>)
 
228
<p>
 
229
        Private method to format a url for subversion.
 
230
</p><dl>
 
231
<dt><i>url</i></dt>
 
232
<dd>
 
233
unformatted url string (string)
 
234
</dd>
 
235
</dl><dl>
 
236
<dt>Returns:</dt>
 
237
<dd>
 
238
properly formated url for subversion
 
239
</dd>
 
240
</dl><a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a>
 
241
<h4>Subversion.__vcsCommit_Step2</h4>
 
242
<b>__vcsCommit_Step2</b>(<i></i>)
 
243
<p>
 
244
        Private slot performing the second step of the commit action.
 
245
</p><a NAME="Subversion.clearStatusCache" ID="Subversion.clearStatusCache"></a>
 
246
<h4>Subversion.clearStatusCache</h4>
 
247
<b>clearStatusCache</b>(<i></i>)
 
248
<p>
 
249
        Public method to clear the status cache.
 
250
</p><a NAME="Subversion.getClient" ID="Subversion.getClient"></a>
 
251
<h4>Subversion.getClient</h4>
 
252
<b>getClient</b>(<i></i>)
 
253
<p>
 
254
        Public method to create and initialize the pysvn client object.
 
255
</p><dl>
 
256
<dt>Returns:</dt>
 
257
<dd>
 
258
the pysvn client object (pysvn.Client)
 
259
</dd>
 
260
</dl><a NAME="Subversion.svnBlame" ID="Subversion.svnBlame"></a>
 
261
<h4>Subversion.svnBlame</h4>
 
262
<b>svnBlame</b>(<i>name</i>)
 
263
<p>
 
264
        Public method to show the output of the svn blame command.
 
265
</p><dl>
 
266
<dt><i>name</i></dt>
 
267
<dd>
 
268
file name to show the blame for (string)
 
269
</dd>
 
270
</dl><a NAME="Subversion.svnCopy" ID="Subversion.svnCopy"></a>
 
271
<h4>Subversion.svnCopy</h4>
 
272
<b>svnCopy</b>(<i>name, project</i>)
 
273
<p>
 
274
        Public method used to copy a file/directory.
 
275
</p><dl>
 
276
<dt><i>name</i></dt>
 
277
<dd>
 
278
file/directory name to be copied (string)
 
279
</dd><dt><i>project</i></dt>
 
280
<dd>
 
281
reference to the project object
 
282
</dd>
 
283
</dl><dl>
 
284
<dt>Returns:</dt>
 
285
<dd>
 
286
flag indicating successfull operation (boolean)
 
287
</dd>
 
288
</dl><a NAME="Subversion.svnDelProp" ID="Subversion.svnDelProp"></a>
 
289
<h4>Subversion.svnDelProp</h4>
 
290
<b>svnDelProp</b>(<i>name, recursive = False</i>)
 
291
<p>
 
292
        Public method used to delete a property of a file/directory.
 
293
</p><dl>
 
294
<dt><i>name</i></dt>
 
295
<dd>
 
296
file/directory name (string or list of strings)
 
297
</dd><dt><i>recursive</i></dt>
 
298
<dd>
 
299
flag indicating a recursive list is requested
 
300
</dd>
 
301
</dl><a NAME="Subversion.svnExtendedDiff" ID="Subversion.svnExtendedDiff"></a>
 
302
<h4>Subversion.svnExtendedDiff</h4>
 
303
<b>svnExtendedDiff</b>(<i>name</i>)
 
304
<p>
 
305
        Public method used to view the difference of a file/directory to the 
 
306
        Subversion repository.
 
307
</p><p>
 
308
        If name is a directory and is the project directory, all project files
 
309
        are saved first. If name is a file (or list of files), which is/are being edited 
 
310
        and has unsaved modification, they can be saved or the operation may be aborted.
 
311
</p><p>
 
312
        This method gives the chance to enter the revisions to be compared.
 
313
</p><dl>
 
314
<dt><i>name</i></dt>
 
315
<dd>
 
316
file/directory name to be diffed (string)
 
317
</dd>
 
318
</dl><a NAME="Subversion.svnGetReposName" ID="Subversion.svnGetReposName"></a>
 
319
<h4>Subversion.svnGetReposName</h4>
 
320
<b>svnGetReposName</b>(<i>path</i>)
 
321
<p>
 
322
        Public method used to retrieve the URL of the subversion repository path.
 
323
</p><dl>
 
324
<dt><i>path</i></dt>
 
325
<dd>
 
326
local path to get the svn repository path for (string)
 
327
</dd>
 
328
</dl><dl>
 
329
<dt>Returns:</dt>
 
330
<dd>
 
331
string with the repository path URL
 
332
</dd>
 
333
</dl><a NAME="Subversion.svnInfo" ID="Subversion.svnInfo"></a>
 
334
<h4>Subversion.svnInfo</h4>
 
335
<b>svnInfo</b>(<i>projectPath, name</i>)
 
336
<p>
 
337
        Public method to show repository information about a file or directory.
 
338
</p><dl>
 
339
<dt><i>projectPath</i></dt>
 
340
<dd>
 
341
path name of the project (string)
 
342
</dd><dt><i>name</i></dt>
 
343
<dd>
 
344
file/directory name relative to the project (string)
 
345
</dd>
 
346
</dl><a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a>
 
347
<h4>Subversion.svnListProps</h4>
 
348
<b>svnListProps</b>(<i>name, recursive = False</i>)
 
349
<p>
 
350
        Public method used to list the properties of a file/directory.
 
351
</p><dl>
 
352
<dt><i>name</i></dt>
 
353
<dd>
 
354
file/directory name (string or list of strings)
 
355
</dd><dt><i>recursive</i></dt>
 
356
<dd>
 
357
flag indicating a recursive list is requested
 
358
</dd>
 
359
</dl><a NAME="Subversion.svnListTagBranch" ID="Subversion.svnListTagBranch"></a>
 
360
<h4>Subversion.svnListTagBranch</h4>
 
361
<b>svnListTagBranch</b>(<i>path, tags = True</i>)
 
362
<p>
 
363
        Public method used to list the available tags or branches.
 
364
</p><dl>
 
365
<dt><i>path</i></dt>
 
366
<dd>
 
367
directory name of the project (string)
 
368
</dd><dt><i>tags</i></dt>
 
369
<dd>
 
370
flag indicating listing of branches or tags
 
371
                (False = branches, True = tags)
 
372
</dd>
 
373
</dl><a NAME="Subversion.svnLock" ID="Subversion.svnLock"></a>
 
374
<h4>Subversion.svnLock</h4>
 
375
<b>svnLock</b>(<i>name, stealIt=False, parent=None</i>)
 
376
<p>
 
377
        Public method used to lock a file in the Subversion repository.
 
378
</p><dl>
 
379
<dt><i>name</i></dt>
 
380
<dd>
 
381
file/directory name to be locked (string or list of strings)
 
382
</dd><dt><i>stealIt</i></dt>
 
383
<dd>
 
384
flag indicating a forced operation (boolean)
 
385
</dd><dt><i>parent</i></dt>
 
386
<dd>
 
387
reference to the parent object of the subversion dialog (QWidget)
 
388
</dd>
 
389
</dl><a NAME="Subversion.svnLogLimited" ID="Subversion.svnLogLimited"></a>
 
390
<h4>Subversion.svnLogLimited</h4>
 
391
<b>svnLogLimited</b>(<i>name</i>)
 
392
<p>
 
393
        Public method used to view the (limited) log of a file/directory from the 
 
394
        Subversion repository.
 
395
</p><dl>
 
396
<dt><i>name</i></dt>
 
397
<dd>
 
398
file/directory name to show the log of (string)
 
399
</dd>
 
400
</dl><a NAME="Subversion.svnMove" ID="Subversion.svnMove"></a>
 
401
<h4>Subversion.svnMove</h4>
 
402
<b>svnMove</b>(<i>name, project</i>)
 
403
<p>
 
404
        Public method used to move a file/directory.
 
405
</p><dl>
 
406
<dt><i>name</i></dt>
 
407
<dd>
 
408
file/directory name to be moved (string)
 
409
</dd><dt><i>project</i></dt>
 
410
<dd>
 
411
reference to the project object
 
412
</dd>
 
413
</dl><dl>
 
414
<dt>Returns:</dt>
 
415
<dd>
 
416
flag indicating successfull operation (boolean)
 
417
</dd>
 
418
</dl><a NAME="Subversion.svnNormalizeURL" ID="Subversion.svnNormalizeURL"></a>
 
419
<h4>Subversion.svnNormalizeURL</h4>
 
420
<b>svnNormalizeURL</b>(<i>url</i>)
 
421
<p>
 
422
        Public method to normalize a url for subversion.
 
423
</p><dl>
 
424
<dt><i>url</i></dt>
 
425
<dd>
 
426
url string (string)
 
427
</dd>
 
428
</dl><dl>
 
429
<dt>Returns:</dt>
 
430
<dd>
 
431
properly normalized url for subversion
 
432
</dd>
 
433
</dl><a NAME="Subversion.svnRelocate" ID="Subversion.svnRelocate"></a>
 
434
<h4>Subversion.svnRelocate</h4>
 
435
<b>svnRelocate</b>(<i>projectPath</i>)
 
436
<p>
 
437
        Public method to relocate the working copy to a new repository URL.
 
438
</p><dl>
 
439
<dt><i>projectPath</i></dt>
 
440
<dd>
 
441
path name of the project (string)
 
442
</dd>
 
443
</dl><a NAME="Subversion.svnResolve" ID="Subversion.svnResolve"></a>
 
444
<h4>Subversion.svnResolve</h4>
 
445
<b>svnResolve</b>(<i>name</i>)
 
446
<p>
 
447
        Public method used to resolve conflicts of a file/directory.
 
448
</p><dl>
 
449
<dt><i>name</i></dt>
 
450
<dd>
 
451
file/directory name to be resolved (string)
 
452
</dd>
 
453
</dl><a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a>
 
454
<h4>Subversion.svnSetProp</h4>
 
455
<b>svnSetProp</b>(<i>name, recursive = False</i>)
 
456
<p>
 
457
        Public method used to add a property to a file/directory.
 
458
</p><dl>
 
459
<dt><i>name</i></dt>
 
460
<dd>
 
461
file/directory name (string or list of strings)
 
462
</dd><dt><i>recursive</i></dt>
 
463
<dd>
 
464
flag indicating a recursive set is requested
 
465
</dd>
 
466
</dl><a NAME="Subversion.svnUnlock" ID="Subversion.svnUnlock"></a>
 
467
<h4>Subversion.svnUnlock</h4>
 
468
<b>svnUnlock</b>(<i>name, breakIt=False, parent=None</i>)
 
469
<p>
 
470
        Public method used to unlock a file in the Subversion repository.
 
471
</p><dl>
 
472
<dt><i>name</i></dt>
 
473
<dd>
 
474
file/directory name to be unlocked (string or list of strings)
 
475
</dd><dt><i>breakIt</i></dt>
 
476
<dd>
 
477
flag indicating a forced operation (boolean)
 
478
</dd><dt><i>parent</i></dt>
 
479
<dd>
 
480
reference to the parent object of the subversion dialog (QWidget)
 
481
</dd>
 
482
</dl><a NAME="Subversion.svnUrlDiff" ID="Subversion.svnUrlDiff"></a>
 
483
<h4>Subversion.svnUrlDiff</h4>
 
484
<b>svnUrlDiff</b>(<i>name</i>)
 
485
<p>
 
486
        Public method used to view the difference of a file/directory of two
 
487
        repository URLs.
 
488
</p><p>
 
489
        If name is a directory and is the project directory, all project files
 
490
        are saved first. If name is a file (or list of files), which is/are being edited 
 
491
        and has unsaved modification, they can be saved or the operation may be aborted.
 
492
</p><p>
 
493
        This method gives the chance to enter the revisions to be compared.
 
494
</p><dl>
 
495
<dt><i>name</i></dt>
 
496
<dd>
 
497
file/directory name to be diffed (string)
 
498
</dd>
 
499
</dl><a NAME="Subversion.vcsAdd" ID="Subversion.vcsAdd"></a>
 
500
<h4>Subversion.vcsAdd</h4>
 
501
<b>vcsAdd</b>(<i>name, isDir = False</i>)
 
502
<p>
 
503
        Public method used to add a file/directory to the Subversion repository.
 
504
</p><dl>
 
505
<dt><i>name</i></dt>
 
506
<dd>
 
507
file/directory name to be added (string)
 
508
</dd><dt><i>isDir</i></dt>
 
509
<dd>
 
510
flag indicating name is a directory (boolean)
 
511
</dd>
 
512
</dl><a NAME="Subversion.vcsAddBinary" ID="Subversion.vcsAddBinary"></a>
 
513
<h4>Subversion.vcsAddBinary</h4>
 
514
<b>vcsAddBinary</b>(<i>name, isDir = False</i>)
 
515
<p>
 
516
        Public method used to add a file/directory in binary mode to the
 
517
        Subversion repository.
 
518
</p><dl>
 
519
<dt><i>name</i></dt>
 
520
<dd>
 
521
file/directory name to be added (string)
 
522
</dd><dt><i>isDir</i></dt>
 
523
<dd>
 
524
flag indicating name is a directory (boolean)
 
525
</dd>
 
526
</dl><a NAME="Subversion.vcsAddTree" ID="Subversion.vcsAddTree"></a>
 
527
<h4>Subversion.vcsAddTree</h4>
 
528
<b>vcsAddTree</b>(<i>path</i>)
 
529
<p>
 
530
        Public method to add a directory tree rooted at path to the Subversion repository.
 
531
</p><dl>
 
532
<dt><i>path</i></dt>
 
533
<dd>
 
534
root directory of the tree to be added (string or list of strings))
 
535
</dd>
 
536
</dl><a NAME="Subversion.vcsAllRegisteredStates" ID="Subversion.vcsAllRegisteredStates"></a>
 
537
<h4>Subversion.vcsAllRegisteredStates</h4>
 
538
<b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut = True</i>)
 
539
<p>
 
540
        Public method used to get the registered states of a number of files in the vcs.
 
541
</p><p>
 
542
        <b>Note:</b> If a shortcut is to be taken, the code will only check, if the named
 
543
        directory has been scanned already. If so, it is assumed, that the states for
 
544
        all files has been populated by the previous run.
 
545
</p><dl>
 
546
<dt><i>names</i></dt>
 
547
<dd>
 
548
dictionary with all filenames to be checked as keys
 
549
</dd><dt><i>dname</i></dt>
 
550
<dd>
 
551
directory to check in (string)
 
552
</dd><dt><i>shortcut</i></dt>
 
553
<dd>
 
554
flag indicating a shortcut should be taken (boolean)
 
555
</dd>
 
556
</dl><dl>
 
557
<dt>Returns:</dt>
 
558
<dd>
 
559
the received dictionary completed with a combination of
 
560
            canBeCommited and canBeAdded or None in order to signal an error
 
561
</dd>
 
562
</dl><a NAME="Subversion.vcsCheckout" ID="Subversion.vcsCheckout"></a>
 
563
<h4>Subversion.vcsCheckout</h4>
 
564
<b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog = False</i>)
 
565
<p>
 
566
        Public method used to check the project out of the Subversion repository.
 
567
</p><dl>
 
568
<dt><i>vcsDataDict</i></dt>
 
569
<dd>
 
570
dictionary of data required for the checkout
 
571
</dd><dt><i>projectDir</i></dt>
 
572
<dd>
 
573
project directory to create (string)
 
574
</dd><dt><i>noDialog</i></dt>
 
575
<dd>
 
576
flag indicating quiet operations
 
577
</dd>
 
578
</dl><dl>
 
579
<dt>Returns:</dt>
 
580
<dd>
 
581
flag indicating an execution without errors (boolean)
 
582
</dd>
 
583
</dl><a NAME="Subversion.vcsCleanup" ID="Subversion.vcsCleanup"></a>
 
584
<h4>Subversion.vcsCleanup</h4>
 
585
<b>vcsCleanup</b>(<i>name</i>)
 
586
<p>
 
587
        Public method used to cleanup the working copy.
 
588
</p><dl>
 
589
<dt><i>name</i></dt>
 
590
<dd>
 
591
directory name to be cleaned up (string)
 
592
</dd>
 
593
</dl><a NAME="Subversion.vcsCommandLine" ID="Subversion.vcsCommandLine"></a>
 
594
<h4>Subversion.vcsCommandLine</h4>
 
595
<b>vcsCommandLine</b>(<i>name</i>)
 
596
<p>
 
597
        Public method used to execute arbitrary subversion commands.
 
598
</p><dl>
 
599
<dt><i>name</i></dt>
 
600
<dd>
 
601
directory name of the working directory (string)
 
602
</dd>
 
603
</dl><a NAME="Subversion.vcsCommit" ID="Subversion.vcsCommit"></a>
 
604
<h4>Subversion.vcsCommit</h4>
 
605
<b>vcsCommit</b>(<i>name, message, noDialog = False</i>)
 
606
<p>
 
607
        Public method used to make the change of a file/directory permanent in the
 
608
        Subversion repository.
 
609
</p><dl>
 
610
<dt><i>name</i></dt>
 
611
<dd>
 
612
file/directory name to be committed (string or list of strings)
 
613
</dd><dt><i>message</i></dt>
 
614
<dd>
 
615
message for this operation (string)
 
616
</dd><dt><i>noDialog</i></dt>
 
617
<dd>
 
618
flag indicating quiet operations
 
619
</dd>
 
620
</dl><a NAME="Subversion.vcsConvertProject" ID="Subversion.vcsConvertProject"></a>
 
621
<h4>Subversion.vcsConvertProject</h4>
 
622
<b>vcsConvertProject</b>(<i>vcsDataDict, project</i>)
 
623
<p>
 
624
        Public method to convert an uncontrolled project to a version controlled project.
 
625
</p><dl>
 
626
<dt><i>vcsDataDict</i></dt>
 
627
<dd>
 
628
dictionary of data required for the conversion
 
629
</dd><dt><i>project</i></dt>
 
630
<dd>
 
631
reference to the project object
 
632
</dd>
 
633
</dl><a NAME="Subversion.vcsDiff" ID="Subversion.vcsDiff"></a>
 
634
<h4>Subversion.vcsDiff</h4>
 
635
<b>vcsDiff</b>(<i>name</i>)
 
636
<p>
 
637
        Public method used to view the difference of a file/directory to the 
 
638
        Subversion repository.
 
639
</p><p>
 
640
        If name is a directory and is the project directory, all project files
 
641
        are saved first. If name is a file (or list of files), which is/are being edited 
 
642
        and has unsaved modification, they can be saved or the operation may be aborted.
 
643
</p><dl>
 
644
<dt><i>name</i></dt>
 
645
<dd>
 
646
file/directory name to be diffed (string)
 
647
</dd>
 
648
</dl><a NAME="Subversion.vcsExists" ID="Subversion.vcsExists"></a>
 
649
<h4>Subversion.vcsExists</h4>
 
650
<b>vcsExists</b>(<i></i>)
 
651
<p>
 
652
        Public method used to test for the presence of the svn executable.
 
653
</p><dl>
 
654
<dt>Returns:</dt>
 
655
<dd>
 
656
flag indicating the existance (boolean)
 
657
</dd>
 
658
</dl><a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a>
 
659
<h4>Subversion.vcsExport</h4>
 
660
<b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
 
661
<p>
 
662
        Public method used to export a directory from the Subversion repository.
 
663
</p><dl>
 
664
<dt><i>vcsDataDict</i></dt>
 
665
<dd>
 
666
dictionary of data required for the checkout
 
667
</dd><dt><i>projectDir</i></dt>
 
668
<dd>
 
669
project directory to create (string)
 
670
</dd>
 
671
</dl><dl>
 
672
<dt>Returns:</dt>
 
673
<dd>
 
674
flag indicating an execution without errors (boolean)
 
675
</dd>
 
676
</dl><a NAME="Subversion.vcsGetProjectBrowserHelper" ID="Subversion.vcsGetProjectBrowserHelper"></a>
 
677
<h4>Subversion.vcsGetProjectBrowserHelper</h4>
 
678
<b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser = False</i>)
 
679
<p>
 
680
        Public method to instanciate a helper object for the different project browsers.
 
681
</p><dl>
 
682
<dt><i>browser</i></dt>
 
683
<dd>
 
684
reference to the project browser object
 
685
</dd><dt><i>project</i></dt>
 
686
<dd>
 
687
reference to the project object
 
688
</dd><dt><i>isTranslationsBrowser</i></dt>
 
689
<dd>
 
690
flag indicating, the helper is requested for the
 
691
            translations browser (this needs some special treatment)
 
692
</dd>
 
693
</dl><dl>
 
694
<dt>Returns:</dt>
 
695
<dd>
 
696
the project browser helper object
 
697
</dd>
 
698
</dl><a NAME="Subversion.vcsGetProjectHelper" ID="Subversion.vcsGetProjectHelper"></a>
 
699
<h4>Subversion.vcsGetProjectHelper</h4>
 
700
<b>vcsGetProjectHelper</b>(<i>project</i>)
 
701
<p>
 
702
        Public method to instanciate a helper object for the project.
 
703
</p><dl>
 
704
<dt><i>project</i></dt>
 
705
<dd>
 
706
reference to the project object
 
707
</dd>
 
708
</dl><dl>
 
709
<dt>Returns:</dt>
 
710
<dd>
 
711
the project helper object
 
712
</dd>
 
713
</dl><a NAME="Subversion.vcsImport" ID="Subversion.vcsImport"></a>
 
714
<h4>Subversion.vcsImport</h4>
 
715
<b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog = False</i>)
 
716
<p>
 
717
        Public method used to import the project into the Subversion repository.
 
718
</p><dl>
 
719
<dt><i>vcsDataDict</i></dt>
 
720
<dd>
 
721
dictionary of data required for the import
 
722
</dd><dt><i>projectDir</i></dt>
 
723
<dd>
 
724
project directory (string)
 
725
</dd><dt><i>noDialog</i></dt>
 
726
<dd>
 
727
flag indicating quiet operations
 
728
</dd>
 
729
</dl><dl>
 
730
<dt>Returns:</dt>
 
731
<dd>
 
732
flag indicating an execution without errors (boolean)
 
733
            and a flag indicating the version controll status (boolean)
 
734
</dd>
 
735
</dl><a NAME="Subversion.vcsInit" ID="Subversion.vcsInit"></a>
 
736
<h4>Subversion.vcsInit</h4>
 
737
<b>vcsInit</b>(<i>vcsDir, noDialog = False</i>)
 
738
<p>
 
739
        Public method used to initialize the subversion repository.
 
740
</p><p>
 
741
        The subversion repository has to be initialized from outside eric4
 
742
        because the respective command always works locally. Therefore we
 
743
        always return TRUE without doing anything.
 
744
</p><dl>
 
745
<dt><i>vcsDir</i></dt>
 
746
<dd>
 
747
name of the VCS directory (string)
 
748
</dd><dt><i>noDialog</i></dt>
 
749
<dd>
 
750
flag indicating quiet operations (boolean)
 
751
</dd>
 
752
</dl><dl>
 
753
<dt>Returns:</dt>
 
754
<dd>
 
755
always TRUE
 
756
</dd>
 
757
</dl><a NAME="Subversion.vcsLog" ID="Subversion.vcsLog"></a>
 
758
<h4>Subversion.vcsLog</h4>
 
759
<b>vcsLog</b>(<i>name</i>)
 
760
<p>
 
761
        Public method used to view the log of a file/directory from the 
 
762
        Subversion repository.
 
763
</p><dl>
 
764
<dt><i>name</i></dt>
 
765
<dd>
 
766
file/directory name to show the log of (string)
 
767
</dd>
 
768
</dl><a NAME="Subversion.vcsMerge" ID="Subversion.vcsMerge"></a>
 
769
<h4>Subversion.vcsMerge</h4>
 
770
<b>vcsMerge</b>(<i>name</i>)
 
771
<p>
 
772
        Public method used to merge a URL/revision into the local project.
 
773
</p><dl>
 
774
<dt><i>name</i></dt>
 
775
<dd>
 
776
file/directory name to be merged (string)
 
777
</dd>
 
778
</dl><a NAME="Subversion.vcsName" ID="Subversion.vcsName"></a>
 
779
<h4>Subversion.vcsName</h4>
 
780
<b>vcsName</b>(<i></i>)
 
781
<p>
 
782
        Public method returning the name of the vcs.
 
783
</p><dl>
 
784
<dt>Returns:</dt>
 
785
<dd>
 
786
always 'Subversion' (string)
 
787
</dd>
 
788
</dl><a NAME="Subversion.vcsNewProjectOptionsDialog" ID="Subversion.vcsNewProjectOptionsDialog"></a>
 
789
<h4>Subversion.vcsNewProjectOptionsDialog</h4>
 
790
<b>vcsNewProjectOptionsDialog</b>(<i>parent = None</i>)
 
791
<p>
 
792
        Public method to get a dialog to enter repository info for getting a new project.
 
793
</p><dl>
 
794
<dt><i>parent</i></dt>
 
795
<dd>
 
796
parent widget (QWidget)
 
797
</dd>
 
798
</dl><a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a>
 
799
<h4>Subversion.vcsOptionsDialog</h4>
 
800
<b>vcsOptionsDialog</b>(<i>project, archive, editable = False, parent = None</i>)
 
801
<p>
 
802
        Public method to get a dialog to enter repository info.
 
803
</p><dl>
 
804
<dt><i>project</i></dt>
 
805
<dd>
 
806
reference to the project object
 
807
</dd><dt><i>archive</i></dt>
 
808
<dd>
 
809
name of the project in the repository (string)
 
810
</dd><dt><i>editable</i></dt>
 
811
<dd>
 
812
flag indicating that the project name is editable (boolean)
 
813
</dd><dt><i>parent</i></dt>
 
814
<dd>
 
815
parent widget (QWidget)
 
816
</dd>
 
817
</dl><a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a>
 
818
<h4>Subversion.vcsRegisteredState</h4>
 
819
<b>vcsRegisteredState</b>(<i>name</i>)
 
820
<p>
 
821
        Public method used to get the registered state of a file in the vcs.
 
822
</p><dl>
 
823
<dt><i>name</i></dt>
 
824
<dd>
 
825
filename to check (string or QString)
 
826
</dd>
 
827
</dl><dl>
 
828
<dt>Returns:</dt>
 
829
<dd>
 
830
a combination of canBeCommited and canBeAdded
 
831
</dd>
 
832
</dl><a NAME="Subversion.vcsRemove" ID="Subversion.vcsRemove"></a>
 
833
<h4>Subversion.vcsRemove</h4>
 
834
<b>vcsRemove</b>(<i>name, project=0</i>)
 
835
<p>
 
836
        Public method used to remove a file/directory from the Subversion repository.
 
837
</p><p>
 
838
        The default operation is to remove the local copy as well.
 
839
</p><dl>
 
840
<dt><i>name</i></dt>
 
841
<dd>
 
842
file/directory name to be removed (string or list of strings))
 
843
</dd><dt><i>project</i></dt>
 
844
<dd>
 
845
flag indicating deletion of a project tree (boolean) (not needed)
 
846
</dd>
 
847
</dl><dl>
 
848
<dt>Returns:</dt>
 
849
<dd>
 
850
flag indicating successfull operation (boolean)
 
851
</dd>
 
852
</dl><a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a>
 
853
<h4>Subversion.vcsRepositoryInfos</h4>
 
854
<b>vcsRepositoryInfos</b>(<i>ppath</i>)
 
855
<p>
 
856
        Public method to retrieve information about the repository.
 
857
</p><dl>
 
858
<dt><i>ppath</i></dt>
 
859
<dd>
 
860
local path to get the repository infos (string)
 
861
</dd>
 
862
</dl><dl>
 
863
<dt>Returns:</dt>
 
864
<dd>
 
865
string with ready formated info for display (QString)
 
866
</dd>
 
867
</dl><a NAME="Subversion.vcsRevert" ID="Subversion.vcsRevert"></a>
 
868
<h4>Subversion.vcsRevert</h4>
 
869
<b>vcsRevert</b>(<i>name</i>)
 
870
<p>
 
871
        Public method used to revert changes made to a file/directory.
 
872
</p><dl>
 
873
<dt><i>name</i></dt>
 
874
<dd>
 
875
file/directory name to be reverted (string)
 
876
</dd>
 
877
</dl><a NAME="Subversion.vcsShutdown" ID="Subversion.vcsShutdown"></a>
 
878
<h4>Subversion.vcsShutdown</h4>
 
879
<b>vcsShutdown</b>(<i></i>)
 
880
<p>
 
881
        Public method used to shutdown the Subversion interface.
 
882
</p><a NAME="Subversion.vcsStatus" ID="Subversion.vcsStatus"></a>
 
883
<h4>Subversion.vcsStatus</h4>
 
884
<b>vcsStatus</b>(<i>name</i>)
 
885
<p>
 
886
        Public method used to view the status of files/directories in the 
 
887
        Subversion repository.
 
888
</p><dl>
 
889
<dt><i>name</i></dt>
 
890
<dd>
 
891
file/directory name(s) to show the status of
 
892
            (string or list of strings)
 
893
</dd>
 
894
</dl><a NAME="Subversion.vcsSwitch" ID="Subversion.vcsSwitch"></a>
 
895
<h4>Subversion.vcsSwitch</h4>
 
896
<b>vcsSwitch</b>(<i>name</i>)
 
897
<p>
 
898
        Public method used to switch a directory to a different tag/branch.
 
899
</p><dl>
 
900
<dt><i>name</i></dt>
 
901
<dd>
 
902
directory name to be switched (string)
 
903
</dd>
 
904
</dl><a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a>
 
905
<h4>Subversion.vcsTag</h4>
 
906
<b>vcsTag</b>(<i>name</i>)
 
907
<p>
 
908
        Public method used to set the tag of a file/directory in the 
 
909
        Subversion repository.
 
910
</p><dl>
 
911
<dt><i>name</i></dt>
 
912
<dd>
 
913
file/directory name to be tagged (string)
 
914
</dd>
 
915
</dl><a NAME="Subversion.vcsUpdate" ID="Subversion.vcsUpdate"></a>
 
916
<h4>Subversion.vcsUpdate</h4>
 
917
<b>vcsUpdate</b>(<i>name</i>)
 
918
<p>
 
919
        Public method used to update a file/directory with the Subversion repository.
 
920
</p><dl>
 
921
<dt><i>name</i></dt>
 
922
<dd>
 
923
file/directory name to be updated (string or list of strings)
 
924
</dd>
 
925
</dl></p>
 
926
<div align="right"><a href="#top">Up</a></div>
 
927
<hr />
 
928
</body></html>
 
 
b'\\ No newline at end of file'