Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.hg.html

Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.hg.html

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

Mercurial Repository: eric

eric ide

mercurial