Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.VCS.VersionControl.html

eric6/Documentation/Source/eric6.VCS.VersionControl.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7168
c1f97706c905
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.VCS.VersionControl</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><a NAME="top" ID="top"></a>
22 <h1>eric6.VCS.VersionControl</h1>
23 <p>
24 Module implementing an abstract base class to be subclassed by all specific
25 VCS interfaces.
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="#VersionControl">VersionControl</a></td>
35 <td>Class implementing an abstract base class to be subclassed by all specific VCS interfaces.</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="VersionControl" ID="VersionControl"></a>
44 <h2>VersionControl</h2>
45 <p>
46 Class implementing an abstract base class to be subclassed by all specific
47 VCS interfaces.
48 </p><p>
49 It defines the vcs interface to be implemented by subclasses
50 and the common methods.
51 </p><h3>Signals</h3>
52 <dl>
53 <dt>vcsStatusChanged()</dt>
54 <dd>
55 emitted to indicate a change of the overall
56 VCS status
57 </dd><dt>vcsStatusMonitorData(list of str)</dt>
58 <dd>
59 emitted to update the VCS status
60 </dd><dt>vcsStatusMonitorInfo(str)</dt>
61 <dd>
62 emitted to signal some info of the
63 monitoring thread
64 </dd><dt>vcsStatusMonitorStatus(str, str)</dt>
65 <dd>
66 emitted to signal the status of
67 the monitoring thread (ok, nok, op, off) and a status message
68 </dd>
69 </dl>
70 <h3>Derived from</h3>
71 QObject
72 <h3>Class Attributes</h3>
73 <table>
74 <tr><td>canBeAdded</td></tr><tr><td>canBeCommitted</td></tr>
75 </table>
76 <h3>Class Methods</h3>
77 <table>
78 <tr><td>None</td></tr>
79 </table>
80 <h3>Methods</h3>
81 <table>
82 <tr>
83 <td><a href="#VersionControl.__init__">VersionControl</a></td>
84 <td>Constructor</td>
85 </tr><tr>
86 <td><a href="#VersionControl.__statusMonitorData">__statusMonitorData</a></td>
87 <td>Private method to receive the status monitor status.</td>
88 </tr><tr>
89 <td><a href="#VersionControl.__statusMonitorInfo">__statusMonitorInfo</a></td>
90 <td>Private slot to receive the status monitor info message.</td>
91 </tr><tr>
92 <td><a href="#VersionControl.__statusMonitorStatus">__statusMonitorStatus</a></td>
93 <td>Private slot to receive the status monitor status.</td>
94 </tr><tr>
95 <td><a href="#VersionControl._createStatusMonitorThread">_createStatusMonitorThread</a></td>
96 <td>Protected method to create an instance of the VCS status monitor thread.</td>
97 </tr><tr>
98 <td><a href="#VersionControl.addArguments">addArguments</a></td>
99 <td>Public method to add an argument list to the already present arguments.</td>
100 </tr><tr>
101 <td><a href="#VersionControl.checkVCSStatus">checkVCSStatus</a></td>
102 <td>Public method to wake up the VCS status monitor thread.</td>
103 </tr><tr>
104 <td><a href="#VersionControl.clearStatusCache">clearStatusCache</a></td>
105 <td>Public method to clear the status cache.</td>
106 </tr><tr>
107 <td><a href="#VersionControl.clearStatusMonitorCachedState">clearStatusMonitorCachedState</a></td>
108 <td>Public method to clear the cached VCS state of a file/directory.</td>
109 </tr><tr>
110 <td><a href="#VersionControl.getStatusMonitorAutoUpdate">getStatusMonitorAutoUpdate</a></td>
111 <td>Public method to retrieve the status of the auto update function.</td>
112 </tr><tr>
113 <td><a href="#VersionControl.getStatusMonitorInterval">getStatusMonitorInterval</a></td>
114 <td>Public method to get the monitor interval.</td>
115 </tr><tr>
116 <td><a href="#VersionControl.setStatusMonitorAutoUpdate">setStatusMonitorAutoUpdate</a></td>
117 <td>Public method to enable the auto update function.</td>
118 </tr><tr>
119 <td><a href="#VersionControl.setStatusMonitorInterval">setStatusMonitorInterval</a></td>
120 <td>Public method to change the monitor interval.</td>
121 </tr><tr>
122 <td><a href="#VersionControl.splitPath">splitPath</a></td>
123 <td>Public method splitting name into a directory part and a file part.</td>
124 </tr><tr>
125 <td><a href="#VersionControl.splitPathList">splitPathList</a></td>
126 <td>Public method splitting the list of names into a common directory part and a file list.</td>
127 </tr><tr>
128 <td><a href="#VersionControl.startStatusMonitor">startStatusMonitor</a></td>
129 <td>Public method to start the VCS status monitor thread.</td>
130 </tr><tr>
131 <td><a href="#VersionControl.startSynchronizedProcess">startSynchronizedProcess</a></td>
132 <td>Public method to start a synchroneous process.</td>
133 </tr><tr>
134 <td><a href="#VersionControl.stopStatusMonitor">stopStatusMonitor</a></td>
135 <td>Public method to stop the VCS status monitor thread.</td>
136 </tr><tr>
137 <td><a href="#VersionControl.vcsAdd">vcsAdd</a></td>
138 <td>Public method used to add a file/directory in the vcs.</td>
139 </tr><tr>
140 <td><a href="#VersionControl.vcsAddBinary">vcsAddBinary</a></td>
141 <td>Public method used to add a file/directory in binary mode in the vcs.</td>
142 </tr><tr>
143 <td><a href="#VersionControl.vcsAddTree">vcsAddTree</a></td>
144 <td>Public method to add a directory tree rooted at path in the vcs.</td>
145 </tr><tr>
146 <td><a href="#VersionControl.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
147 <td>Public method used to get the registered states of a number of files in the vcs.</td>
148 </tr><tr>
149 <td><a href="#VersionControl.vcsCheckout">vcsCheckout</a></td>
150 <td>Public method used to check the project out of the vcs.</td>
151 </tr><tr>
152 <td><a href="#VersionControl.vcsCleanup">vcsCleanup</a></td>
153 <td>Public method used to cleanup the local copy.</td>
154 </tr><tr>
155 <td><a href="#VersionControl.vcsCommandLine">vcsCommandLine</a></td>
156 <td>Public method used to execute arbitrary vcs commands.</td>
157 </tr><tr>
158 <td><a href="#VersionControl.vcsCommit">vcsCommit</a></td>
159 <td>Public method used to make the change of a file/directory permanent in the vcs.</td>
160 </tr><tr>
161 <td><a href="#VersionControl.vcsConvertProject">vcsConvertProject</a></td>
162 <td>Public method to convert an uncontrolled project to a version controlled project.</td>
163 </tr><tr>
164 <td><a href="#VersionControl.vcsDiff">vcsDiff</a></td>
165 <td>Public method used to view the diff of a file/directory in the vcs.</td>
166 </tr><tr>
167 <td><a href="#VersionControl.vcsExists">vcsExists</a></td>
168 <td>Public method used to test for the presence of the vcs.</td>
169 </tr><tr>
170 <td><a href="#VersionControl.vcsExport">vcsExport</a></td>
171 <td>Public method used to export a directory from the vcs.</td>
172 </tr><tr>
173 <td><a href="#VersionControl.vcsGetOptions">vcsGetOptions</a></td>
174 <td>Public method used to retrieve the options of the vcs.</td>
175 </tr><tr>
176 <td><a href="#VersionControl.vcsGetOtherData">vcsGetOtherData</a></td>
177 <td>Public method used to retrieve vcs specific data.</td>
178 </tr><tr>
179 <td><a href="#VersionControl.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
180 <td>Public method to instanciate a helper object for the different project browsers.</td>
181 </tr><tr>
182 <td><a href="#VersionControl.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
183 <td>Public method to instanciate a helper object for the project.</td>
184 </tr><tr>
185 <td><a href="#VersionControl.vcsImport">vcsImport</a></td>
186 <td>Public method used to import the project into the vcs.</td>
187 </tr><tr>
188 <td><a href="#VersionControl.vcsInit">vcsInit</a></td>
189 <td>Public method used to initialize the vcs.</td>
190 </tr><tr>
191 <td><a href="#VersionControl.vcsInitConfig">vcsInitConfig</a></td>
192 <td>Public method to initialize the VCS configuration.</td>
193 </tr><tr>
194 <td><a href="#VersionControl.vcsLogBrowser">vcsLogBrowser</a></td>
195 <td>Public method used to view the log of a file/directory in the vcs with a log browser dialog.</td>
196 </tr><tr>
197 <td><a href="#VersionControl.vcsMerge">vcsMerge</a></td>
198 <td>Public method used to merge a tag/branch into the local project.</td>
199 </tr><tr>
200 <td><a href="#VersionControl.vcsMove">vcsMove</a></td>
201 <td>Public method used to move a file/directory.</td>
202 </tr><tr>
203 <td><a href="#VersionControl.vcsName">vcsName</a></td>
204 <td>Public method returning the name of the vcs.</td>
205 </tr><tr>
206 <td><a href="#VersionControl.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td>
207 <td>Public method to get a dialog to enter repository info for getting a new project.</td>
208 </tr><tr>
209 <td><a href="#VersionControl.vcsOptionsDialog">vcsOptionsDialog</a></td>
210 <td>Public method to get a dialog to enter repository info.</td>
211 </tr><tr>
212 <td><a href="#VersionControl.vcsRegisteredState">vcsRegisteredState</a></td>
213 <td>Public method used to get the registered state of a file in the vcs.</td>
214 </tr><tr>
215 <td><a href="#VersionControl.vcsRemove">vcsRemove</a></td>
216 <td>Public method used to add a file/directory in the vcs.</td>
217 </tr><tr>
218 <td><a href="#VersionControl.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
219 <td>Public method to retrieve information about the repository.</td>
220 </tr><tr>
221 <td><a href="#VersionControl.vcsRevert">vcsRevert</a></td>
222 <td>Public method used to revert changes made to a file/directory.</td>
223 </tr><tr>
224 <td><a href="#VersionControl.vcsSetData">vcsSetData</a></td>
225 <td>Public method used to set an entry in the otherData dictionary.</td>
226 </tr><tr>
227 <td><a href="#VersionControl.vcsSetDataFromDict">vcsSetDataFromDict</a></td>
228 <td>Public method used to set entries in the otherData dictionary.</td>
229 </tr><tr>
230 <td><a href="#VersionControl.vcsSetOptions">vcsSetOptions</a></td>
231 <td>Public method used to set the options for the vcs.</td>
232 </tr><tr>
233 <td><a href="#VersionControl.vcsSetOtherData">vcsSetOtherData</a></td>
234 <td>Public method used to set vcs specific data.</td>
235 </tr><tr>
236 <td><a href="#VersionControl.vcsShutdown">vcsShutdown</a></td>
237 <td>Public method used to shutdown the vcs interface.</td>
238 </tr><tr>
239 <td><a href="#VersionControl.vcsStatus">vcsStatus</a></td>
240 <td>Public method used to view the status of a file/directory in the vcs.</td>
241 </tr><tr>
242 <td><a href="#VersionControl.vcsSupportCommandOptions">vcsSupportCommandOptions</a></td>
243 <td>Public method to signal the support of user settable command options.</td>
244 </tr><tr>
245 <td><a href="#VersionControl.vcsSwitch">vcsSwitch</a></td>
246 <td>Public method used to switch a directory to a different tag/branch.</td>
247 </tr><tr>
248 <td><a href="#VersionControl.vcsTag">vcsTag</a></td>
249 <td>Public method used to set the tag of a file/directory in the vcs.</td>
250 </tr><tr>
251 <td><a href="#VersionControl.vcsUpdate">vcsUpdate</a></td>
252 <td>Public method used to update a file/directory in the vcs.</td>
253 </tr>
254 </table>
255 <h3>Static Methods</h3>
256 <table>
257 <tr><td>None</td></tr>
258 </table>
259 <a NAME="VersionControl.__init__" ID="VersionControl.__init__"></a>
260 <h4>VersionControl (Constructor)</h4>
261 <b>VersionControl</b>(<i>parent=None, name=None</i>)
262 <p>
263 Constructor
264 </p><dl>
265 <dt><i>parent</i></dt>
266 <dd>
267 parent widget (QWidget)
268 </dd><dt><i>name</i></dt>
269 <dd>
270 name of this object (string)
271 </dd>
272 </dl><a NAME="VersionControl.__statusMonitorData" ID="VersionControl.__statusMonitorData"></a>
273 <h4>VersionControl.__statusMonitorData</h4>
274 <b>__statusMonitorData</b>(<i>statusList</i>)
275 <p>
276 Private method to receive the status monitor status.
277 </p><p>
278 It simply re-emits the received status list.
279 </p><dl>
280 <dt><i>statusList</i> (list of str)</dt>
281 <dd>
282 list of status records
283 </dd>
284 </dl><a NAME="VersionControl.__statusMonitorInfo" ID="VersionControl.__statusMonitorInfo"></a>
285 <h4>VersionControl.__statusMonitorInfo</h4>
286 <b>__statusMonitorInfo</b>(<i>info</i>)
287 <p>
288 Private slot to receive the status monitor info message.
289 </p><p>
290 It simply re-emits the received info message.
291 </p><dl>
292 <dt><i>info</i> (str)</dt>
293 <dd>
294 received info message
295 </dd>
296 </dl><a NAME="VersionControl.__statusMonitorStatus" ID="VersionControl.__statusMonitorStatus"></a>
297 <h4>VersionControl.__statusMonitorStatus</h4>
298 <b>__statusMonitorStatus</b>(<i>status, statusMsg</i>)
299 <p>
300 Private slot to receive the status monitor status.
301 </p><p>
302 It simply re-emits the received status.
303 </p><dl>
304 <dt><i>status</i> (str (one of ok, nok or off))</dt>
305 <dd>
306 status of the monitoring thread
307 </dd><dt><i>statusMsg</i> (str)</dt>
308 <dd>
309 explanotory text for the signaled status
310 </dd>
311 </dl><a NAME="VersionControl._createStatusMonitorThread" ID="VersionControl._createStatusMonitorThread"></a>
312 <h4>VersionControl._createStatusMonitorThread</h4>
313 <b>_createStatusMonitorThread</b>(<i>interval, project</i>)
314 <p>
315 Protected method to create an instance of the VCS status monitor
316 thread.
317 </p><p>
318 Note: This method should be overwritten in subclasses in order to
319 support VCS status monitoring.
320 </p><dl>
321 <dt><i>interval</i></dt>
322 <dd>
323 check interval for the monitor thread in seconds
324 (integer)
325 </dd><dt><i>project</i></dt>
326 <dd>
327 reference to the project object
328 </dd>
329 </dl><dl>
330 <dt>Returns:</dt>
331 <dd>
332 reference to the monitor thread (QThread)
333 </dd>
334 </dl><a NAME="VersionControl.addArguments" ID="VersionControl.addArguments"></a>
335 <h4>VersionControl.addArguments</h4>
336 <b>addArguments</b>(<i>args, argslist</i>)
337 <p>
338 Public method to add an argument list to the already present
339 arguments.
340 </p><dl>
341 <dt><i>args</i></dt>
342 <dd>
343 current arguments list (list of strings)
344 </dd><dt><i>argslist</i></dt>
345 <dd>
346 list of arguments (list of strings)
347 </dd>
348 </dl><a NAME="VersionControl.checkVCSStatus" ID="VersionControl.checkVCSStatus"></a>
349 <h4>VersionControl.checkVCSStatus</h4>
350 <b>checkVCSStatus</b>(<i></i>)
351 <p>
352 Public method to wake up the VCS status monitor thread.
353 </p><a NAME="VersionControl.clearStatusCache" ID="VersionControl.clearStatusCache"></a>
354 <h4>VersionControl.clearStatusCache</h4>
355 <b>clearStatusCache</b>(<i></i>)
356 <p>
357 Public method to clear the status cache.
358 </p><a NAME="VersionControl.clearStatusMonitorCachedState" ID="VersionControl.clearStatusMonitorCachedState"></a>
359 <h4>VersionControl.clearStatusMonitorCachedState</h4>
360 <b>clearStatusMonitorCachedState</b>(<i>name</i>)
361 <p>
362 Public method to clear the cached VCS state of a file/directory.
363 </p><dl>
364 <dt><i>name</i></dt>
365 <dd>
366 name of the entry to be cleared (string)
367 </dd>
368 </dl><a NAME="VersionControl.getStatusMonitorAutoUpdate" ID="VersionControl.getStatusMonitorAutoUpdate"></a>
369 <h4>VersionControl.getStatusMonitorAutoUpdate</h4>
370 <b>getStatusMonitorAutoUpdate</b>(<i></i>)
371 <p>
372 Public method to retrieve the status of the auto update function.
373 </p><dl>
374 <dt>Returns:</dt>
375 <dd>
376 status of the auto update function (boolean)
377 </dd>
378 </dl><a NAME="VersionControl.getStatusMonitorInterval" ID="VersionControl.getStatusMonitorInterval"></a>
379 <h4>VersionControl.getStatusMonitorInterval</h4>
380 <b>getStatusMonitorInterval</b>(<i></i>)
381 <p>
382 Public method to get the monitor interval.
383 </p><dl>
384 <dt>Returns:</dt>
385 <dd>
386 interval in seconds (integer)
387 </dd>
388 </dl><a NAME="VersionControl.setStatusMonitorAutoUpdate" ID="VersionControl.setStatusMonitorAutoUpdate"></a>
389 <h4>VersionControl.setStatusMonitorAutoUpdate</h4>
390 <b>setStatusMonitorAutoUpdate</b>(<i>auto</i>)
391 <p>
392 Public method to enable the auto update function.
393 </p><dl>
394 <dt><i>auto</i></dt>
395 <dd>
396 status of the auto update function (boolean)
397 </dd>
398 </dl><a NAME="VersionControl.setStatusMonitorInterval" ID="VersionControl.setStatusMonitorInterval"></a>
399 <h4>VersionControl.setStatusMonitorInterval</h4>
400 <b>setStatusMonitorInterval</b>(<i>interval, project</i>)
401 <p>
402 Public method to change the monitor interval.
403 </p><dl>
404 <dt><i>interval</i></dt>
405 <dd>
406 new interval in seconds (integer)
407 </dd><dt><i>project</i></dt>
408 <dd>
409 reference to the project object
410 </dd>
411 </dl><a NAME="VersionControl.splitPath" ID="VersionControl.splitPath"></a>
412 <h4>VersionControl.splitPath</h4>
413 <b>splitPath</b>(<i>name</i>)
414 <p>
415 Public method splitting name into a directory part and a file part.
416 </p><dl>
417 <dt><i>name</i></dt>
418 <dd>
419 path name (string)
420 </dd>
421 </dl><dl>
422 <dt>Returns:</dt>
423 <dd>
424 a tuple of 2 strings (dirname, filename).
425 </dd>
426 </dl><a NAME="VersionControl.splitPathList" ID="VersionControl.splitPathList"></a>
427 <h4>VersionControl.splitPathList</h4>
428 <b>splitPathList</b>(<i>names</i>)
429 <p>
430 Public method splitting the list of names into a common directory part
431 and a file list.
432 </p><dl>
433 <dt><i>names</i></dt>
434 <dd>
435 list of paths (list of strings)
436 </dd>
437 </dl><dl>
438 <dt>Returns:</dt>
439 <dd>
440 a tuple of string and list of strings (dirname, filenamelist)
441 </dd>
442 </dl><a NAME="VersionControl.startStatusMonitor" ID="VersionControl.startStatusMonitor"></a>
443 <h4>VersionControl.startStatusMonitor</h4>
444 <b>startStatusMonitor</b>(<i>project</i>)
445 <p>
446 Public method to start the VCS status monitor thread.
447 </p><dl>
448 <dt><i>project</i></dt>
449 <dd>
450 reference to the project object
451 </dd>
452 </dl><dl>
453 <dt>Returns:</dt>
454 <dd>
455 reference to the monitor thread (QThread)
456 </dd>
457 </dl><a NAME="VersionControl.startSynchronizedProcess" ID="VersionControl.startSynchronizedProcess"></a>
458 <h4>VersionControl.startSynchronizedProcess</h4>
459 <b>startSynchronizedProcess</b>(<i>proc, program, arguments, workingDir=None</i>)
460 <p>
461 Public method to start a synchroneous process.
462 </p><p>
463 This method starts a process and waits
464 for its end while still serving the Qt event loop.
465 </p><dl>
466 <dt><i>proc</i></dt>
467 <dd>
468 process to start (QProcess)
469 </dd><dt><i>program</i></dt>
470 <dd>
471 path of the executable to start (string)
472 </dd><dt><i>arguments</i></dt>
473 <dd>
474 list of arguments for the process (list of strings)
475 </dd><dt><i>workingDir</i></dt>
476 <dd>
477 working directory for the process (string)
478 </dd>
479 </dl><dl>
480 <dt>Returns:</dt>
481 <dd>
482 flag indicating normal exit (boolean)
483 </dd>
484 </dl><a NAME="VersionControl.stopStatusMonitor" ID="VersionControl.stopStatusMonitor"></a>
485 <h4>VersionControl.stopStatusMonitor</h4>
486 <b>stopStatusMonitor</b>(<i></i>)
487 <p>
488 Public method to stop the VCS status monitor thread.
489 </p><a NAME="VersionControl.vcsAdd" ID="VersionControl.vcsAdd"></a>
490 <h4>VersionControl.vcsAdd</h4>
491 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
492 <p>
493 Public method used to add a file/directory in the vcs.
494 </p><dl>
495 <dt><i>name</i></dt>
496 <dd>
497 file/directory name to be added (string)
498 </dd><dt><i>isDir</i></dt>
499 <dd>
500 flag indicating name is a directory (boolean)
501 </dd><dt><i>noDialog</i></dt>
502 <dd>
503 flag indicating quiet operations (boolean)
504 </dd>
505 </dl><dl>
506 <dt>Raises <b>RuntimeError</b>:</dt>
507 <dd>
508 to indicate that this method must be
509 implemented by a subclass
510 </dd>
511 </dl><a NAME="VersionControl.vcsAddBinary" ID="VersionControl.vcsAddBinary"></a>
512 <h4>VersionControl.vcsAddBinary</h4>
513 <b>vcsAddBinary</b>(<i>name, isDir=False</i>)
514 <p>
515 Public method used to add a file/directory in binary mode in the vcs.
516 </p><dl>
517 <dt><i>name</i></dt>
518 <dd>
519 file/directory name to be added (string)
520 </dd><dt><i>isDir</i></dt>
521 <dd>
522 flag indicating name is a directory (boolean)
523 </dd>
524 </dl><dl>
525 <dt>Raises <b>RuntimeError</b>:</dt>
526 <dd>
527 to indicate that this method must be
528 implemented by a subclass
529 </dd>
530 </dl><a NAME="VersionControl.vcsAddTree" ID="VersionControl.vcsAddTree"></a>
531 <h4>VersionControl.vcsAddTree</h4>
532 <b>vcsAddTree</b>(<i>path</i>)
533 <p>
534 Public method to add a directory tree rooted at path in the vcs.
535 </p><dl>
536 <dt><i>path</i></dt>
537 <dd>
538 root directory of the tree to be added (string)
539 </dd>
540 </dl><dl>
541 <dt>Raises <b>RuntimeError</b>:</dt>
542 <dd>
543 to indicate that this method must be
544 implemented by a subclass
545 </dd>
546 </dl><a NAME="VersionControl.vcsAllRegisteredStates" ID="VersionControl.vcsAllRegisteredStates"></a>
547 <h4>VersionControl.vcsAllRegisteredStates</h4>
548 <b>vcsAllRegisteredStates</b>(<i>names, dname</i>)
549 <p>
550 Public method used to get the registered states of a number of files
551 in the vcs.
552 </p><dl>
553 <dt><i>names</i></dt>
554 <dd>
555 dictionary with all filenames to be checked as keys
556 </dd><dt><i>dname</i></dt>
557 <dd>
558 directory to check in (string)
559 </dd>
560 </dl><dl>
561 <dt>Returns:</dt>
562 <dd>
563 the received dictionary completed with a combination of
564 canBeCommited and canBeAdded or None in order to signal an error
565 </dd>
566 </dl><dl>
567 <dt>Raises <b>RuntimeError</b>:</dt>
568 <dd>
569 to indicate that this method must be
570 implemented by a subclass
571 </dd>
572 </dl><a NAME="VersionControl.vcsCheckout" ID="VersionControl.vcsCheckout"></a>
573 <h4>VersionControl.vcsCheckout</h4>
574 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
575 <p>
576 Public method used to check the project out of the vcs.
577 </p><dl>
578 <dt><i>vcsDataDict</i></dt>
579 <dd>
580 dictionary of data required for the checkout
581 </dd><dt><i>projectDir</i></dt>
582 <dd>
583 project directory to create (string)
584 </dd><dt><i>noDialog</i></dt>
585 <dd>
586 flag indicating quiet operations
587 </dd>
588 </dl><dl>
589 <dt>Returns:</dt>
590 <dd>
591 flag indicating an execution without errors (boolean)
592 </dd>
593 </dl><dl>
594 <dt>Raises <b>RuntimeError</b>:</dt>
595 <dd>
596 to indicate that this method must be
597 implemented by a subclass
598 </dd>
599 </dl><a NAME="VersionControl.vcsCleanup" ID="VersionControl.vcsCleanup"></a>
600 <h4>VersionControl.vcsCleanup</h4>
601 <b>vcsCleanup</b>(<i>name</i>)
602 <p>
603 Public method used to cleanup the local copy.
604 </p><dl>
605 <dt><i>name</i></dt>
606 <dd>
607 directory name to be cleaned up (string)
608 </dd>
609 </dl><dl>
610 <dt>Raises <b>RuntimeError</b>:</dt>
611 <dd>
612 to indicate that this method must be
613 implemented by a subclass
614 </dd>
615 </dl><a NAME="VersionControl.vcsCommandLine" ID="VersionControl.vcsCommandLine"></a>
616 <h4>VersionControl.vcsCommandLine</h4>
617 <b>vcsCommandLine</b>(<i>name</i>)
618 <p>
619 Public method used to execute arbitrary vcs commands.
620 </p><dl>
621 <dt><i>name</i></dt>
622 <dd>
623 directory name of the working directory (string)
624 </dd>
625 </dl><dl>
626 <dt>Raises <b>RuntimeError</b>:</dt>
627 <dd>
628 to indicate that this method must be
629 implemented by a subclass
630 </dd>
631 </dl><a NAME="VersionControl.vcsCommit" ID="VersionControl.vcsCommit"></a>
632 <h4>VersionControl.vcsCommit</h4>
633 <b>vcsCommit</b>(<i>name, message, noDialog=False</i>)
634 <p>
635 Public method used to make the change of a file/directory permanent in
636 the vcs.
637 </p><dl>
638 <dt><i>name</i></dt>
639 <dd>
640 file/directory name to be committed (string)
641 </dd><dt><i>message</i></dt>
642 <dd>
643 message for this operation (string)
644 </dd><dt><i>noDialog</i></dt>
645 <dd>
646 flag indicating quiet operations (boolean)
647 </dd>
648 </dl><dl>
649 <dt>Returns:</dt>
650 <dd>
651 flag indicating success (boolean)
652 </dd>
653 </dl><dl>
654 <dt>Raises <b>RuntimeError</b>:</dt>
655 <dd>
656 to indicate that this method must be
657 implemented by a subclass
658 </dd>
659 </dl><a NAME="VersionControl.vcsConvertProject" ID="VersionControl.vcsConvertProject"></a>
660 <h4>VersionControl.vcsConvertProject</h4>
661 <b>vcsConvertProject</b>(<i>vcsDataDict, project</i>)
662 <p>
663 Public method to convert an uncontrolled project to a version
664 controlled project.
665 </p><dl>
666 <dt><i>vcsDataDict</i></dt>
667 <dd>
668 dictionary of data required for the conversion
669 </dd><dt><i>project</i></dt>
670 <dd>
671 reference to the project object
672 </dd>
673 </dl><dl>
674 <dt>Raises <b>RuntimeError</b>:</dt>
675 <dd>
676 to indicate that this method must be
677 implemented by a subclass
678 </dd>
679 </dl><a NAME="VersionControl.vcsDiff" ID="VersionControl.vcsDiff"></a>
680 <h4>VersionControl.vcsDiff</h4>
681 <b>vcsDiff</b>(<i>name</i>)
682 <p>
683 Public method used to view the diff of a file/directory in the vcs.
684 </p><dl>
685 <dt><i>name</i></dt>
686 <dd>
687 file/directory name to be diffed (string)
688 </dd>
689 </dl><dl>
690 <dt>Raises <b>RuntimeError</b>:</dt>
691 <dd>
692 to indicate that this method must be
693 implemented by a subclass
694 </dd>
695 </dl><a NAME="VersionControl.vcsExists" ID="VersionControl.vcsExists"></a>
696 <h4>VersionControl.vcsExists</h4>
697 <b>vcsExists</b>(<i></i>)
698 <p>
699 Public method used to test for the presence of the vcs.
700 </p><dl>
701 <dt>Returns:</dt>
702 <dd>
703 tuple of flag indicating the existence and a string
704 giving an error message in case of failure
705 </dd>
706 </dl><dl>
707 <dt>Raises <b>RuntimeError</b>:</dt>
708 <dd>
709 to indicate that this method must be
710 implemented by a subclass
711 </dd>
712 </dl><a NAME="VersionControl.vcsExport" ID="VersionControl.vcsExport"></a>
713 <h4>VersionControl.vcsExport</h4>
714 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
715 <p>
716 Public method used to export a directory from the vcs.
717 </p><dl>
718 <dt><i>vcsDataDict</i></dt>
719 <dd>
720 dictionary of data required for the export
721 </dd><dt><i>projectDir</i></dt>
722 <dd>
723 project directory to create (string)
724 </dd>
725 </dl><dl>
726 <dt>Returns:</dt>
727 <dd>
728 flag indicating an execution without errors (boolean)
729 </dd>
730 </dl><dl>
731 <dt>Raises <b>RuntimeError</b>:</dt>
732 <dd>
733 to indicate that this method must be
734 implemented by a subclass
735 </dd>
736 </dl><a NAME="VersionControl.vcsGetOptions" ID="VersionControl.vcsGetOptions"></a>
737 <h4>VersionControl.vcsGetOptions</h4>
738 <b>vcsGetOptions</b>(<i></i>)
739 <p>
740 Public method used to retrieve the options of the vcs.
741 </p><dl>
742 <dt>Returns:</dt>
743 <dd>
744 a dictionary of option strings that can be passed to
745 vcsSetOptions.
746 </dd>
747 </dl><a NAME="VersionControl.vcsGetOtherData" ID="VersionControl.vcsGetOtherData"></a>
748 <h4>VersionControl.vcsGetOtherData</h4>
749 <b>vcsGetOtherData</b>(<i></i>)
750 <p>
751 Public method used to retrieve vcs specific data.
752 </p><dl>
753 <dt>Returns:</dt>
754 <dd>
755 a dictionary of vcs specific data
756 </dd>
757 </dl><a NAME="VersionControl.vcsGetProjectBrowserHelper" ID="VersionControl.vcsGetProjectBrowserHelper"></a>
758 <h4>VersionControl.vcsGetProjectBrowserHelper</h4>
759 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
760 <p>
761 Public method to instanciate a helper object for the different
762 project browsers.
763 </p><dl>
764 <dt><i>browser</i></dt>
765 <dd>
766 reference to the project browser object
767 </dd><dt><i>project</i></dt>
768 <dd>
769 reference to the project object
770 </dd><dt><i>isTranslationsBrowser</i></dt>
771 <dd>
772 flag indicating, the helper is requested
773 for the translations browser (this needs some special treatment)
774 </dd>
775 </dl><dl>
776 <dt>Returns:</dt>
777 <dd>
778 the project browser helper object
779 </dd>
780 </dl><dl>
781 <dt>Raises <b>RuntimeError</b>:</dt>
782 <dd>
783 to indicate that this method must be
784 implemented by a subclass
785 </dd>
786 </dl><a NAME="VersionControl.vcsGetProjectHelper" ID="VersionControl.vcsGetProjectHelper"></a>
787 <h4>VersionControl.vcsGetProjectHelper</h4>
788 <b>vcsGetProjectHelper</b>(<i>project</i>)
789 <p>
790 Public method to instanciate a helper object for the project.
791 </p><dl>
792 <dt><i>project</i></dt>
793 <dd>
794 reference to the project object
795 </dd>
796 </dl><dl>
797 <dt>Returns:</dt>
798 <dd>
799 the project helper object
800 </dd>
801 </dl><dl>
802 <dt>Raises <b>RuntimeError</b>:</dt>
803 <dd>
804 to indicate that this method must be
805 implemented by a subclass
806 </dd>
807 </dl><a NAME="VersionControl.vcsImport" ID="VersionControl.vcsImport"></a>
808 <h4>VersionControl.vcsImport</h4>
809 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
810 <p>
811 Public method used to import the project into the vcs.
812 </p><dl>
813 <dt><i>vcsDataDict</i></dt>
814 <dd>
815 dictionary of data required for the import
816 </dd><dt><i>projectDir</i></dt>
817 <dd>
818 project directory (string)
819 </dd><dt><i>noDialog</i></dt>
820 <dd>
821 flag indicating quiet operations
822 </dd>
823 </dl><dl>
824 <dt>Returns:</dt>
825 <dd>
826 flag indicating an execution without errors (boolean)
827 and a flag indicating the version controll status (boolean)
828 </dd>
829 </dl><dl>
830 <dt>Raises <b>RuntimeError</b>:</dt>
831 <dd>
832 to indicate that this method must be
833 implemented by a subclass
834 </dd>
835 </dl><a NAME="VersionControl.vcsInit" ID="VersionControl.vcsInit"></a>
836 <h4>VersionControl.vcsInit</h4>
837 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
838 <p>
839 Public method used to initialize the vcs.
840 </p><dl>
841 <dt><i>vcsDir</i></dt>
842 <dd>
843 name of the VCS directory (string)
844 </dd><dt><i>noDialog</i></dt>
845 <dd>
846 flag indicating quiet operations (boolean)
847 </dd>
848 </dl><dl>
849 <dt>Returns:</dt>
850 <dd>
851 flag indicating success (boolean)
852 </dd>
853 </dl><dl>
854 <dt>Raises <b>RuntimeError</b>:</dt>
855 <dd>
856 to indicate that this method must be
857 implemented by a subclass
858 </dd>
859 </dl><a NAME="VersionControl.vcsInitConfig" ID="VersionControl.vcsInitConfig"></a>
860 <h4>VersionControl.vcsInitConfig</h4>
861 <b>vcsInitConfig</b>(<i>project</i>)
862 <p>
863 Public method to initialize the VCS configuration.
864 </p><p>
865 This method could ensure, that certain files or directories are
866 exclude from being version controlled.
867 </p><dl>
868 <dt><i>project</i></dt>
869 <dd>
870 reference to the project (Project)
871 </dd>
872 </dl><a NAME="VersionControl.vcsLogBrowser" ID="VersionControl.vcsLogBrowser"></a>
873 <h4>VersionControl.vcsLogBrowser</h4>
874 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>)
875 <p>
876 Public method used to view the log of a file/directory in the vcs
877 with a log browser dialog.
878 </p><dl>
879 <dt><i>name</i></dt>
880 <dd>
881 file/directory name to show the log for (string)
882 </dd><dt><i>isFile=</i></dt>
883 <dd>
884 flag indicating log for a file is to be shown
885 (boolean)
886 </dd>
887 </dl><dl>
888 <dt>Raises <b>RuntimeError</b>:</dt>
889 <dd>
890 to indicate that this method must be
891 implemented by a subclass
892 </dd>
893 </dl><a NAME="VersionControl.vcsMerge" ID="VersionControl.vcsMerge"></a>
894 <h4>VersionControl.vcsMerge</h4>
895 <b>vcsMerge</b>(<i>name</i>)
896 <p>
897 Public method used to merge a tag/branch into the local project.
898 </p><dl>
899 <dt><i>name</i></dt>
900 <dd>
901 file/directory name to be merged (string)
902 </dd>
903 </dl><dl>
904 <dt>Raises <b>RuntimeError</b>:</dt>
905 <dd>
906 to indicate that this method must be
907 implemented by a subclass
908 </dd>
909 </dl><a NAME="VersionControl.vcsMove" ID="VersionControl.vcsMove"></a>
910 <h4>VersionControl.vcsMove</h4>
911 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>)
912 <p>
913 Public method used to move a file/directory.
914 </p><dl>
915 <dt><i>name</i></dt>
916 <dd>
917 file/directory name to be moved (string)
918 </dd><dt><i>project</i></dt>
919 <dd>
920 reference to the project object
921 </dd><dt><i>target</i></dt>
922 <dd>
923 new name of the file/directory (string)
924 </dd><dt><i>noDialog</i></dt>
925 <dd>
926 flag indicating quiet operations
927 </dd>
928 </dl><dl>
929 <dt>Returns:</dt>
930 <dd>
931 flag indicating successfull operation (boolean)
932 </dd>
933 </dl><dl>
934 <dt>Raises <b>RuntimeError</b>:</dt>
935 <dd>
936 to indicate that this method must be
937 implemented by a subclass
938 </dd>
939 </dl><a NAME="VersionControl.vcsName" ID="VersionControl.vcsName"></a>
940 <h4>VersionControl.vcsName</h4>
941 <b>vcsName</b>(<i></i>)
942 <p>
943 Public method returning the name of the vcs.
944 </p><dl>
945 <dt>Returns:</dt>
946 <dd>
947 name of the vcs (string)
948 </dd>
949 </dl><dl>
950 <dt>Raises <b>RuntimeError</b>:</dt>
951 <dd>
952 to indicate that this method must be
953 implemented by a subclass
954 </dd>
955 </dl><a NAME="VersionControl.vcsNewProjectOptionsDialog" ID="VersionControl.vcsNewProjectOptionsDialog"></a>
956 <h4>VersionControl.vcsNewProjectOptionsDialog</h4>
957 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>)
958 <p>
959 Public method to get a dialog to enter repository info for getting a
960 new project.
961 </p><dl>
962 <dt><i>parent</i></dt>
963 <dd>
964 parent widget (QWidget)
965 </dd>
966 </dl><dl>
967 <dt>Raises <b>RuntimeError</b>:</dt>
968 <dd>
969 to indicate that this method must be
970 implemented by a subclass
971 </dd>
972 </dl><a NAME="VersionControl.vcsOptionsDialog" ID="VersionControl.vcsOptionsDialog"></a>
973 <h4>VersionControl.vcsOptionsDialog</h4>
974 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>)
975 <p>
976 Public method to get a dialog to enter repository info.
977 </p><dl>
978 <dt><i>project</i></dt>
979 <dd>
980 reference to the project object
981 </dd><dt><i>archive</i></dt>
982 <dd>
983 name of the project in the repository (string)
984 </dd><dt><i>editable</i></dt>
985 <dd>
986 flag indicating that the project name is editable
987 (boolean)
988 </dd><dt><i>parent</i></dt>
989 <dd>
990 parent widget (QWidget)
991 </dd>
992 </dl><dl>
993 <dt>Raises <b>RuntimeError</b>:</dt>
994 <dd>
995 to indicate that this method must be
996 implemented by a subclass
997 </dd>
998 </dl><a NAME="VersionControl.vcsRegisteredState" ID="VersionControl.vcsRegisteredState"></a>
999 <h4>VersionControl.vcsRegisteredState</h4>
1000 <b>vcsRegisteredState</b>(<i>name</i>)
1001 <p>
1002 Public method used to get the registered state of a file in the vcs.
1003 </p><dl>
1004 <dt><i>name</i></dt>
1005 <dd>
1006 filename to check (string)
1007 </dd>
1008 </dl><dl>
1009 <dt>Returns:</dt>
1010 <dd>
1011 a combination of canBeCommited and canBeAdded or
1012 0 in order to signal an error
1013 </dd>
1014 </dl><dl>
1015 <dt>Raises <b>RuntimeError</b>:</dt>
1016 <dd>
1017 to indicate that this method must be
1018 implemented by a subclass
1019 </dd>
1020 </dl><a NAME="VersionControl.vcsRemove" ID="VersionControl.vcsRemove"></a>
1021 <h4>VersionControl.vcsRemove</h4>
1022 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
1023 <p>
1024 Public method used to add a file/directory in the vcs.
1025 </p><dl>
1026 <dt><i>name</i></dt>
1027 <dd>
1028 file/directory name to be removed (string)
1029 </dd><dt><i>project</i></dt>
1030 <dd>
1031 flag indicating deletion of a project tree (boolean)
1032 </dd><dt><i>noDialog</i></dt>
1033 <dd>
1034 flag indicating quiet operations
1035 </dd>
1036 </dl><dl>
1037 <dt>Returns:</dt>
1038 <dd>
1039 flag indicating success (boolean)
1040 </dd>
1041 </dl><dl>
1042 <dt>Raises <b>RuntimeError</b>:</dt>
1043 <dd>
1044 to indicate that this method must be
1045 implemented by a subclass
1046 </dd>
1047 </dl><a NAME="VersionControl.vcsRepositoryInfos" ID="VersionControl.vcsRepositoryInfos"></a>
1048 <h4>VersionControl.vcsRepositoryInfos</h4>
1049 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
1050 <p>
1051 Public method to retrieve information about the repository.
1052 </p><dl>
1053 <dt><i>ppath</i></dt>
1054 <dd>
1055 local path to get the repository infos (string)
1056 </dd>
1057 </dl><dl>
1058 <dt>Returns:</dt>
1059 <dd>
1060 string with ready formated info for display (string)
1061 </dd>
1062 </dl><dl>
1063 <dt>Raises <b>RuntimeError</b>:</dt>
1064 <dd>
1065 to indicate that this method must be
1066 implemented by a subclass
1067 </dd>
1068 </dl><a NAME="VersionControl.vcsRevert" ID="VersionControl.vcsRevert"></a>
1069 <h4>VersionControl.vcsRevert</h4>
1070 <b>vcsRevert</b>(<i>name</i>)
1071 <p>
1072 Public method used to revert changes made to a file/directory.
1073 </p><dl>
1074 <dt><i>name</i></dt>
1075 <dd>
1076 file/directory name to be reverted (string)
1077 </dd>
1078 </dl><dl>
1079 <dt>Raises <b>RuntimeError</b>:</dt>
1080 <dd>
1081 to indicate that this method must be
1082 implemented by a subclass
1083 </dd>
1084 </dl><a NAME="VersionControl.vcsSetData" ID="VersionControl.vcsSetData"></a>
1085 <h4>VersionControl.vcsSetData</h4>
1086 <b>vcsSetData</b>(<i>key, value</i>)
1087 <p>
1088 Public method used to set an entry in the otherData dictionary.
1089 </p><dl>
1090 <dt><i>key</i></dt>
1091 <dd>
1092 the key of the data (string)
1093 </dd><dt><i>value</i></dt>
1094 <dd>
1095 the value of the data
1096 </dd>
1097 </dl><a NAME="VersionControl.vcsSetDataFromDict" ID="VersionControl.vcsSetDataFromDict"></a>
1098 <h4>VersionControl.vcsSetDataFromDict</h4>
1099 <b>vcsSetDataFromDict</b>(<i>dictionary</i>)
1100 <p>
1101 Public method used to set entries in the otherData dictionary.
1102 </p><dl>
1103 <dt><i>dictionary</i></dt>
1104 <dd>
1105 dictionary to pick entries from
1106 </dd>
1107 </dl><a NAME="VersionControl.vcsSetOptions" ID="VersionControl.vcsSetOptions"></a>
1108 <h4>VersionControl.vcsSetOptions</h4>
1109 <b>vcsSetOptions</b>(<i>options</i>)
1110 <p>
1111 Public method used to set the options for the vcs.
1112 </p><dl>
1113 <dt><i>options</i></dt>
1114 <dd>
1115 a dictionary of option strings with keys as
1116 defined by the default options
1117 </dd>
1118 </dl><a NAME="VersionControl.vcsSetOtherData" ID="VersionControl.vcsSetOtherData"></a>
1119 <h4>VersionControl.vcsSetOtherData</h4>
1120 <b>vcsSetOtherData</b>(<i>data</i>)
1121 <p>
1122 Public method used to set vcs specific data.
1123 </p><dl>
1124 <dt><i>data</i></dt>
1125 <dd>
1126 a dictionary of vcs specific data
1127 </dd>
1128 </dl><a NAME="VersionControl.vcsShutdown" ID="VersionControl.vcsShutdown"></a>
1129 <h4>VersionControl.vcsShutdown</h4>
1130 <b>vcsShutdown</b>(<i></i>)
1131 <p>
1132 Public method used to shutdown the vcs interface.
1133 </p><dl>
1134 <dt>Raises <b>RuntimeError</b>:</dt>
1135 <dd>
1136 to indicate that this method must be
1137 implemented by a subclass
1138 </dd>
1139 </dl><a NAME="VersionControl.vcsStatus" ID="VersionControl.vcsStatus"></a>
1140 <h4>VersionControl.vcsStatus</h4>
1141 <b>vcsStatus</b>(<i>name</i>)
1142 <p>
1143 Public method used to view the status of a file/directory in the vcs.
1144 </p><dl>
1145 <dt><i>name</i></dt>
1146 <dd>
1147 file/directory name to show the status for (string)
1148 </dd>
1149 </dl><dl>
1150 <dt>Raises <b>RuntimeError</b>:</dt>
1151 <dd>
1152 to indicate that this method must be
1153 implemented by a subclass
1154 </dd>
1155 </dl><a NAME="VersionControl.vcsSupportCommandOptions" ID="VersionControl.vcsSupportCommandOptions"></a>
1156 <h4>VersionControl.vcsSupportCommandOptions</h4>
1157 <b>vcsSupportCommandOptions</b>(<i></i>)
1158 <p>
1159 Public method to signal the support of user settable command options.
1160 </p><dl>
1161 <dt>Returns:</dt>
1162 <dd>
1163 flag indicating the support of user settable command options
1164 (boolean)
1165 </dd>
1166 </dl><a NAME="VersionControl.vcsSwitch" ID="VersionControl.vcsSwitch"></a>
1167 <h4>VersionControl.vcsSwitch</h4>
1168 <b>vcsSwitch</b>(<i>name</i>)
1169 <p>
1170 Public method used to switch a directory to a different tag/branch.
1171 </p><dl>
1172 <dt><i>name</i></dt>
1173 <dd>
1174 directory name to be switched (string)
1175 </dd>
1176 </dl><dl>
1177 <dt>Returns:</dt>
1178 <dd>
1179 flag indicating, that the switch contained an add
1180 or delete (boolean)
1181 </dd>
1182 </dl><dl>
1183 <dt>Raises <b>RuntimeError</b>:</dt>
1184 <dd>
1185 to indicate that this method must be
1186 implemented by a subclass
1187 </dd>
1188 </dl><a NAME="VersionControl.vcsTag" ID="VersionControl.vcsTag"></a>
1189 <h4>VersionControl.vcsTag</h4>
1190 <b>vcsTag</b>(<i>name</i>)
1191 <p>
1192 Public method used to set the tag of a file/directory in the vcs.
1193 </p><dl>
1194 <dt><i>name</i></dt>
1195 <dd>
1196 file/directory name to be tagged (string)
1197 </dd>
1198 </dl><dl>
1199 <dt>Raises <b>RuntimeError</b>:</dt>
1200 <dd>
1201 to indicate that this method must be
1202 implemented by a subclass
1203 </dd>
1204 </dl><a NAME="VersionControl.vcsUpdate" ID="VersionControl.vcsUpdate"></a>
1205 <h4>VersionControl.vcsUpdate</h4>
1206 <b>vcsUpdate</b>(<i>name, noDialog=False</i>)
1207 <p>
1208 Public method used to update a file/directory in the vcs.
1209 </p><dl>
1210 <dt><i>name</i></dt>
1211 <dd>
1212 file/directory name to be updated (string)
1213 </dd><dt><i>noDialog</i></dt>
1214 <dd>
1215 flag indicating quiet operations (boolean)
1216 </dd>
1217 </dl><dl>
1218 <dt>Returns:</dt>
1219 <dd>
1220 flag indicating, that the update contained an add
1221 or delete (boolean)
1222 </dd>
1223 </dl><dl>
1224 <dt>Raises <b>RuntimeError</b>:</dt>
1225 <dd>
1226 to indicate that this method must be
1227 implemented by a subclass
1228 </dd>
1229 </dl>
1230 <div align="right"><a href="#top">Up</a></div>
1231 <hr />
1232 </body></html>

Mercurial Repository: eric

eric ide

mercurial