Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Plugins.VcsPlugins.vcsSubversion.subversion.html

Documentation/Source/eric4.Plugins.VcsPlugins.vcsSubversion.subversion.html

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

Mercurial Repository: eric

eric ide

mercurial