Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsPySvn.subversion</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsPySvn.subversion</h1>
24
25 <p>
26 Module implementing the version control systems interface to Subversion.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#Subversion">Subversion</a></td>
39 <td>Class implementing the version control systems interface to Subversion.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="Subversion" ID="Subversion"></a>
50 <h2>Subversion</h2>
51
52 <p>
53 Class implementing the version control systems interface to Subversion.
54 </p>
55 <h3>Signals</h3>
56 <dl>
57
58 <dt>committed()</dt>
59 <dd>
60 emitted after the commit action has completed
61 </dd>
62 </dl>
63 <h3>Derived from</h3>
64 VersionControl
65 <h3>Class Attributes</h3>
66
67 <table>
68 <tr><td>None</td></tr>
69 </table>
70 <h3>Class Methods</h3>
71
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Methods</h3>
76
77 <table>
78
79 <tr>
80 <td><a href="#Subversion.__init__">Subversion</a></td>
81 <td>Constructor</td>
82 </tr>
83 <tr>
84 <td><a href="#Subversion.__isVersioned">__isVersioned</a></td>
85 <td>Private method to check, if the given status indicates a versioned state.</td>
86 </tr>
87 <tr>
88 <td><a href="#Subversion.__svnGetFileForRevision">__svnGetFileForRevision</a></td>
89 <td>Private method to get a file for a specific revision from the repository.</td>
90 </tr>
91 <tr>
92 <td><a href="#Subversion.__svnURL">__svnURL</a></td>
93 <td>Private method to format a url for subversion.</td>
94 </tr>
95 <tr>
96 <td><a href="#Subversion.__vcsAllRegisteredStates_wc">__vcsAllRegisteredStates_wc</a></td>
97 <td>Private method used to get the registered states of a number of files in the VCS.</td>
98 </tr>
99 <tr>
100 <td><a href="#Subversion.__vcsAllRegisteredStates_wcng">__vcsAllRegisteredStates_wcng</a></td>
101 <td>Private method used to get the registered states of a number of files in the vcs.</td>
102 </tr>
103 <tr>
104 <td><a href="#Subversion.__vcsCommit_Step2">__vcsCommit_Step2</a></td>
105 <td>Private slot performing the second step of the commit action.</td>
106 </tr>
107 <tr>
108 <td><a href="#Subversion.__vcsRegisteredState_wc">__vcsRegisteredState_wc</a></td>
109 <td>Private method used to get the registered state of a file in the vcs.</td>
110 </tr>
111 <tr>
112 <td><a href="#Subversion.__vcsRegisteredState_wcng">__vcsRegisteredState_wcng</a></td>
113 <td>Private method used to get the registered state of a file in the vcs.</td>
114 </tr>
115 <tr>
116 <td><a href="#Subversion._createStatusMonitorThread">_createStatusMonitorThread</a></td>
117 <td>Protected method to create an instance of the VCS status monitor thread.</td>
118 </tr>
119 <tr>
120 <td><a href="#Subversion.clearStatusCache">clearStatusCache</a></td>
121 <td>Public method to clear the status cache.</td>
122 </tr>
123 <tr>
124 <td><a href="#Subversion.getClient">getClient</a></td>
125 <td>Public method to create and initialize the pysvn client object.</td>
126 </tr>
127 <tr>
128 <td><a href="#Subversion.getPlugin">getPlugin</a></td>
129 <td>Public method to get a reference to the plugin object.</td>
130 </tr>
131 <tr>
132 <td><a href="#Subversion.svnAddToChangelist">svnAddToChangelist</a></td>
133 <td>Public method to add a file or directory to a changelist.</td>
134 </tr>
135 <tr>
136 <td><a href="#Subversion.svnBlame">svnBlame</a></td>
137 <td>Public method to show the output of the svn blame command.</td>
138 </tr>
139 <tr>
140 <td><a href="#Subversion.svnCopy">svnCopy</a></td>
141 <td>Public method used to copy a file/directory.</td>
142 </tr>
143 <tr>
144 <td><a href="#Subversion.svnDelProp">svnDelProp</a></td>
145 <td>Public method used to delete a property of a file/directory.</td>
146 </tr>
147 <tr>
148 <td><a href="#Subversion.svnExtendedDiff">svnExtendedDiff</a></td>
149 <td>Public method used to view the difference of a file/directory to the Subversion repository.</td>
150 </tr>
151 <tr>
152 <td><a href="#Subversion.svnGetChangelists">svnGetChangelists</a></td>
153 <td>Public method to get a list of all defined change lists.</td>
154 </tr>
155 <tr>
156 <td><a href="#Subversion.svnGetReposName">svnGetReposName</a></td>
157 <td>Public method used to retrieve the URL of the subversion repository path.</td>
158 </tr>
159 <tr>
160 <td><a href="#Subversion.svnInfo">svnInfo</a></td>
161 <td>Public method to show repository information about a file or directory.</td>
162 </tr>
163 <tr>
164 <td><a href="#Subversion.svnListProps">svnListProps</a></td>
165 <td>Public method used to list the properties of a file/directory.</td>
166 </tr>
167 <tr>
168 <td><a href="#Subversion.svnListTagBranch">svnListTagBranch</a></td>
169 <td>Public method used to list the available tags or branches.</td>
170 </tr>
171 <tr>
172 <td><a href="#Subversion.svnLock">svnLock</a></td>
173 <td>Public method used to lock a file in the Subversion repository.</td>
174 </tr>
175 <tr>
176 <td><a href="#Subversion.svnNormalizeURL">svnNormalizeURL</a></td>
177 <td>Public method to normalize a url for subversion.</td>
178 </tr>
179 <tr>
180 <td><a href="#Subversion.svnRelocate">svnRelocate</a></td>
181 <td>Public method to relocate the working copy to a new repository URL.</td>
182 </tr>
183 <tr>
184 <td><a href="#Subversion.svnRemoveFromChangelist">svnRemoveFromChangelist</a></td>
185 <td>Public method to remove a file or directory from its changelist.</td>
186 </tr>
187 <tr>
188 <td><a href="#Subversion.svnRepoBrowser">svnRepoBrowser</a></td>
189 <td>Public method to open the repository browser.</td>
190 </tr>
191 <tr>
192 <td><a href="#Subversion.svnResolve">svnResolve</a></td>
193 <td>Public method used to resolve conflicts of a file/directory.</td>
194 </tr>
195 <tr>
196 <td><a href="#Subversion.svnSbsDiff">svnSbsDiff</a></td>
197 <td>Public method used to view the difference of a file to the Mercurial repository side-by-side.</td>
198 </tr>
199 <tr>
200 <td><a href="#Subversion.svnSetProp">svnSetProp</a></td>
201 <td>Public method used to add a property to a file/directory.</td>
202 </tr>
203 <tr>
204 <td><a href="#Subversion.svnShowChangelists">svnShowChangelists</a></td>
205 <td>Public method used to inspect the change lists defined for the project.</td>
206 </tr>
207 <tr>
208 <td><a href="#Subversion.svnUnlock">svnUnlock</a></td>
209 <td>Public method used to unlock a file in the Subversion repository.</td>
210 </tr>
211 <tr>
212 <td><a href="#Subversion.svnUpgrade">svnUpgrade</a></td>
213 <td>Public method to upgrade the working copy format.</td>
214 </tr>
215 <tr>
216 <td><a href="#Subversion.svnUrlDiff">svnUrlDiff</a></td>
217 <td>Public method used to view the difference of a file/directory of two repository URLs.</td>
218 </tr>
219 <tr>
220 <td><a href="#Subversion.vcsAdd">vcsAdd</a></td>
221 <td>Public method used to add a file/directory to the Subversion repository.</td>
222 </tr>
223 <tr>
224 <td><a href="#Subversion.vcsAddBinary">vcsAddBinary</a></td>
225 <td>Public method used to add a file/directory in binary mode to the Subversion repository.</td>
226 </tr>
227 <tr>
228 <td><a href="#Subversion.vcsAddTree">vcsAddTree</a></td>
229 <td>Public method to add a directory tree rooted at path to the Subversion repository.</td>
230 </tr>
231 <tr>
232 <td><a href="#Subversion.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
233 <td>Public method used to get the registered states of a number of files in the vcs.</td>
234 </tr>
235 <tr>
236 <td><a href="#Subversion.vcsCheckout">vcsCheckout</a></td>
237 <td>Public method used to check the project out of the Subversion repository.</td>
238 </tr>
239 <tr>
240 <td><a href="#Subversion.vcsCleanup">vcsCleanup</a></td>
241 <td>Public method used to cleanup the working copy.</td>
242 </tr>
243 <tr>
244 <td><a href="#Subversion.vcsCommandLine">vcsCommandLine</a></td>
245 <td>Public method used to execute arbitrary subversion commands.</td>
246 </tr>
247 <tr>
248 <td><a href="#Subversion.vcsCommit">vcsCommit</a></td>
249 <td>Public method used to make the change of a file/directory permanent in the Subversion repository.</td>
250 </tr>
251 <tr>
252 <td><a href="#Subversion.vcsConvertProject">vcsConvertProject</a></td>
253 <td>Public method to convert an uncontrolled project to a version controlled project.</td>
254 </tr>
255 <tr>
256 <td><a href="#Subversion.vcsDiff">vcsDiff</a></td>
257 <td>Public method used to view the difference of a file/directory to the Subversion repository.</td>
258 </tr>
259 <tr>
260 <td><a href="#Subversion.vcsExists">vcsExists</a></td>
261 <td>Public method used to test for the presence of the svn executable.</td>
262 </tr>
263 <tr>
264 <td><a href="#Subversion.vcsExport">vcsExport</a></td>
265 <td>Public method used to export a directory from the Subversion repository.</td>
266 </tr>
267 <tr>
268 <td><a href="#Subversion.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
269 <td>Public method to instanciate a helper object for the different project browsers.</td>
270 </tr>
271 <tr>
272 <td><a href="#Subversion.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
273 <td>Public method to instanciate a helper object for the project.</td>
274 </tr>
275 <tr>
276 <td><a href="#Subversion.vcsImport">vcsImport</a></td>
277 <td>Public method used to import the project into the Subversion repository.</td>
278 </tr>
279 <tr>
280 <td><a href="#Subversion.vcsInit">vcsInit</a></td>
281 <td>Public method used to initialize the subversion repository.</td>
282 </tr>
283 <tr>
284 <td><a href="#Subversion.vcsInitConfig">vcsInitConfig</a></td>
285 <td>Public method to initialize the VCS configuration.</td>
286 </tr>
287 <tr>
288 <td><a href="#Subversion.vcsLogBrowser">vcsLogBrowser</a></td>
289 <td>Public method used to browse the log of a file/directory from the Subversion repository.</td>
290 </tr>
291 <tr>
292 <td><a href="#Subversion.vcsMerge">vcsMerge</a></td>
293 <td>Public method used to merge a URL/revision into the local project.</td>
294 </tr>
295 <tr>
296 <td><a href="#Subversion.vcsMove">vcsMove</a></td>
297 <td>Public method used to move a file/directory.</td>
298 </tr>
299 <tr>
300 <td><a href="#Subversion.vcsName">vcsName</a></td>
301 <td>Public method returning the name of the vcs.</td>
302 </tr>
303 <tr>
304 <td><a href="#Subversion.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td>
305 <td>Public method to get a dialog to enter repository info for getting a new project.</td>
306 </tr>
307 <tr>
308 <td><a href="#Subversion.vcsOptionsDialog">vcsOptionsDialog</a></td>
309 <td>Public method to get a dialog to enter repository info.</td>
310 </tr>
311 <tr>
312 <td><a href="#Subversion.vcsRegisteredState">vcsRegisteredState</a></td>
313 <td>Public method used to get the registered state of a file in the vcs.</td>
314 </tr>
315 <tr>
316 <td><a href="#Subversion.vcsRemove">vcsRemove</a></td>
317 <td>Public method used to remove a file/directory from the Subversion repository.</td>
318 </tr>
319 <tr>
320 <td><a href="#Subversion.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
321 <td>Public method to retrieve information about the repository.</td>
322 </tr>
323 <tr>
324 <td><a href="#Subversion.vcsRevert">vcsRevert</a></td>
325 <td>Public method used to revert changes made to a file/directory.</td>
326 </tr>
327 <tr>
328 <td><a href="#Subversion.vcsShutdown">vcsShutdown</a></td>
329 <td>Public method used to shutdown the Subversion interface.</td>
330 </tr>
331 <tr>
332 <td><a href="#Subversion.vcsStatus">vcsStatus</a></td>
333 <td>Public method used to view the status of files/directories in the Subversion repository.</td>
334 </tr>
335 <tr>
336 <td><a href="#Subversion.vcsSwitch">vcsSwitch</a></td>
337 <td>Public method used to switch a directory to a different tag/branch.</td>
338 </tr>
339 <tr>
340 <td><a href="#Subversion.vcsTag">vcsTag</a></td>
341 <td>Public method used to set the tag of a file/directory in the Subversion repository.</td>
342 </tr>
343 <tr>
344 <td><a href="#Subversion.vcsUpdate">vcsUpdate</a></td>
345 <td>Public method used to update a file/directory with the Subversion repository.</td>
346 </tr>
347 </table>
348 <h3>Static Methods</h3>
349
350 <table>
351 <tr><td>None</td></tr>
352 </table>
353
354 <a NAME="Subversion.__init__" ID="Subversion.__init__"></a>
355 <h4>Subversion (Constructor)</h4>
356 <b>Subversion</b>(<i>plugin, parent=None, name=None</i>)
357
358 <p>
359 Constructor
360 </p>
361 <dl>
362
363 <dt><i>plugin</i></dt>
364 <dd>
365 reference to the plugin object
366 </dd>
367 <dt><i>parent</i></dt>
368 <dd>
369 parent widget (QWidget)
370 </dd>
371 <dt><i>name</i></dt>
372 <dd>
373 name of this object (string)
374 </dd>
375 </dl>
376 <a NAME="Subversion.__isVersioned" ID="Subversion.__isVersioned"></a>
377 <h4>Subversion.__isVersioned</h4>
378 <b>__isVersioned</b>(<i>status</i>)
379
380 <p>
381 Private method to check, if the given status indicates a
382 versioned state.
383 </p>
384 <dl>
385
386 <dt><i>status</i></dt>
387 <dd>
388 status object to check (pysvn.PysvnStatus)
389 </dd>
390 </dl>
391 <dl>
392 <dt>Return:</dt>
393 <dd>
394 flag indicating a versioned state (boolean)
395 </dd>
396 </dl>
397 <a NAME="Subversion.__svnGetFileForRevision" ID="Subversion.__svnGetFileForRevision"></a>
398 <h4>Subversion.__svnGetFileForRevision</h4>
399 <b>__svnGetFileForRevision</b>(<i>name, rev=""</i>)
400
401 <p>
402 Private method to get a file for a specific revision from the
403 repository.
404 </p>
405 <dl>
406
407 <dt><i>name</i></dt>
408 <dd>
409 file name to get from the repository (string)
410 </dd>
411 <dt><i>rev</i></dt>
412 <dd>
413 revision to retrieve (integer or string)
414 </dd>
415 </dl>
416 <dl>
417 <dt>Return:</dt>
418 <dd>
419 contents of the file (string) and an error message (string)
420 </dd>
421 </dl>
422 <a NAME="Subversion.__svnURL" ID="Subversion.__svnURL"></a>
423 <h4>Subversion.__svnURL</h4>
424 <b>__svnURL</b>(<i>url</i>)
425
426 <p>
427 Private method to format a url for subversion.
428 </p>
429 <dl>
430
431 <dt><i>url</i></dt>
432 <dd>
433 unformatted url string (string)
434 </dd>
435 </dl>
436 <dl>
437 <dt>Return:</dt>
438 <dd>
439 properly formated url for subversion (string)
440 </dd>
441 </dl>
442 <a NAME="Subversion.__vcsAllRegisteredStates_wc" ID="Subversion.__vcsAllRegisteredStates_wc"></a>
443 <h4>Subversion.__vcsAllRegisteredStates_wc</h4>
444 <b>__vcsAllRegisteredStates_wc</b>(<i>names, dname, shortcut=True</i>)
445
446 <p>
447 Private method used to get the registered states of a number of files
448 in the VCS.
449 </p>
450 <p>
451 This is the variant for subversion installations using the old working
452 copy meta-data format.
453 </p>
454 <p>
455 <b>Note:</b> If a shortcut is to be taken, the code will only check,
456 if the named directory has been scanned already. If so, it is assumed,
457 that the states for all files has been populated by the previous run.
458 </p>
459 <dl>
460
461 <dt><i>names</i></dt>
462 <dd>
463 dictionary with all filenames to be checked as keys
464 </dd>
465 <dt><i>dname</i></dt>
466 <dd>
467 directory to check in (string)
468 </dd>
469 <dt><i>shortcut</i></dt>
470 <dd>
471 flag indicating a shortcut should be taken (boolean)
472 </dd>
473 </dl>
474 <dl>
475 <dt>Return:</dt>
476 <dd>
477 the received dictionary completed with a combination of
478 canBeCommited and canBeAdded or None in order to signal an error
479 </dd>
480 </dl>
481 <a NAME="Subversion.__vcsAllRegisteredStates_wcng" ID="Subversion.__vcsAllRegisteredStates_wcng"></a>
482 <h4>Subversion.__vcsAllRegisteredStates_wcng</h4>
483 <b>__vcsAllRegisteredStates_wcng</b>(<i>names, dname, shortcut=True</i>)
484
485 <p>
486 Private method used to get the registered states of a number of files
487 in the vcs.
488 </p>
489 <p>
490 This is the variant for subversion installations using the new working
491 copy meta-data format.
492 </p>
493 <p>
494 <b>Note:</b> If a shortcut is to be taken, the code will only check,
495 if the named directory has been scanned already. If so, it is assumed,
496 that the states for all files has been populated by the previous run.
497 </p>
498 <dl>
499
500 <dt><i>names</i></dt>
501 <dd>
502 dictionary with all filenames to be checked as keys
503 </dd>
504 <dt><i>dname</i></dt>
505 <dd>
506 directory to check in (string)
507 </dd>
508 <dt><i>shortcut</i></dt>
509 <dd>
510 flag indicating a shortcut should be taken (boolean)
511 </dd>
512 </dl>
513 <dl>
514 <dt>Return:</dt>
515 <dd>
516 the received dictionary completed with a combination of
517 canBeCommited and canBeAdded or None in order to signal an error
518 </dd>
519 </dl>
520 <a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a>
521 <h4>Subversion.__vcsCommit_Step2</h4>
522 <b>__vcsCommit_Step2</b>(<i></i>)
523
524 <p>
525 Private slot performing the second step of the commit action.
526 </p>
527 <a NAME="Subversion.__vcsRegisteredState_wc" ID="Subversion.__vcsRegisteredState_wc"></a>
528 <h4>Subversion.__vcsRegisteredState_wc</h4>
529 <b>__vcsRegisteredState_wc</b>(<i>name</i>)
530
531 <p>
532 Private method used to get the registered state of a file in the vcs.
533 </p>
534 <p>
535 This is the variant for subversion installations using the old working
536 copy meta-data format.
537 </p>
538 <dl>
539
540 <dt><i>name</i></dt>
541 <dd>
542 filename to check (string)
543 </dd>
544 </dl>
545 <dl>
546 <dt>Return:</dt>
547 <dd>
548 a combination of canBeCommited and canBeAdded
549 </dd>
550 </dl>
551 <a NAME="Subversion.__vcsRegisteredState_wcng" ID="Subversion.__vcsRegisteredState_wcng"></a>
552 <h4>Subversion.__vcsRegisteredState_wcng</h4>
553 <b>__vcsRegisteredState_wcng</b>(<i>name</i>)
554
555 <p>
556 Private method used to get the registered state of a file in the vcs.
557 </p>
558 <p>
559 This is the variant for subversion installations using the new
560 working copy meta-data format.
561 </p>
562 <dl>
563
564 <dt><i>name</i></dt>
565 <dd>
566 filename to check (string)
567 </dd>
568 </dl>
569 <dl>
570 <dt>Return:</dt>
571 <dd>
572 a combination of canBeCommited and canBeAdded
573 </dd>
574 </dl>
575 <a NAME="Subversion._createStatusMonitorThread" ID="Subversion._createStatusMonitorThread"></a>
576 <h4>Subversion._createStatusMonitorThread</h4>
577 <b>_createStatusMonitorThread</b>(<i>interval, project</i>)
578
579 <p>
580 Protected method to create an instance of the VCS status monitor
581 thread.
582 </p>
583 <dl>
584
585 <dt><i>interval</i></dt>
586 <dd>
587 check interval for the monitor thread in seconds
588 (integer)
589 </dd>
590 <dt><i>project</i></dt>
591 <dd>
592 reference to the project object
593 </dd>
594 </dl>
595 <dl>
596 <dt>Return:</dt>
597 <dd>
598 reference to the monitor thread (QThread)
599 </dd>
600 </dl>
601 <a NAME="Subversion.clearStatusCache" ID="Subversion.clearStatusCache"></a>
602 <h4>Subversion.clearStatusCache</h4>
603 <b>clearStatusCache</b>(<i></i>)
604
605 <p>
606 Public method to clear the status cache.
607 </p>
608 <a NAME="Subversion.getClient" ID="Subversion.getClient"></a>
609 <h4>Subversion.getClient</h4>
610 <b>getClient</b>(<i></i>)
611
612 <p>
613 Public method to create and initialize the pysvn client object.
614 </p>
615 <dl>
616 <dt>Return:</dt>
617 <dd>
618 the pysvn client object (pysvn.Client)
619 </dd>
620 </dl>
621 <a NAME="Subversion.getPlugin" ID="Subversion.getPlugin"></a>
622 <h4>Subversion.getPlugin</h4>
623 <b>getPlugin</b>(<i></i>)
624
625 <p>
626 Public method to get a reference to the plugin object.
627 </p>
628 <dl>
629 <dt>Return:</dt>
630 <dd>
631 reference to the plugin object (VcsPySvnPlugin)
632 </dd>
633 </dl>
634 <a NAME="Subversion.svnAddToChangelist" ID="Subversion.svnAddToChangelist"></a>
635 <h4>Subversion.svnAddToChangelist</h4>
636 <b>svnAddToChangelist</b>(<i>names</i>)
637
638 <p>
639 Public method to add a file or directory to a changelist.
640 </p>
641 <p>
642 Note: Directories will be added recursively.
643 </p>
644 <dl>
645
646 <dt><i>names</i></dt>
647 <dd>
648 name or list of names of file or directory to add
649 (string)
650 </dd>
651 </dl>
652 <a NAME="Subversion.svnBlame" ID="Subversion.svnBlame"></a>
653 <h4>Subversion.svnBlame</h4>
654 <b>svnBlame</b>(<i>name</i>)
655
656 <p>
657 Public method to show the output of the svn blame command.
658 </p>
659 <dl>
660
661 <dt><i>name</i></dt>
662 <dd>
663 file name to show the blame for (string)
664 </dd>
665 </dl>
666 <a NAME="Subversion.svnCopy" ID="Subversion.svnCopy"></a>
667 <h4>Subversion.svnCopy</h4>
668 <b>svnCopy</b>(<i>name, project</i>)
669
670 <p>
671 Public method used to copy a file/directory.
672 </p>
673 <dl>
674
675 <dt><i>name</i></dt>
676 <dd>
677 file/directory name to be copied (string)
678 </dd>
679 <dt><i>project</i></dt>
680 <dd>
681 reference to the project object
682 </dd>
683 </dl>
684 <dl>
685 <dt>Return:</dt>
686 <dd>
687 flag indicating successfull operation (boolean)
688 </dd>
689 </dl>
690 <a NAME="Subversion.svnDelProp" ID="Subversion.svnDelProp"></a>
691 <h4>Subversion.svnDelProp</h4>
692 <b>svnDelProp</b>(<i>name, recursive=False</i>)
693
694 <p>
695 Public method used to delete a property of a file/directory.
696 </p>
697 <dl>
698
699 <dt><i>name</i></dt>
700 <dd>
701 file/directory name (string or list of strings)
702 </dd>
703 <dt><i>recursive</i></dt>
704 <dd>
705 flag indicating a recursive list is requested
706 </dd>
707 </dl>
708 <a NAME="Subversion.svnExtendedDiff" ID="Subversion.svnExtendedDiff"></a>
709 <h4>Subversion.svnExtendedDiff</h4>
710 <b>svnExtendedDiff</b>(<i>name</i>)
711
712 <p>
713 Public method used to view the difference of a file/directory to the
714 Subversion repository.
715 </p>
716 <p>
717 If name is a directory and is the project directory, all project files
718 are saved first. If name is a file (or list of files), which is/are
719 being edited and has unsaved modification, they can be saved or the
720 operation may be aborted.
721 </p>
722 <p>
723 This method gives the chance to enter the revisions to be compared.
724 </p>
725 <dl>
726
727 <dt><i>name</i></dt>
728 <dd>
729 file/directory name to be diffed (string)
730 </dd>
731 </dl>
732 <a NAME="Subversion.svnGetChangelists" ID="Subversion.svnGetChangelists"></a>
733 <h4>Subversion.svnGetChangelists</h4>
734 <b>svnGetChangelists</b>(<i></i>)
735
736 <p>
737 Public method to get a list of all defined change lists.
738 </p>
739 <dl>
740 <dt>Return:</dt>
741 <dd>
742 list of defined change list names (list of strings)
743 </dd>
744 </dl>
745 <a NAME="Subversion.svnGetReposName" ID="Subversion.svnGetReposName"></a>
746 <h4>Subversion.svnGetReposName</h4>
747 <b>svnGetReposName</b>(<i>path</i>)
748
749 <p>
750 Public method used to retrieve the URL of the subversion repository
751 path.
752 </p>
753 <dl>
754
755 <dt><i>path</i></dt>
756 <dd>
757 local path to get the svn repository path for (string)
758 </dd>
759 </dl>
760 <dl>
761 <dt>Return:</dt>
762 <dd>
763 string with the repository path URL
764 </dd>
765 </dl>
766 <a NAME="Subversion.svnInfo" ID="Subversion.svnInfo"></a>
767 <h4>Subversion.svnInfo</h4>
768 <b>svnInfo</b>(<i>projectPath, name</i>)
769
770 <p>
771 Public method to show repository information about a file or directory.
772 </p>
773 <dl>
774
775 <dt><i>projectPath</i></dt>
776 <dd>
777 path name of the project (string)
778 </dd>
779 <dt><i>name</i></dt>
780 <dd>
781 file/directory name relative to the project (string)
782 </dd>
783 </dl>
784 <a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a>
785 <h4>Subversion.svnListProps</h4>
786 <b>svnListProps</b>(<i>name, recursive=False</i>)
787
788 <p>
789 Public method used to list the properties of a file/directory.
790 </p>
791 <dl>
792
793 <dt><i>name</i></dt>
794 <dd>
795 file/directory name (string or list of strings)
796 </dd>
797 <dt><i>recursive</i></dt>
798 <dd>
799 flag indicating a recursive list is requested
800 </dd>
801 </dl>
802 <a NAME="Subversion.svnListTagBranch" ID="Subversion.svnListTagBranch"></a>
803 <h4>Subversion.svnListTagBranch</h4>
804 <b>svnListTagBranch</b>(<i>path, tags=True</i>)
805
806 <p>
807 Public method used to list the available tags or branches.
808 </p>
809 <dl>
810
811 <dt><i>path</i></dt>
812 <dd>
813 directory name of the project (string)
814 </dd>
815 <dt><i>tags</i></dt>
816 <dd>
817 flag indicating listing of branches or tags
818 (False = branches, True = tags)
819 </dd>
820 </dl>
821 <a NAME="Subversion.svnLock" ID="Subversion.svnLock"></a>
822 <h4>Subversion.svnLock</h4>
823 <b>svnLock</b>(<i>name, stealIt=False, parent=None</i>)
824
825 <p>
826 Public method used to lock a file in the Subversion repository.
827 </p>
828 <dl>
829
830 <dt><i>name</i></dt>
831 <dd>
832 file/directory name to be locked (string or list of
833 strings)
834 </dd>
835 <dt><i>stealIt</i></dt>
836 <dd>
837 flag indicating a forced operation (boolean)
838 </dd>
839 <dt><i>parent</i></dt>
840 <dd>
841 reference to the parent object of the subversion dialog
842 (QWidget)
843 </dd>
844 </dl>
845 <a NAME="Subversion.svnNormalizeURL" ID="Subversion.svnNormalizeURL"></a>
846 <h4>Subversion.svnNormalizeURL</h4>
847 <b>svnNormalizeURL</b>(<i>url</i>)
848
849 <p>
850 Public method to normalize a url for subversion.
851 </p>
852 <dl>
853
854 <dt><i>url</i></dt>
855 <dd>
856 url string (string)
857 </dd>
858 </dl>
859 <dl>
860 <dt>Return:</dt>
861 <dd>
862 properly normalized url for subversion (string)
863 </dd>
864 </dl>
865 <a NAME="Subversion.svnRelocate" ID="Subversion.svnRelocate"></a>
866 <h4>Subversion.svnRelocate</h4>
867 <b>svnRelocate</b>(<i>projectPath</i>)
868
869 <p>
870 Public method to relocate the working copy to a new repository URL.
871 </p>
872 <dl>
873
874 <dt><i>projectPath</i></dt>
875 <dd>
876 path name of the project (string)
877 </dd>
878 </dl>
879 <a NAME="Subversion.svnRemoveFromChangelist" ID="Subversion.svnRemoveFromChangelist"></a>
880 <h4>Subversion.svnRemoveFromChangelist</h4>
881 <b>svnRemoveFromChangelist</b>(<i>names</i>)
882
883 <p>
884 Public method to remove a file or directory from its changelist.
885 </p>
886 <p>
887 Note: Directories will be removed recursively.
888 </p>
889 <dl>
890
891 <dt><i>names</i></dt>
892 <dd>
893 name or list of names of file or directory to remove
894 (string)
895 </dd>
896 </dl>
897 <a NAME="Subversion.svnRepoBrowser" ID="Subversion.svnRepoBrowser"></a>
898 <h4>Subversion.svnRepoBrowser</h4>
899 <b>svnRepoBrowser</b>(<i>projectPath=None</i>)
900
901 <p>
902 Public method to open the repository browser.
903 </p>
904 <dl>
905
906 <dt><i>projectPath</i></dt>
907 <dd>
908 path name of the project (string)
909 </dd>
910 </dl>
911 <a NAME="Subversion.svnResolve" ID="Subversion.svnResolve"></a>
912 <h4>Subversion.svnResolve</h4>
913 <b>svnResolve</b>(<i>name</i>)
914
915 <p>
916 Public method used to resolve conflicts of a file/directory.
917 </p>
918 <dl>
919
920 <dt><i>name</i></dt>
921 <dd>
922 file/directory name to be resolved (string)
923 </dd>
924 </dl>
925 <a NAME="Subversion.svnSbsDiff" ID="Subversion.svnSbsDiff"></a>
926 <h4>Subversion.svnSbsDiff</h4>
927 <b>svnSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
928
929 <p>
930 Public method used to view the difference of a file to the Mercurial
931 repository side-by-side.
932 </p>
933 <dl>
934
935 <dt><i>name</i></dt>
936 <dd>
937 file name to be diffed (string)
938 </dd>
939 <dt><i>extended</i></dt>
940 <dd>
941 flag indicating the extended variant (boolean)
942 </dd>
943 <dt><i>revisions</i></dt>
944 <dd>
945 tuple of two revisions (tuple of strings)
946 </dd>
947 </dl>
948 <dl>
949
950 <dt>Raises <b>ValueError</b>:</dt>
951 <dd>
952 raised to indicate an invalid name parameter type
953 </dd>
954 </dl>
955 <a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a>
956 <h4>Subversion.svnSetProp</h4>
957 <b>svnSetProp</b>(<i>name, recursive=False</i>)
958
959 <p>
960 Public method used to add a property to a file/directory.
961 </p>
962 <dl>
963
964 <dt><i>name</i></dt>
965 <dd>
966 file/directory name (string or list of strings)
967 </dd>
968 <dt><i>recursive</i></dt>
969 <dd>
970 flag indicating a recursive set is requested
971 </dd>
972 </dl>
973 <a NAME="Subversion.svnShowChangelists" ID="Subversion.svnShowChangelists"></a>
974 <h4>Subversion.svnShowChangelists</h4>
975 <b>svnShowChangelists</b>(<i>path</i>)
976
977 <p>
978 Public method used to inspect the change lists defined for the project.
979 </p>
980 <dl>
981
982 <dt><i>path</i></dt>
983 <dd>
984 directory name to show change lists for (string)
985 </dd>
986 </dl>
987 <a NAME="Subversion.svnUnlock" ID="Subversion.svnUnlock"></a>
988 <h4>Subversion.svnUnlock</h4>
989 <b>svnUnlock</b>(<i>name, breakIt=False, parent=None</i>)
990
991 <p>
992 Public method used to unlock a file in the Subversion repository.
993 </p>
994 <dl>
995
996 <dt><i>name</i></dt>
997 <dd>
998 file/directory name to be unlocked (string or list of
999 strings)
1000 </dd>
1001 <dt><i>breakIt</i></dt>
1002 <dd>
1003 flag indicating a forced operation (boolean)
1004 </dd>
1005 <dt><i>parent</i></dt>
1006 <dd>
1007 reference to the parent object of the subversion dialog
1008 (QWidget)
1009 </dd>
1010 </dl>
1011 <a NAME="Subversion.svnUpgrade" ID="Subversion.svnUpgrade"></a>
1012 <h4>Subversion.svnUpgrade</h4>
1013 <b>svnUpgrade</b>(<i>path</i>)
1014
1015 <p>
1016 Public method to upgrade the working copy format.
1017 </p>
1018 <dl>
1019
1020 <dt><i>path</i></dt>
1021 <dd>
1022 directory name to show change lists for (string)
1023 </dd>
1024 </dl>
1025 <a NAME="Subversion.svnUrlDiff" ID="Subversion.svnUrlDiff"></a>
1026 <h4>Subversion.svnUrlDiff</h4>
1027 <b>svnUrlDiff</b>(<i>name</i>)
1028
1029 <p>
1030 Public method used to view the difference of a file/directory of two
1031 repository URLs.
1032 </p>
1033 <p>
1034 If name is a directory and is the project directory, all project files
1035 are saved first. If name is a file (or list of files), which is/are
1036 being edited and has unsaved modification, they can be saved or the
1037 operation may be aborted.
1038 </p>
1039 <p>
1040 This method gives the chance to enter the revisions to be compared.
1041 </p>
1042 <dl>
1043
1044 <dt><i>name</i></dt>
1045 <dd>
1046 file/directory name to be diffed (string)
1047 </dd>
1048 </dl>
1049 <a NAME="Subversion.vcsAdd" ID="Subversion.vcsAdd"></a>
1050 <h4>Subversion.vcsAdd</h4>
1051 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
1052
1053 <p>
1054 Public method used to add a file/directory to the Subversion
1055 repository.
1056 </p>
1057 <dl>
1058
1059 <dt><i>name</i></dt>
1060 <dd>
1061 file/directory name to be added (string)
1062 </dd>
1063 <dt><i>isDir</i></dt>
1064 <dd>
1065 flag indicating name is a directory (boolean)
1066 </dd>
1067 <dt><i>noDialog</i></dt>
1068 <dd>
1069 flag indicating quiet operations (boolean)
1070 </dd>
1071 </dl>
1072 <a NAME="Subversion.vcsAddBinary" ID="Subversion.vcsAddBinary"></a>
1073 <h4>Subversion.vcsAddBinary</h4>
1074 <b>vcsAddBinary</b>(<i>name, isDir=False</i>)
1075
1076 <p>
1077 Public method used to add a file/directory in binary mode to the
1078 Subversion repository.
1079 </p>
1080 <dl>
1081
1082 <dt><i>name</i></dt>
1083 <dd>
1084 file/directory name to be added (string)
1085 </dd>
1086 <dt><i>isDir</i></dt>
1087 <dd>
1088 flag indicating name is a directory (boolean)
1089 </dd>
1090 </dl>
1091 <a NAME="Subversion.vcsAddTree" ID="Subversion.vcsAddTree"></a>
1092 <h4>Subversion.vcsAddTree</h4>
1093 <b>vcsAddTree</b>(<i>path</i>)
1094
1095 <p>
1096 Public method to add a directory tree rooted at path to the Subversion
1097 repository.
1098 </p>
1099 <dl>
1100
1101 <dt><i>path</i></dt>
1102 <dd>
1103 root directory of the tree to be added (string or list of
1104 strings))
1105 </dd>
1106 </dl>
1107 <a NAME="Subversion.vcsAllRegisteredStates" ID="Subversion.vcsAllRegisteredStates"></a>
1108 <h4>Subversion.vcsAllRegisteredStates</h4>
1109 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>)
1110
1111 <p>
1112 Public method used to get the registered states of a number of files
1113 in the vcs.
1114 </p>
1115 <p>
1116 <b>Note:</b> If a shortcut is to be taken, the code will only check,
1117 if the named directory has been scanned already. If so, it is assumed,
1118 that the states for all files has been populated by the previous run.
1119 </p>
1120 <dl>
1121
1122 <dt><i>names</i></dt>
1123 <dd>
1124 dictionary with all filenames to be checked as keys
1125 </dd>
1126 <dt><i>dname</i></dt>
1127 <dd>
1128 directory to check in (string)
1129 </dd>
1130 <dt><i>shortcut</i></dt>
1131 <dd>
1132 flag indicating a shortcut should be taken (boolean)
1133 </dd>
1134 </dl>
1135 <dl>
1136 <dt>Return:</dt>
1137 <dd>
1138 the received dictionary completed with a combination of
1139 canBeCommited and canBeAdded or None in order to signal an error
1140 </dd>
1141 </dl>
1142 <a NAME="Subversion.vcsCheckout" ID="Subversion.vcsCheckout"></a>
1143 <h4>Subversion.vcsCheckout</h4>
1144 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
1145
1146 <p>
1147 Public method used to check the project out of the Subversion
1148 repository.
1149 </p>
1150 <dl>
1151
1152 <dt><i>vcsDataDict</i></dt>
1153 <dd>
1154 dictionary of data required for the checkout
1155 </dd>
1156 <dt><i>projectDir</i></dt>
1157 <dd>
1158 project directory to create (string)
1159 </dd>
1160 <dt><i>noDialog</i></dt>
1161 <dd>
1162 flag indicating quiet operations
1163 </dd>
1164 </dl>
1165 <dl>
1166 <dt>Return:</dt>
1167 <dd>
1168 flag indicating an execution without errors (boolean)
1169 </dd>
1170 </dl>
1171 <a NAME="Subversion.vcsCleanup" ID="Subversion.vcsCleanup"></a>
1172 <h4>Subversion.vcsCleanup</h4>
1173 <b>vcsCleanup</b>(<i>name</i>)
1174
1175 <p>
1176 Public method used to cleanup the working copy.
1177 </p>
1178 <dl>
1179
1180 <dt><i>name</i></dt>
1181 <dd>
1182 directory name to be cleaned up (string)
1183 </dd>
1184 </dl>
1185 <a NAME="Subversion.vcsCommandLine" ID="Subversion.vcsCommandLine"></a>
1186 <h4>Subversion.vcsCommandLine</h4>
1187 <b>vcsCommandLine</b>(<i>name</i>)
1188
1189 <p>
1190 Public method used to execute arbitrary subversion commands.
1191 </p>
1192 <dl>
1193
1194 <dt><i>name</i></dt>
1195 <dd>
1196 directory name of the working directory (string)
1197 </dd>
1198 </dl>
1199 <a NAME="Subversion.vcsCommit" ID="Subversion.vcsCommit"></a>
1200 <h4>Subversion.vcsCommit</h4>
1201 <b>vcsCommit</b>(<i>name, message, noDialog=False</i>)
1202
1203 <p>
1204 Public method used to make the change of a file/directory permanent
1205 in the Subversion repository.
1206 </p>
1207 <dl>
1208
1209 <dt><i>name</i></dt>
1210 <dd>
1211 file/directory name to be committed (string or
1212 list of strings)
1213 </dd>
1214 <dt><i>message</i></dt>
1215 <dd>
1216 message for this operation (string)
1217 </dd>
1218 <dt><i>noDialog</i></dt>
1219 <dd>
1220 flag indicating quiet operations
1221 </dd>
1222 </dl>
1223 <a NAME="Subversion.vcsConvertProject" ID="Subversion.vcsConvertProject"></a>
1224 <h4>Subversion.vcsConvertProject</h4>
1225 <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>)
1226
1227 <p>
1228 Public method to convert an uncontrolled project to a version
1229 controlled project.
1230 </p>
1231 <dl>
1232
1233 <dt><i>vcsDataDict</i> (dict)</dt>
1234 <dd>
1235 dictionary of data required for the conversion
1236 </dd>
1237 <dt><i>project</i> (Project)</dt>
1238 <dd>
1239 reference to the project object
1240 </dd>
1241 <dt><i>addAll</i> (bool)</dt>
1242 <dd>
1243 flag indicating to add all files to the repository
1244 </dd>
1245 </dl>
1246 <a NAME="Subversion.vcsDiff" ID="Subversion.vcsDiff"></a>
1247 <h4>Subversion.vcsDiff</h4>
1248 <b>vcsDiff</b>(<i>name</i>)
1249
1250 <p>
1251 Public method used to view the difference of a file/directory to the
1252 Subversion repository.
1253 </p>
1254 <p>
1255 If name is a directory and is the project directory, all project files
1256 are saved first. If name is a file (or list of files), which is/are
1257 being edited and has unsaved modification, they can be saved or the
1258 operation may be aborted.
1259 </p>
1260 <dl>
1261
1262 <dt><i>name</i></dt>
1263 <dd>
1264 file/directory name to be diffed (string)
1265 </dd>
1266 </dl>
1267 <a NAME="Subversion.vcsExists" ID="Subversion.vcsExists"></a>
1268 <h4>Subversion.vcsExists</h4>
1269 <b>vcsExists</b>(<i></i>)
1270
1271 <p>
1272 Public method used to test for the presence of the svn executable.
1273 </p>
1274 <dl>
1275 <dt>Return:</dt>
1276 <dd>
1277 flag indicating the existance (boolean) and an error message
1278 (string)
1279 </dd>
1280 </dl>
1281 <a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a>
1282 <h4>Subversion.vcsExport</h4>
1283 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
1284
1285 <p>
1286 Public method used to export a directory from the Subversion
1287 repository.
1288 </p>
1289 <dl>
1290
1291 <dt><i>vcsDataDict</i></dt>
1292 <dd>
1293 dictionary of data required for the checkout
1294 </dd>
1295 <dt><i>projectDir</i></dt>
1296 <dd>
1297 project directory to create (string)
1298 </dd>
1299 </dl>
1300 <dl>
1301 <dt>Return:</dt>
1302 <dd>
1303 flag indicating an execution without errors (boolean)
1304 </dd>
1305 </dl>
1306 <a NAME="Subversion.vcsGetProjectBrowserHelper" ID="Subversion.vcsGetProjectBrowserHelper"></a>
1307 <h4>Subversion.vcsGetProjectBrowserHelper</h4>
1308 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
1309
1310 <p>
1311 Public method to instanciate a helper object for the different
1312 project browsers.
1313 </p>
1314 <dl>
1315
1316 <dt><i>browser</i></dt>
1317 <dd>
1318 reference to the project browser object
1319 </dd>
1320 <dt><i>project</i></dt>
1321 <dd>
1322 reference to the project object
1323 </dd>
1324 <dt><i>isTranslationsBrowser</i></dt>
1325 <dd>
1326 flag indicating, the helper is requested
1327 for the translations browser (this needs some special treatment)
1328 </dd>
1329 </dl>
1330 <dl>
1331 <dt>Return:</dt>
1332 <dd>
1333 the project browser helper object
1334 </dd>
1335 </dl>
1336 <a NAME="Subversion.vcsGetProjectHelper" ID="Subversion.vcsGetProjectHelper"></a>
1337 <h4>Subversion.vcsGetProjectHelper</h4>
1338 <b>vcsGetProjectHelper</b>(<i>project</i>)
1339
1340 <p>
1341 Public method to instanciate a helper object for the project.
1342 </p>
1343 <dl>
1344
1345 <dt><i>project</i></dt>
1346 <dd>
1347 reference to the project object
1348 </dd>
1349 </dl>
1350 <dl>
1351 <dt>Return:</dt>
1352 <dd>
1353 the project helper object
1354 </dd>
1355 </dl>
1356 <a NAME="Subversion.vcsImport" ID="Subversion.vcsImport"></a>
1357 <h4>Subversion.vcsImport</h4>
1358 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>)
1359
1360 <p>
1361 Public method used to import the project into the Subversion
1362 repository.
1363 </p>
1364 <dl>
1365
1366 <dt><i>vcsDataDict</i> (dict)</dt>
1367 <dd>
1368 dictionary of data required for the import
1369 </dd>
1370 <dt><i>projectDir</i> (str)</dt>
1371 <dd>
1372 project directory (string)
1373 </dd>
1374 <dt><i>noDialog</i> (bool)</dt>
1375 <dd>
1376 flag indicating quiet operations
1377 </dd>
1378 <dt><i>addAll</i> (bool)</dt>
1379 <dd>
1380 flag indicating to add all files to the repository
1381 </dd>
1382 </dl>
1383 <dl>
1384 <dt>Return:</dt>
1385 <dd>
1386 tuple containing a flag indicating an execution without errors
1387 and a flag indicating the version controll status
1388 </dd>
1389 </dl>
1390 <dl>
1391 <dt>Return Type:</dt>
1392 <dd>
1393 tuple of (bool, bool)
1394 </dd>
1395 </dl>
1396 <a NAME="Subversion.vcsInit" ID="Subversion.vcsInit"></a>
1397 <h4>Subversion.vcsInit</h4>
1398 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
1399
1400 <p>
1401 Public method used to initialize the subversion repository.
1402 </p>
1403 <p>
1404 The subversion repository has to be initialized from outside eric
1405 because the respective command always works locally. Therefore we
1406 always return TRUE without doing anything.
1407 </p>
1408 <dl>
1409
1410 <dt><i>vcsDir</i></dt>
1411 <dd>
1412 name of the VCS directory (string)
1413 </dd>
1414 <dt><i>noDialog</i></dt>
1415 <dd>
1416 flag indicating quiet operations (boolean)
1417 </dd>
1418 </dl>
1419 <dl>
1420 <dt>Return:</dt>
1421 <dd>
1422 always TRUE
1423 </dd>
1424 </dl>
1425 <a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a>
1426 <h4>Subversion.vcsInitConfig</h4>
1427 <b>vcsInitConfig</b>(<i>project</i>)
1428
1429 <p>
1430 Public method to initialize the VCS configuration.
1431 </p>
1432 <p>
1433 This method ensures, that eric specific files and directories are
1434 ignored.
1435 </p>
1436 <dl>
1437
1438 <dt><i>project</i></dt>
1439 <dd>
1440 reference to the project (Project)
1441 </dd>
1442 </dl>
1443 <a NAME="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a>
1444 <h4>Subversion.vcsLogBrowser</h4>
1445 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>)
1446
1447 <p>
1448 Public method used to browse the log of a file/directory from the
1449 Subversion repository.
1450 </p>
1451 <dl>
1452
1453 <dt><i>name</i></dt>
1454 <dd>
1455 file/directory name to show the log of (string)
1456 </dd>
1457 <dt><i>isFile</i></dt>
1458 <dd>
1459 flag indicating log for a file is to be shown (boolean)
1460 </dd>
1461 </dl>
1462 <a NAME="Subversion.vcsMerge" ID="Subversion.vcsMerge"></a>
1463 <h4>Subversion.vcsMerge</h4>
1464 <b>vcsMerge</b>(<i>name</i>)
1465
1466 <p>
1467 Public method used to merge a URL/revision into the local project.
1468 </p>
1469 <dl>
1470
1471 <dt><i>name</i></dt>
1472 <dd>
1473 file/directory name to be merged (string)
1474 </dd>
1475 </dl>
1476 <a NAME="Subversion.vcsMove" ID="Subversion.vcsMove"></a>
1477 <h4>Subversion.vcsMove</h4>
1478 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>)
1479
1480 <p>
1481 Public method used to move a file/directory.
1482 </p>
1483 <dl>
1484
1485 <dt><i>name</i></dt>
1486 <dd>
1487 file/directory name to be moved (string)
1488 </dd>
1489 <dt><i>project</i></dt>
1490 <dd>
1491 reference to the project object
1492 </dd>
1493 <dt><i>target</i></dt>
1494 <dd>
1495 new name of the file/directory (string)
1496 </dd>
1497 <dt><i>noDialog</i></dt>
1498 <dd>
1499 flag indicating quiet operations
1500 </dd>
1501 </dl>
1502 <dl>
1503 <dt>Return:</dt>
1504 <dd>
1505 flag indicating successfull operation (boolean)
1506 </dd>
1507 </dl>
1508 <a NAME="Subversion.vcsName" ID="Subversion.vcsName"></a>
1509 <h4>Subversion.vcsName</h4>
1510 <b>vcsName</b>(<i></i>)
1511
1512 <p>
1513 Public method returning the name of the vcs.
1514 </p>
1515 <dl>
1516 <dt>Return:</dt>
1517 <dd>
1518 always 'Subversion' (string)
1519 </dd>
1520 </dl>
1521 <a NAME="Subversion.vcsNewProjectOptionsDialog" ID="Subversion.vcsNewProjectOptionsDialog"></a>
1522 <h4>Subversion.vcsNewProjectOptionsDialog</h4>
1523 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>)
1524
1525 <p>
1526 Public method to get a dialog to enter repository info for getting a
1527 new project.
1528 </p>
1529 <dl>
1530
1531 <dt><i>parent</i></dt>
1532 <dd>
1533 parent widget (QWidget)
1534 </dd>
1535 </dl>
1536 <dl>
1537 <dt>Return:</dt>
1538 <dd>
1539 reference to the instantiated options dialog
1540 (SvnNewProjectOptionsDialog)
1541 </dd>
1542 </dl>
1543 <a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a>
1544 <h4>Subversion.vcsOptionsDialog</h4>
1545 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>)
1546
1547 <p>
1548 Public method to get a dialog to enter repository info.
1549 </p>
1550 <dl>
1551
1552 <dt><i>project</i></dt>
1553 <dd>
1554 reference to the project object
1555 </dd>
1556 <dt><i>archive</i></dt>
1557 <dd>
1558 name of the project in the repository (string)
1559 </dd>
1560 <dt><i>editable</i></dt>
1561 <dd>
1562 flag indicating that the project name is editable
1563 (boolean)
1564 </dd>
1565 <dt><i>parent</i></dt>
1566 <dd>
1567 parent widget (QWidget)
1568 </dd>
1569 </dl>
1570 <dl>
1571 <dt>Return:</dt>
1572 <dd>
1573 reference to the instantiated options dialog (SvnOptionsDialog)
1574 </dd>
1575 </dl>
1576 <a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a>
1577 <h4>Subversion.vcsRegisteredState</h4>
1578 <b>vcsRegisteredState</b>(<i>name</i>)
1579
1580 <p>
1581 Public method used to get the registered state of a file in the vcs.
1582 </p>
1583 <dl>
1584
1585 <dt><i>name</i></dt>
1586 <dd>
1587 filename to check (string)
1588 </dd>
1589 </dl>
1590 <dl>
1591 <dt>Return:</dt>
1592 <dd>
1593 a combination of canBeCommited and canBeAdded
1594 </dd>
1595 </dl>
1596 <a NAME="Subversion.vcsRemove" ID="Subversion.vcsRemove"></a>
1597 <h4>Subversion.vcsRemove</h4>
1598 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
1599
1600 <p>
1601 Public method used to remove a file/directory from the Subversion
1602 repository.
1603 </p>
1604 <p>
1605 The default operation is to remove the local copy as well.
1606 </p>
1607 <dl>
1608
1609 <dt><i>name</i></dt>
1610 <dd>
1611 file/directory name to be removed (string or list of
1612 strings))
1613 </dd>
1614 <dt><i>project</i></dt>
1615 <dd>
1616 flag indicating deletion of a project tree (boolean)
1617 (not needed)
1618 </dd>
1619 <dt><i>noDialog</i></dt>
1620 <dd>
1621 flag indicating quiet operations
1622 </dd>
1623 </dl>
1624 <dl>
1625 <dt>Return:</dt>
1626 <dd>
1627 flag indicating successfull operation (boolean)
1628 </dd>
1629 </dl>
1630 <a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a>
1631 <h4>Subversion.vcsRepositoryInfos</h4>
1632 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
1633
1634 <p>
1635 Public method to retrieve information about the repository.
1636 </p>
1637 <dl>
1638
1639 <dt><i>ppath</i></dt>
1640 <dd>
1641 local path to get the repository infos (string)
1642 </dd>
1643 </dl>
1644 <dl>
1645 <dt>Return:</dt>
1646 <dd>
1647 string with ready formated info for display (string)
1648 </dd>
1649 </dl>
1650 <a NAME="Subversion.vcsRevert" ID="Subversion.vcsRevert"></a>
1651 <h4>Subversion.vcsRevert</h4>
1652 <b>vcsRevert</b>(<i>name</i>)
1653
1654 <p>
1655 Public method used to revert changes made to a file/directory.
1656 </p>
1657 <dl>
1658
1659 <dt><i>name</i></dt>
1660 <dd>
1661 file/directory name to be reverted (string)
1662 </dd>
1663 </dl>
1664 <a NAME="Subversion.vcsShutdown" ID="Subversion.vcsShutdown"></a>
1665 <h4>Subversion.vcsShutdown</h4>
1666 <b>vcsShutdown</b>(<i></i>)
1667
1668 <p>
1669 Public method used to shutdown the Subversion interface.
1670 </p>
1671 <a NAME="Subversion.vcsStatus" ID="Subversion.vcsStatus"></a>
1672 <h4>Subversion.vcsStatus</h4>
1673 <b>vcsStatus</b>(<i>name</i>)
1674
1675 <p>
1676 Public method used to view the status of files/directories in the
1677 Subversion repository.
1678 </p>
1679 <dl>
1680
1681 <dt><i>name</i></dt>
1682 <dd>
1683 file/directory name(s) to show the status of
1684 (string or list of strings)
1685 </dd>
1686 </dl>
1687 <a NAME="Subversion.vcsSwitch" ID="Subversion.vcsSwitch"></a>
1688 <h4>Subversion.vcsSwitch</h4>
1689 <b>vcsSwitch</b>(<i>name</i>)
1690
1691 <p>
1692 Public method used to switch a directory to a different tag/branch.
1693 </p>
1694 <dl>
1695
1696 <dt><i>name</i></dt>
1697 <dd>
1698 directory name to be switched (string)
1699 </dd>
1700 </dl>
1701 <dl>
1702 <dt>Return:</dt>
1703 <dd>
1704 flag indicating, that the switch contained an add
1705 or delete (boolean)
1706 </dd>
1707 </dl>
1708 <a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a>
1709 <h4>Subversion.vcsTag</h4>
1710 <b>vcsTag</b>(<i>name</i>)
1711
1712 <p>
1713 Public method used to set the tag of a file/directory in the
1714 Subversion repository.
1715 </p>
1716 <dl>
1717
1718 <dt><i>name</i></dt>
1719 <dd>
1720 file/directory name to be tagged (string)
1721 </dd>
1722 </dl>
1723 <a NAME="Subversion.vcsUpdate" ID="Subversion.vcsUpdate"></a>
1724 <h4>Subversion.vcsUpdate</h4>
1725 <b>vcsUpdate</b>(<i>name, noDialog=False</i>)
1726
1727 <p>
1728 Public method used to update a file/directory with the Subversion
1729 repository.
1730 </p>
1731 <dl>
1732
1733 <dt><i>name</i></dt>
1734 <dd>
1735 file/directory name to be updated (string or list of
1736 strings)
1737 </dd>
1738 <dt><i>noDialog</i></dt>
1739 <dd>
1740 flag indicating quiet operations (boolean)
1741 </dd>
1742 </dl>
1743 <dl>
1744 <dt>Return:</dt>
1745 <dd>
1746 flag indicating, that the update contained an add
1747 or delete (boolean)
1748 </dd>
1749 </dl>
1750 <div align="right"><a href="#top">Up</a></div>
1751 <hr />
1752 </body></html>

Mercurial Repository: eric

eric ide

mercurial