Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.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.vcsGit.git</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.vcsGit.git</h1>
24
25 <p>
26 Module implementing the version control systems interface to Git.
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="#Git">Git</a></td>
39 <td>Class implementing the version control systems interface to Git.</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="Git" ID="Git"></a>
50 <h2>Git</h2>
51
52 <p>
53 Class implementing the version control systems interface to Git.
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>IgnoreFileName</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="#Git.__init__">Git</a></td>
81 <td>Constructor</td>
82 </tr>
83 <tr>
84 <td><a href="#Git.__gitGetFileForRevision">__gitGetFileForRevision</a></td>
85 <td>Private method to get a file for a specific revision from the repository.</td>
86 </tr>
87 <tr>
88 <td><a href="#Git.__gitGetStashesList">__gitGetStashesList</a></td>
89 <td>Private method to get a list of stash names.</td>
90 </tr>
91 <tr>
92 <td><a href="#Git.__gitSubmodulesList">__gitSubmodulesList</a></td>
93 <td>Private method to get the data of defined submodules.</td>
94 </tr>
95 <tr>
96 <td><a href="#Git.__selectSubmodulePath">__selectSubmodulePath</a></td>
97 <td>Private method to select a submodule path.</td>
98 </tr>
99 <tr>
100 <td><a href="#Git.__selectSubmodulePaths">__selectSubmodulePaths</a></td>
101 <td>Private method to select a list of submodule paths.</td>
102 </tr>
103 <tr>
104 <td><a href="#Git.__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="#Git._createStatusMonitorThread">_createStatusMonitorThread</a></td>
109 <td>Protected method to create an instance of the VCS status monitor thread.</td>
110 </tr>
111 <tr>
112 <td><a href="#Git.clearStatusCache">clearStatusCache</a></td>
113 <td>Public method to clear the status cache.</td>
114 </tr>
115 <tr>
116 <td><a href="#Git.getPlugin">getPlugin</a></td>
117 <td>Public method to get a reference to the plugin object.</td>
118 </tr>
119 <tr>
120 <td><a href="#Git.gitAddRemote">gitAddRemote</a></td>
121 <td>Public method to add a remote repository.</td>
122 </tr>
123 <tr>
124 <td><a href="#Git.gitApply">gitApply</a></td>
125 <td>Public method to apply a patch stored in a given file.</td>
126 </tr>
127 <tr>
128 <td><a href="#Git.gitApplyCheckPatches">gitApplyCheckPatches</a></td>
129 <td>Public method to apply a list of patch files or check, if they would apply cleanly.</td>
130 </tr>
131 <tr>
132 <td><a href="#Git.gitBisect">gitBisect</a></td>
133 <td>Public method to perform bisect commands.</td>
134 </tr>
135 <tr>
136 <td><a href="#Git.gitBisectCreateReplayFile">gitBisectCreateReplayFile</a></td>
137 <td>Public method used to create a bisect replay file for the project.</td>
138 </tr>
139 <tr>
140 <td><a href="#Git.gitBisectEditReplayFile">gitBisectEditReplayFile</a></td>
141 <td>Public method used to edit a bisect replay file.</td>
142 </tr>
143 <tr>
144 <td><a href="#Git.gitBisectLogBrowser">gitBisectLogBrowser</a></td>
145 <td>Public method used to browse the bisect log of the project.</td>
146 </tr>
147 <tr>
148 <td><a href="#Git.gitBisectReplay">gitBisectReplay</a></td>
149 <td>Public method to replay a bisect session.</td>
150 </tr>
151 <tr>
152 <td><a href="#Git.gitBlame">gitBlame</a></td>
153 <td>Public method to show the output of the git blame command.</td>
154 </tr>
155 <tr>
156 <td><a href="#Git.gitBranch">gitBranch</a></td>
157 <td>Public method used to create, delete or move a branch in the Git repository.</td>
158 </tr>
159 <tr>
160 <td><a href="#Git.gitBundle">gitBundle</a></td>
161 <td>Public method to create a bundle file.</td>
162 </tr>
163 <tr>
164 <td><a href="#Git.gitBundleFetch">gitBundleFetch</a></td>
165 <td>Public method to fetch a head of a bundle file into the local repository.</td>
166 </tr>
167 <tr>
168 <td><a href="#Git.gitBundleListHeads">gitBundleListHeads</a></td>
169 <td>Public method to list the heads contained in a bundle file.</td>
170 </tr>
171 <tr>
172 <td><a href="#Git.gitBundlePull">gitBundlePull</a></td>
173 <td>Public method to pull a head of a bundle file into the local repository and working area.</td>
174 </tr>
175 <tr>
176 <td><a href="#Git.gitCancelMerge">gitCancelMerge</a></td>
177 <td>Public method to cancel an uncommitted or failed merge.</td>
178 </tr>
179 <tr>
180 <td><a href="#Git.gitChangeRemoteCredentials">gitChangeRemoteCredentials</a></td>
181 <td>Public method to change the user credentials of a remote repository.</td>
182 </tr>
183 <tr>
184 <td><a href="#Git.gitChangeRemoteUrl">gitChangeRemoteUrl</a></td>
185 <td>Public method to change the URL of a remote repository.</td>
186 </tr>
187 <tr>
188 <td><a href="#Git.gitCherryPick">gitCherryPick</a></td>
189 <td>Public method to cherry pick commits and apply them to the current branch.</td>
190 </tr>
191 <tr>
192 <td><a href="#Git.gitCherryPickAbort">gitCherryPickAbort</a></td>
193 <td>Public method to cancel the last copying session and return to the previous state.</td>
194 </tr>
195 <tr>
196 <td><a href="#Git.gitCherryPickContinue">gitCherryPickContinue</a></td>
197 <td>Public method to continue the last copying session after conflicts were resolved.</td>
198 </tr>
199 <tr>
200 <td><a href="#Git.gitCherryPickQuit">gitCherryPickQuit</a></td>
201 <td>Public method to quit the current copying operation.</td>
202 </tr>
203 <tr>
204 <td><a href="#Git.gitCommitMerge">gitCommitMerge</a></td>
205 <td>Public method to commit a failed merge.</td>
206 </tr>
207 <tr>
208 <td><a href="#Git.gitCopy">gitCopy</a></td>
209 <td>Public method used to copy a file/directory.</td>
210 </tr>
211 <tr>
212 <td><a href="#Git.gitCreateArchive">gitCreateArchive</a></td>
213 <td>Public method to show some statistics of the local repository.</td>
214 </tr>
215 <tr>
216 <td><a href="#Git.gitCreateIgnoreFile">gitCreateIgnoreFile</a></td>
217 <td>Public method to create the ignore file.</td>
218 </tr>
219 <tr>
220 <td><a href="#Git.gitDeleteRemoteBranch">gitDeleteRemoteBranch</a></td>
221 <td>Public method to delete a branch from a remote repository.</td>
222 </tr>
223 <tr>
224 <td><a href="#Git.gitDescribe">gitDescribe</a></td>
225 <td>Public method to find the most recent tag reachable from each commit.</td>
226 </tr>
227 <tr>
228 <td><a href="#Git.gitEditConfig">gitEditConfig</a></td>
229 <td>Public method used to edit the repository configuration file.</td>
230 </tr>
231 <tr>
232 <td><a href="#Git.gitEditUserConfig">gitEditUserConfig</a></td>
233 <td>Public method used to edit the user configuration file.</td>
234 </tr>
235 <tr>
236 <td><a href="#Git.gitExtendedDiff">gitExtendedDiff</a></td>
237 <td>Public method used to view the difference of a file/directory to the Git repository.</td>
238 </tr>
239 <tr>
240 <td><a href="#Git.gitFetch">gitFetch</a></td>
241 <td>Public method to fetch changes from a remote repository.</td>
242 </tr>
243 <tr>
244 <td><a href="#Git.gitGetArchiveFormats">gitGetArchiveFormats</a></td>
245 <td>Public method to get a list of supported archive formats.</td>
246 </tr>
247 <tr>
248 <td><a href="#Git.gitGetBranchesList">gitGetBranchesList</a></td>
249 <td>Public method to get the list of branches.</td>
250 </tr>
251 <tr>
252 <td><a href="#Git.gitGetBundleHeads">gitGetBundleHeads</a></td>
253 <td>Public method to get a list of heads contained in a bundle file.</td>
254 </tr>
255 <tr>
256 <td><a href="#Git.gitGetCurrentBranch">gitGetCurrentBranch</a></td>
257 <td>Public method used to show the current branch of the working directory.</td>
258 </tr>
259 <tr>
260 <td><a href="#Git.gitGetRemoteBranchesList">gitGetRemoteBranchesList</a></td>
261 <td>Public method to get the list of a remote repository branches.</td>
262 </tr>
263 <tr>
264 <td><a href="#Git.gitGetRemoteUrl">gitGetRemoteUrl</a></td>
265 <td>Public method to get the URL of a remote repository.</td>
266 </tr>
267 <tr>
268 <td><a href="#Git.gitGetRemoteUrlsList">gitGetRemoteUrlsList</a></td>
269 <td>Public method to get the list of remote repos and their URLs.</td>
270 </tr>
271 <tr>
272 <td><a href="#Git.gitGetRemotesList">gitGetRemotesList</a></td>
273 <td>Public method to get the list of remote repos.</td>
274 </tr>
275 <tr>
276 <td><a href="#Git.gitGetTagsList">gitGetTagsList</a></td>
277 <td>Public method to get the list of tags.</td>
278 </tr>
279 <tr>
280 <td><a href="#Git.gitHouseKeeping">gitHouseKeeping</a></td>
281 <td>Public method to cleanup and optimize the local repository.</td>
282 </tr>
283 <tr>
284 <td><a href="#Git.gitListTagBranch">gitListTagBranch</a></td>
285 <td>Public method used to list the available tags or branches.</td>
286 </tr>
287 <tr>
288 <td><a href="#Git.gitNormalizeURL">gitNormalizeURL</a></td>
289 <td>Public method to normalize a url for Git.</td>
290 </tr>
291 <tr>
292 <td><a href="#Git.gitPruneRemote">gitPruneRemote</a></td>
293 <td>Public method to prune stale remote-tracking branches.</td>
294 </tr>
295 <tr>
296 <td><a href="#Git.gitPull">gitPull</a></td>
297 <td>Public method used to pull changes from a remote Git repository.</td>
298 </tr>
299 <tr>
300 <td><a href="#Git.gitPush">gitPush</a></td>
301 <td>Public method used to push changes to a remote Git repository.</td>
302 </tr>
303 <tr>
304 <td><a href="#Git.gitReflogBrowser">gitReflogBrowser</a></td>
305 <td>Public method used to browse the reflog of the project.</td>
306 </tr>
307 <tr>
308 <td><a href="#Git.gitRemoveRemote">gitRemoveRemote</a></td>
309 <td>Public method to remove a remote repository.</td>
310 </tr>
311 <tr>
312 <td><a href="#Git.gitRenameRemote">gitRenameRemote</a></td>
313 <td>Public method to rename a remote repository.</td>
314 </tr>
315 <tr>
316 <td><a href="#Git.gitRevert">gitRevert</a></td>
317 <td>Public method used to revert changes made to a file/directory.</td>
318 </tr>
319 <tr>
320 <td><a href="#Git.gitSbsDiff">gitSbsDiff</a></td>
321 <td>Public method used to view the difference of a file to the Git repository side-by-side.</td>
322 </tr>
323 <tr>
324 <td><a href="#Git.gitShortlog">gitShortlog</a></td>
325 <td>Public method to show a short log suitable for inclusion in release announcements.</td>
326 </tr>
327 <tr>
328 <td><a href="#Git.gitShowBranch">gitShowBranch</a></td>
329 <td>Public method used to show the current branch of the working directory.</td>
330 </tr>
331 <tr>
332 <td><a href="#Git.gitShowConfig">gitShowConfig</a></td>
333 <td>Public method to show the combined configuration.</td>
334 </tr>
335 <tr>
336 <td><a href="#Git.gitShowPatchesStatistics">gitShowPatchesStatistics</a></td>
337 <td>Public method to show statistics for a set of patch files.</td>
338 </tr>
339 <tr>
340 <td><a href="#Git.gitShowRemote">gitShowRemote</a></td>
341 <td>Public method to show information about a remote repository.</td>
342 </tr>
343 <tr>
344 <td><a href="#Git.gitShowRemotes">gitShowRemotes</a></td>
345 <td>Public method to show available remote repositories.</td>
346 </tr>
347 <tr>
348 <td><a href="#Git.gitStashApply">gitStashApply</a></td>
349 <td>Public method to apply a stash but keep it.</td>
350 </tr>
351 <tr>
352 <td><a href="#Git.gitStashBranch">gitStashBranch</a></td>
353 <td>Public method to create a branch from a stash.</td>
354 </tr>
355 <tr>
356 <td><a href="#Git.gitStashBrowser">gitStashBrowser</a></td>
357 <td>Public method used to browse the stashed changes.</td>
358 </tr>
359 <tr>
360 <td><a href="#Git.gitStashClear">gitStashClear</a></td>
361 <td>Public method to delete all stashes.</td>
362 </tr>
363 <tr>
364 <td><a href="#Git.gitStashDrop">gitStashDrop</a></td>
365 <td>Public method to delete a stash.</td>
366 </tr>
367 <tr>
368 <td><a href="#Git.gitStashPop">gitStashPop</a></td>
369 <td>Public method to apply a stash and delete it.</td>
370 </tr>
371 <tr>
372 <td><a href="#Git.gitStashSave">gitStashSave</a></td>
373 <td>Public method to save the current changes to a new stash.</td>
374 </tr>
375 <tr>
376 <td><a href="#Git.gitStashShowPatch">gitStashShowPatch</a></td>
377 <td>Public method to show the contents of a stash.</td>
378 </tr>
379 <tr>
380 <td><a href="#Git.gitStatistics">gitStatistics</a></td>
381 <td>Public method to show some statistics of the local repository.</td>
382 </tr>
383 <tr>
384 <td><a href="#Git.gitSubmoduleAdd">gitSubmoduleAdd</a></td>
385 <td>Public method to add a submodule to the project.</td>
386 </tr>
387 <tr>
388 <td><a href="#Git.gitSubmoduleDeinit">gitSubmoduleDeinit</a></td>
389 <td>Public method to unregister submodules.</td>
390 </tr>
391 <tr>
392 <td><a href="#Git.gitSubmoduleInit">gitSubmoduleInit</a></td>
393 <td>Public method to initialize one or all submodules.</td>
394 </tr>
395 <tr>
396 <td><a href="#Git.gitSubmoduleList">gitSubmoduleList</a></td>
397 <td>Public method to show a list of all submodules of the project.</td>
398 </tr>
399 <tr>
400 <td><a href="#Git.gitSubmoduleStatus">gitSubmoduleStatus</a></td>
401 <td>Public method to show the status of the submodules.</td>
402 </tr>
403 <tr>
404 <td><a href="#Git.gitSubmoduleSummary">gitSubmoduleSummary</a></td>
405 <td>Public method to show the status of the submodules.</td>
406 </tr>
407 <tr>
408 <td><a href="#Git.gitSubmoduleSync">gitSubmoduleSync</a></td>
409 <td>Public method to synchronize submodules.</td>
410 </tr>
411 <tr>
412 <td><a href="#Git.gitSubmoduleUpdate">gitSubmoduleUpdate</a></td>
413 <td>Public method to update submodules.</td>
414 </tr>
415 <tr>
416 <td><a href="#Git.gitSubmoduleUpdateWithOptions">gitSubmoduleUpdateWithOptions</a></td>
417 <td>Public method to update submodules offering a dialog to select the update options.</td>
418 </tr>
419 <tr>
420 <td><a href="#Git.gitUnstage">gitUnstage</a></td>
421 <td>Public method used to unstage a file/directory.</td>
422 </tr>
423 <tr>
424 <td><a href="#Git.gitVerify">gitVerify</a></td>
425 <td>Public method to verify the connectivity and validity of objects of the database.</td>
426 </tr>
427 <tr>
428 <td><a href="#Git.gitVerifyBundle">gitVerifyBundle</a></td>
429 <td>Public method to verify a bundle file.</td>
430 </tr>
431 <tr>
432 <td><a href="#Git.initCommand">initCommand</a></td>
433 <td>Public method to initialize a command arguments list.</td>
434 </tr>
435 <tr>
436 <td><a href="#Git.vcsAdd">vcsAdd</a></td>
437 <td>Public method used to add a file/directory to the Git repository.</td>
438 </tr>
439 <tr>
440 <td><a href="#Git.vcsAddBinary">vcsAddBinary</a></td>
441 <td>Public method used to add a file/directory in binary mode to the Git repository.</td>
442 </tr>
443 <tr>
444 <td><a href="#Git.vcsAddTree">vcsAddTree</a></td>
445 <td>Public method to add a directory tree rooted at path to the Git repository.</td>
446 </tr>
447 <tr>
448 <td><a href="#Git.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
449 <td>Public method used to get the registered states of a number of files in the vcs.</td>
450 </tr>
451 <tr>
452 <td><a href="#Git.vcsCheckout">vcsCheckout</a></td>
453 <td>Public method used to check the project out of a Git repository (clone).</td>
454 </tr>
455 <tr>
456 <td><a href="#Git.vcsCleanup">vcsCleanup</a></td>
457 <td>Public method used to cleanup the working directory.</td>
458 </tr>
459 <tr>
460 <td><a href="#Git.vcsCommandLine">vcsCommandLine</a></td>
461 <td>Public method used to execute arbitrary Git commands.</td>
462 </tr>
463 <tr>
464 <td><a href="#Git.vcsCommit">vcsCommit</a></td>
465 <td>Public method used to make the change of a file/directory permanent in the Git repository.</td>
466 </tr>
467 <tr>
468 <td><a href="#Git.vcsConvertProject">vcsConvertProject</a></td>
469 <td>Public method to convert an uncontrolled project to a version controlled project.</td>
470 </tr>
471 <tr>
472 <td><a href="#Git.vcsDiff">vcsDiff</a></td>
473 <td>Public method used to view the difference of a file/directory to the Git repository.</td>
474 </tr>
475 <tr>
476 <td><a href="#Git.vcsExists">vcsExists</a></td>
477 <td>Public method used to test for the presence of the git executable.</td>
478 </tr>
479 <tr>
480 <td><a href="#Git.vcsExport">vcsExport</a></td>
481 <td>Public method used to export a directory from the Git repository.</td>
482 </tr>
483 <tr>
484 <td><a href="#Git.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
485 <td>Public method to instantiate a helper object for the different project browsers.</td>
486 </tr>
487 <tr>
488 <td><a href="#Git.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
489 <td>Public method to instantiate a helper object for the project.</td>
490 </tr>
491 <tr>
492 <td><a href="#Git.vcsImport">vcsImport</a></td>
493 <td>Public method used to import the project into the Git repository.</td>
494 </tr>
495 <tr>
496 <td><a href="#Git.vcsInit">vcsInit</a></td>
497 <td>Public method used to initialize the Git repository.</td>
498 </tr>
499 <tr>
500 <td><a href="#Git.vcsInitConfig">vcsInitConfig</a></td>
501 <td>Public method to initialize the VCS configuration.</td>
502 </tr>
503 <tr>
504 <td><a href="#Git.vcsLogBrowser">vcsLogBrowser</a></td>
505 <td>Public method used to browse the log of a file/directory from the Git repository.</td>
506 </tr>
507 <tr>
508 <td><a href="#Git.vcsMerge">vcsMerge</a></td>
509 <td>Public method used to merge a URL/revision into the local project.</td>
510 </tr>
511 <tr>
512 <td><a href="#Git.vcsMove">vcsMove</a></td>
513 <td>Public method used to move a file/directory.</td>
514 </tr>
515 <tr>
516 <td><a href="#Git.vcsName">vcsName</a></td>
517 <td>Public method returning the name of the vcs.</td>
518 </tr>
519 <tr>
520 <td><a href="#Git.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td>
521 <td>Public method to get a dialog to enter repository info for getting a new project.</td>
522 </tr>
523 <tr>
524 <td><a href="#Git.vcsOptionsDialog">vcsOptionsDialog</a></td>
525 <td>Public method to get a dialog to enter repository info.</td>
526 </tr>
527 <tr>
528 <td><a href="#Git.vcsRegisteredState">vcsRegisteredState</a></td>
529 <td>Public method used to get the registered state of a file in the vcs.</td>
530 </tr>
531 <tr>
532 <td><a href="#Git.vcsRemove">vcsRemove</a></td>
533 <td>Public method used to remove a file/directory from the Git repository.</td>
534 </tr>
535 <tr>
536 <td><a href="#Git.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
537 <td>Public method to retrieve information about the repository.</td>
538 </tr>
539 <tr>
540 <td><a href="#Git.vcsShutdown">vcsShutdown</a></td>
541 <td>Public method used to shutdown the Git interface.</td>
542 </tr>
543 <tr>
544 <td><a href="#Git.vcsStatus">vcsStatus</a></td>
545 <td>Public method used to view the status of files/directories in the Git repository.</td>
546 </tr>
547 <tr>
548 <td><a href="#Git.vcsSupportCommandOptions">vcsSupportCommandOptions</a></td>
549 <td>Public method to signal the support of user settable command options.</td>
550 </tr>
551 <tr>
552 <td><a href="#Git.vcsSwitch">vcsSwitch</a></td>
553 <td>Public method used to switch a working directory to a different revision.</td>
554 </tr>
555 <tr>
556 <td><a href="#Git.vcsTag">vcsTag</a></td>
557 <td>Public method used to set/remove a tag in the Git repository.</td>
558 </tr>
559 <tr>
560 <td><a href="#Git.vcsUpdate">vcsUpdate</a></td>
561 <td>Public method used to update a file/directory with the Git repository.</td>
562 </tr>
563 </table>
564 <h3>Static Methods</h3>
565
566 <table>
567 <tr><td>None</td></tr>
568 </table>
569
570 <a NAME="Git.__init__" ID="Git.__init__"></a>
571 <h4>Git (Constructor)</h4>
572 <b>Git</b>(<i>plugin, parent=None, name=None</i>)
573
574 <p>
575 Constructor
576 </p>
577 <dl>
578
579 <dt><i>plugin</i></dt>
580 <dd>
581 reference to the plugin object
582 </dd>
583 <dt><i>parent</i></dt>
584 <dd>
585 parent widget (QWidget)
586 </dd>
587 <dt><i>name</i></dt>
588 <dd>
589 name of this object (string)
590 </dd>
591 </dl>
592 <a NAME="Git.__gitGetFileForRevision" ID="Git.__gitGetFileForRevision"></a>
593 <h4>Git.__gitGetFileForRevision</h4>
594 <b>__gitGetFileForRevision</b>(<i>name, rev=""</i>)
595
596 <p>
597 Private method to get a file for a specific revision from the
598 repository.
599 </p>
600 <dl>
601
602 <dt><i>name</i></dt>
603 <dd>
604 file name to get from the repository (string)
605 </dd>
606 <dt><i>rev</i></dt>
607 <dd>
608 revision to retrieve (string)
609 </dd>
610 </dl>
611 <dl>
612 <dt>Return:</dt>
613 <dd>
614 contents of the file (string) and an error message (string)
615 </dd>
616 </dl>
617 <a NAME="Git.__gitGetStashesList" ID="Git.__gitGetStashesList"></a>
618 <h4>Git.__gitGetStashesList</h4>
619 <b>__gitGetStashesList</b>(<i>projectDir</i>)
620
621 <p>
622 Private method to get a list of stash names.
623 </p>
624 <dl>
625
626 <dt><i>projectDir</i></dt>
627 <dd>
628 name of the project directory (string)
629 </dd>
630 </dl>
631 <dl>
632 <dt>Return:</dt>
633 <dd>
634 list of available stashes (list of string)
635 </dd>
636 </dl>
637 <a NAME="Git.__gitSubmodulesList" ID="Git.__gitSubmodulesList"></a>
638 <h4>Git.__gitSubmodulesList</h4>
639 <b>__gitSubmodulesList</b>(<i>repodir</i>)
640
641 <p>
642 Private method to get the data of defined submodules.
643 </p>
644 <dl>
645
646 <dt><i>repodir</i> (str)</dt>
647 <dd>
648 name of the directory containing the repo subdirectory
649 </dd>
650 </dl>
651 <dl>
652 <dt>Return:</dt>
653 <dd>
654 list of dictionaries with submodule name, path, URL and branch
655 </dd>
656 </dl>
657 <dl>
658 <dt>Return Type:</dt>
659 <dd>
660 list of dict
661 </dd>
662 </dl>
663 <a NAME="Git.__selectSubmodulePath" ID="Git.__selectSubmodulePath"></a>
664 <h4>Git.__selectSubmodulePath</h4>
665 <b>__selectSubmodulePath</b>(<i>repodir</i>)
666
667 <p>
668 Private method to select a submodule path.
669 </p>
670 <dl>
671
672 <dt><i>repodir</i> (str)</dt>
673 <dd>
674 name of the directory containing the repo subdirectory
675 </dd>
676 </dl>
677 <dl>
678 <dt>Return:</dt>
679 <dd>
680 tuple of selected submodule path and flag indicating
681 a cancellation
682 </dd>
683 </dl>
684 <dl>
685 <dt>Return Type:</dt>
686 <dd>
687 tuple of (str, bool)
688 </dd>
689 </dl>
690 <a NAME="Git.__selectSubmodulePaths" ID="Git.__selectSubmodulePaths"></a>
691 <h4>Git.__selectSubmodulePaths</h4>
692 <b>__selectSubmodulePaths</b>(<i>repodir</i>)
693
694 <p>
695 Private method to select a list of submodule paths.
696 </p>
697 <dl>
698
699 <dt><i>repodir</i> (str)</dt>
700 <dd>
701 name of the directory containing the repo subdirectory
702 </dd>
703 </dl>
704 <dl>
705 <dt>Return:</dt>
706 <dd>
707 tuple of selected submodule paths and flag indicating
708 a cancellation
709 </dd>
710 </dl>
711 <dl>
712 <dt>Return Type:</dt>
713 <dd>
714 tuple of (list of str, bool)
715 </dd>
716 </dl>
717 <a NAME="Git.__vcsCommit_Step2" ID="Git.__vcsCommit_Step2"></a>
718 <h4>Git.__vcsCommit_Step2</h4>
719 <b>__vcsCommit_Step2</b>(<i></i>)
720
721 <p>
722 Private slot performing the second step of the commit action.
723 </p>
724 <a NAME="Git._createStatusMonitorThread" ID="Git._createStatusMonitorThread"></a>
725 <h4>Git._createStatusMonitorThread</h4>
726 <b>_createStatusMonitorThread</b>(<i>interval, project</i>)
727
728 <p>
729 Protected method to create an instance of the VCS status monitor
730 thread.
731 </p>
732 <dl>
733
734 <dt><i>interval</i></dt>
735 <dd>
736 check interval for the monitor thread in seconds
737 (integer)
738 </dd>
739 <dt><i>project</i></dt>
740 <dd>
741 reference to the project object (Project)
742 </dd>
743 </dl>
744 <dl>
745 <dt>Return:</dt>
746 <dd>
747 reference to the monitor thread (QThread)
748 </dd>
749 </dl>
750 <a NAME="Git.clearStatusCache" ID="Git.clearStatusCache"></a>
751 <h4>Git.clearStatusCache</h4>
752 <b>clearStatusCache</b>(<i></i>)
753
754 <p>
755 Public method to clear the status cache.
756 </p>
757 <a NAME="Git.getPlugin" ID="Git.getPlugin"></a>
758 <h4>Git.getPlugin</h4>
759 <b>getPlugin</b>(<i></i>)
760
761 <p>
762 Public method to get a reference to the plugin object.
763 </p>
764 <dl>
765 <dt>Return:</dt>
766 <dd>
767 reference to the plugin object (VcsGitPlugin)
768 </dd>
769 </dl>
770 <a NAME="Git.gitAddRemote" ID="Git.gitAddRemote"></a>
771 <h4>Git.gitAddRemote</h4>
772 <b>gitAddRemote</b>(<i>projectDir</i>)
773
774 <p>
775 Public method to add a remote repository.
776 </p>
777 <dl>
778
779 <dt><i>projectDir</i></dt>
780 <dd>
781 name of the project directory (string)
782 </dd>
783 </dl>
784 <a NAME="Git.gitApply" ID="Git.gitApply"></a>
785 <h4>Git.gitApply</h4>
786 <b>gitApply</b>(<i>repodir, patchFile, cached=False, reverse=False, noDialog=False</i>)
787
788 <p>
789 Public method to apply a patch stored in a given file.
790 </p>
791 <dl>
792
793 <dt><i>repodir</i></dt>
794 <dd>
795 directory name of the repository (string)
796 </dd>
797 <dt><i>patchFile</i></dt>
798 <dd>
799 name of the patch file (string)
800 </dd>
801 <dt><i>cached</i></dt>
802 <dd>
803 flag indicating to apply the patch to the staging area
804 (boolean)
805 </dd>
806 <dt><i>reverse</i></dt>
807 <dd>
808 flag indicating to apply the patch in reverse (boolean)
809 </dd>
810 <dt><i>noDialog</i></dt>
811 <dd>
812 flag indicating quiet operations (boolean)
813 </dd>
814 </dl>
815 <a NAME="Git.gitApplyCheckPatches" ID="Git.gitApplyCheckPatches"></a>
816 <h4>Git.gitApplyCheckPatches</h4>
817 <b>gitApplyCheckPatches</b>(<i>projectDir, check=False</i>)
818
819 <p>
820 Public method to apply a list of patch files or check, if they would
821 apply cleanly.
822 </p>
823 <dl>
824
825 <dt><i>projectDir</i></dt>
826 <dd>
827 directory name of the project (string)
828 </dd>
829 <dt><i>check</i></dt>
830 <dd>
831 flag indicating to perform a check operation (boolean)
832 </dd>
833 </dl>
834 <a NAME="Git.gitBisect" ID="Git.gitBisect"></a>
835 <h4>Git.gitBisect</h4>
836 <b>gitBisect</b>(<i>projectDir, subcommand</i>)
837
838 <p>
839 Public method to perform bisect commands.
840 </p>
841 <dl>
842
843 <dt><i>projectDir</i></dt>
844 <dd>
845 name of the project directory (string)
846 </dd>
847 <dt><i>subcommand</i></dt>
848 <dd>
849 name of the subcommand (string, one of 'start',
850 'start_extended', 'good', 'bad', 'skip' or 'reset')
851 </dd>
852 </dl>
853 <dl>
854 <dt>Return:</dt>
855 <dd>
856 flag indicating, that the update contained an add
857 or delete (boolean)
858 </dd>
859 </dl>
860 <dl>
861
862 <dt>Raises <b>ValueError</b>:</dt>
863 <dd>
864 raised to indicate an invalid bisect subcommand
865 </dd>
866 </dl>
867 <a NAME="Git.gitBisectCreateReplayFile" ID="Git.gitBisectCreateReplayFile"></a>
868 <h4>Git.gitBisectCreateReplayFile</h4>
869 <b>gitBisectCreateReplayFile</b>(<i>projectDir</i>)
870
871 <p>
872 Public method used to create a bisect replay file for the project.
873 </p>
874 <dl>
875
876 <dt><i>projectDir</i></dt>
877 <dd>
878 name of the project directory (string)
879 </dd>
880 </dl>
881 <a NAME="Git.gitBisectEditReplayFile" ID="Git.gitBisectEditReplayFile"></a>
882 <h4>Git.gitBisectEditReplayFile</h4>
883 <b>gitBisectEditReplayFile</b>(<i>projectDir</i>)
884
885 <p>
886 Public method used to edit a bisect replay file.
887 </p>
888 <dl>
889
890 <dt><i>projectDir</i></dt>
891 <dd>
892 name of the project directory (string)
893 </dd>
894 </dl>
895 <a NAME="Git.gitBisectLogBrowser" ID="Git.gitBisectLogBrowser"></a>
896 <h4>Git.gitBisectLogBrowser</h4>
897 <b>gitBisectLogBrowser</b>(<i>projectDir</i>)
898
899 <p>
900 Public method used to browse the bisect log of the project.
901 </p>
902 <dl>
903
904 <dt><i>projectDir</i></dt>
905 <dd>
906 name of the project directory (string)
907 </dd>
908 </dl>
909 <a NAME="Git.gitBisectReplay" ID="Git.gitBisectReplay"></a>
910 <h4>Git.gitBisectReplay</h4>
911 <b>gitBisectReplay</b>(<i>projectDir</i>)
912
913 <p>
914 Public method to replay a bisect session.
915 </p>
916 <dl>
917
918 <dt><i>projectDir</i></dt>
919 <dd>
920 name of the project directory (string)
921 </dd>
922 </dl>
923 <dl>
924 <dt>Return:</dt>
925 <dd>
926 flag indicating, that the update contained an add
927 or delete (boolean)
928 </dd>
929 </dl>
930 <a NAME="Git.gitBlame" ID="Git.gitBlame"></a>
931 <h4>Git.gitBlame</h4>
932 <b>gitBlame</b>(<i>name</i>)
933
934 <p>
935 Public method to show the output of the git blame command.
936 </p>
937 <dl>
938
939 <dt><i>name</i></dt>
940 <dd>
941 file name to show the annotations for (string)
942 </dd>
943 </dl>
944 <a NAME="Git.gitBranch" ID="Git.gitBranch"></a>
945 <h4>Git.gitBranch</h4>
946 <b>gitBranch</b>(<i>name, revision=None, branchName=None, branchOp=None</i>)
947
948 <p>
949 Public method used to create, delete or move a branch in the Git
950 repository.
951 </p>
952 <dl>
953
954 <dt><i>name</i></dt>
955 <dd>
956 file/directory name to be branched (string)
957 </dd>
958 <dt><i>revision</i></dt>
959 <dd>
960 revision to set tag for (string)
961 </dd>
962 <dt><i>branchName</i></dt>
963 <dd>
964 name of the branch (string)
965 </dd>
966 <dt><i>branchOp</i></dt>
967 <dd>
968 desired branch operation (integer)
969 </dd>
970 </dl>
971 <dl>
972 <dt>Return:</dt>
973 <dd>
974 flag indicating a performed branch action (boolean) and
975 a flag indicating, that the branch operation contained an add
976 or delete (boolean)
977 </dd>
978 </dl>
979 <a NAME="Git.gitBundle" ID="Git.gitBundle"></a>
980 <h4>Git.gitBundle</h4>
981 <b>gitBundle</b>(<i>projectDir</i>)
982
983 <p>
984 Public method to create a bundle file.
985 </p>
986 <dl>
987
988 <dt><i>projectDir</i></dt>
989 <dd>
990 name of the project directory (string)
991 </dd>
992 </dl>
993 <a NAME="Git.gitBundleFetch" ID="Git.gitBundleFetch"></a>
994 <h4>Git.gitBundleFetch</h4>
995 <b>gitBundleFetch</b>(<i>projectDir</i>)
996
997 <p>
998 Public method to fetch a head of a bundle file into the local
999 repository.
1000 </p>
1001 <dl>
1002
1003 <dt><i>projectDir</i></dt>
1004 <dd>
1005 name of the project directory (string)
1006 </dd>
1007 </dl>
1008 <a NAME="Git.gitBundleListHeads" ID="Git.gitBundleListHeads"></a>
1009 <h4>Git.gitBundleListHeads</h4>
1010 <b>gitBundleListHeads</b>(<i>projectDir</i>)
1011
1012 <p>
1013 Public method to list the heads contained in a bundle file.
1014 </p>
1015 <dl>
1016
1017 <dt><i>projectDir</i></dt>
1018 <dd>
1019 name of the project directory (string)
1020 </dd>
1021 </dl>
1022 <a NAME="Git.gitBundlePull" ID="Git.gitBundlePull"></a>
1023 <h4>Git.gitBundlePull</h4>
1024 <b>gitBundlePull</b>(<i>projectDir</i>)
1025
1026 <p>
1027 Public method to pull a head of a bundle file into the local
1028 repository and working area.
1029 </p>
1030 <dl>
1031
1032 <dt><i>projectDir</i></dt>
1033 <dd>
1034 name of the project directory (string)
1035 </dd>
1036 </dl>
1037 <dl>
1038 <dt>Return:</dt>
1039 <dd>
1040 flag indicating, that the update contained an add
1041 or delete (boolean)
1042 </dd>
1043 </dl>
1044 <a NAME="Git.gitCancelMerge" ID="Git.gitCancelMerge"></a>
1045 <h4>Git.gitCancelMerge</h4>
1046 <b>gitCancelMerge</b>(<i>name</i>)
1047
1048 <p>
1049 Public method to cancel an uncommitted or failed merge.
1050 </p>
1051 <dl>
1052
1053 <dt><i>name</i></dt>
1054 <dd>
1055 file/directory name (string)
1056 </dd>
1057 </dl>
1058 <dl>
1059 <dt>Return:</dt>
1060 <dd>
1061 flag indicating, that the cancellation contained an add
1062 or delete (boolean)
1063 </dd>
1064 </dl>
1065 <a NAME="Git.gitChangeRemoteCredentials" ID="Git.gitChangeRemoteCredentials"></a>
1066 <h4>Git.gitChangeRemoteCredentials</h4>
1067 <b>gitChangeRemoteCredentials</b>(<i>projectDir, remoteName, remoteUrl=""</i>)
1068
1069 <p>
1070 Public method to change the user credentials of a remote repository.
1071 </p>
1072 <dl>
1073
1074 <dt><i>projectDir</i> (str)</dt>
1075 <dd>
1076 name of the project directory
1077 </dd>
1078 <dt><i>remoteName</i> (str)</dt>
1079 <dd>
1080 name of the remote repository
1081 </dd>
1082 <dt><i>remoteUrl</i> (str)</dt>
1083 <dd>
1084 URL of the remote repository
1085 </dd>
1086 </dl>
1087 <a NAME="Git.gitChangeRemoteUrl" ID="Git.gitChangeRemoteUrl"></a>
1088 <h4>Git.gitChangeRemoteUrl</h4>
1089 <b>gitChangeRemoteUrl</b>(<i>projectDir, remoteName, remoteUrl=""</i>)
1090
1091 <p>
1092 Public method to change the URL of a remote repository.
1093 </p>
1094 <dl>
1095
1096 <dt><i>projectDir</i> (str)</dt>
1097 <dd>
1098 name of the project directory
1099 </dd>
1100 <dt><i>remoteName</i> (str)</dt>
1101 <dd>
1102 name of the remote repository
1103 </dd>
1104 <dt><i>remoteUrl</i> (str)</dt>
1105 <dd>
1106 URL of the remote repository
1107 </dd>
1108 </dl>
1109 <a NAME="Git.gitCherryPick" ID="Git.gitCherryPick"></a>
1110 <h4>Git.gitCherryPick</h4>
1111 <b>gitCherryPick</b>(<i>projectDir, commits=None</i>)
1112
1113 <p>
1114 Public method to cherry pick commits and apply them to the current
1115 branch.
1116 </p>
1117 <dl>
1118
1119 <dt><i>projectDir</i></dt>
1120 <dd>
1121 name of the project directory (string)
1122 </dd>
1123 <dt><i>commits</i></dt>
1124 <dd>
1125 list of commits to be applied (list of strings)
1126 </dd>
1127 </dl>
1128 <dl>
1129 <dt>Return:</dt>
1130 <dd>
1131 flag indicating that the project should be reread (boolean)
1132 </dd>
1133 </dl>
1134 <a NAME="Git.gitCherryPickAbort" ID="Git.gitCherryPickAbort"></a>
1135 <h4>Git.gitCherryPickAbort</h4>
1136 <b>gitCherryPickAbort</b>(<i>projectDir</i>)
1137
1138 <p>
1139 Public method to cancel the last copying session and return to
1140 the previous state.
1141 </p>
1142 <dl>
1143
1144 <dt><i>projectDir</i></dt>
1145 <dd>
1146 name of the project directory (string)
1147 </dd>
1148 </dl>
1149 <dl>
1150 <dt>Return:</dt>
1151 <dd>
1152 flag indicating that the project should be reread (boolean)
1153 </dd>
1154 </dl>
1155 <a NAME="Git.gitCherryPickContinue" ID="Git.gitCherryPickContinue"></a>
1156 <h4>Git.gitCherryPickContinue</h4>
1157 <b>gitCherryPickContinue</b>(<i>projectDir</i>)
1158
1159 <p>
1160 Public method to continue the last copying session after conflicts
1161 were resolved.
1162 </p>
1163 <dl>
1164
1165 <dt><i>projectDir</i></dt>
1166 <dd>
1167 name of the project directory (string)
1168 </dd>
1169 </dl>
1170 <dl>
1171 <dt>Return:</dt>
1172 <dd>
1173 flag indicating that the project should be reread (boolean)
1174 </dd>
1175 </dl>
1176 <a NAME="Git.gitCherryPickQuit" ID="Git.gitCherryPickQuit"></a>
1177 <h4>Git.gitCherryPickQuit</h4>
1178 <b>gitCherryPickQuit</b>(<i>projectDir</i>)
1179
1180 <p>
1181 Public method to quit the current copying operation.
1182 </p>
1183 <dl>
1184
1185 <dt><i>projectDir</i></dt>
1186 <dd>
1187 name of the project directory (string)
1188 </dd>
1189 </dl>
1190 <dl>
1191 <dt>Return:</dt>
1192 <dd>
1193 flag indicating that the project should be reread (boolean)
1194 </dd>
1195 </dl>
1196 <a NAME="Git.gitCommitMerge" ID="Git.gitCommitMerge"></a>
1197 <h4>Git.gitCommitMerge</h4>
1198 <b>gitCommitMerge</b>(<i>name</i>)
1199
1200 <p>
1201 Public method to commit a failed merge.
1202 </p>
1203 <dl>
1204
1205 <dt><i>name</i></dt>
1206 <dd>
1207 file/directory name (string)
1208 </dd>
1209 </dl>
1210 <a NAME="Git.gitCopy" ID="Git.gitCopy"></a>
1211 <h4>Git.gitCopy</h4>
1212 <b>gitCopy</b>(<i>name, project</i>)
1213
1214 <p>
1215 Public method used to copy a file/directory.
1216 </p>
1217 <dl>
1218
1219 <dt><i>name</i></dt>
1220 <dd>
1221 file/directory name to be copied (string)
1222 </dd>
1223 <dt><i>project</i></dt>
1224 <dd>
1225 reference to the project object
1226 </dd>
1227 </dl>
1228 <dl>
1229 <dt>Return:</dt>
1230 <dd>
1231 flag indicating successful operation (boolean)
1232 </dd>
1233 </dl>
1234 <a NAME="Git.gitCreateArchive" ID="Git.gitCreateArchive"></a>
1235 <h4>Git.gitCreateArchive</h4>
1236 <b>gitCreateArchive</b>(<i>projectDir</i>)
1237
1238 <p>
1239 Public method to show some statistics of the local repository.
1240 </p>
1241 <dl>
1242
1243 <dt><i>projectDir</i></dt>
1244 <dd>
1245 name of the project directory (string)
1246 </dd>
1247 </dl>
1248 <a NAME="Git.gitCreateIgnoreFile" ID="Git.gitCreateIgnoreFile"></a>
1249 <h4>Git.gitCreateIgnoreFile</h4>
1250 <b>gitCreateIgnoreFile</b>(<i>name, autoAdd=False</i>)
1251
1252 <p>
1253 Public method to create the ignore file.
1254 </p>
1255 <dl>
1256
1257 <dt><i>name</i></dt>
1258 <dd>
1259 directory name to create the ignore file in (string)
1260 </dd>
1261 <dt><i>autoAdd</i></dt>
1262 <dd>
1263 flag indicating to add it automatically (boolean)
1264 </dd>
1265 </dl>
1266 <dl>
1267 <dt>Return:</dt>
1268 <dd>
1269 flag indicating success
1270 </dd>
1271 </dl>
1272 <a NAME="Git.gitDeleteRemoteBranch" ID="Git.gitDeleteRemoteBranch"></a>
1273 <h4>Git.gitDeleteRemoteBranch</h4>
1274 <b>gitDeleteRemoteBranch</b>(<i>name</i>)
1275
1276 <p>
1277 Public method to delete a branch from a remote repository.
1278 </p>
1279 <dl>
1280
1281 <dt><i>name</i></dt>
1282 <dd>
1283 file/directory name (string)
1284 </dd>
1285 </dl>
1286 <a NAME="Git.gitDescribe" ID="Git.gitDescribe"></a>
1287 <h4>Git.gitDescribe</h4>
1288 <b>gitDescribe</b>(<i>projectDir, commits</i>)
1289
1290 <p>
1291 Public method to find the most recent tag reachable from each commit.
1292 </p>
1293 <dl>
1294
1295 <dt><i>projectDir</i></dt>
1296 <dd>
1297 name of the project directory (string)
1298 </dd>
1299 <dt><i>commits</i></dt>
1300 <dd>
1301 list of commits to start the search from
1302 (list of strings)
1303 </dd>
1304 </dl>
1305 <a NAME="Git.gitEditConfig" ID="Git.gitEditConfig"></a>
1306 <h4>Git.gitEditConfig</h4>
1307 <b>gitEditConfig</b>(<i>projectDir</i>)
1308
1309 <p>
1310 Public method used to edit the repository configuration file.
1311 </p>
1312 <dl>
1313
1314 <dt><i>projectDir</i></dt>
1315 <dd>
1316 name of the project directory (string)
1317 </dd>
1318 </dl>
1319 <a NAME="Git.gitEditUserConfig" ID="Git.gitEditUserConfig"></a>
1320 <h4>Git.gitEditUserConfig</h4>
1321 <b>gitEditUserConfig</b>(<i></i>)
1322
1323 <p>
1324 Public method used to edit the user configuration file.
1325 </p>
1326 <a NAME="Git.gitExtendedDiff" ID="Git.gitExtendedDiff"></a>
1327 <h4>Git.gitExtendedDiff</h4>
1328 <b>gitExtendedDiff</b>(<i>name</i>)
1329
1330 <p>
1331 Public method used to view the difference of a file/directory to the
1332 Git repository.
1333 </p>
1334 <p>
1335 If name is a directory and is the project directory, all project files
1336 are saved first. If name is a file (or list of files), which is/are
1337 being edited and has unsaved modification, they can be saved or the
1338 operation may be aborted.
1339 </p>
1340 <p>
1341 This method gives the chance to enter the revisions to be compared.
1342 </p>
1343 <dl>
1344
1345 <dt><i>name</i></dt>
1346 <dd>
1347 file/directory name to be diffed (string)
1348 </dd>
1349 </dl>
1350 <a NAME="Git.gitFetch" ID="Git.gitFetch"></a>
1351 <h4>Git.gitFetch</h4>
1352 <b>gitFetch</b>(<i>name</i>)
1353
1354 <p>
1355 Public method to fetch changes from a remote repository.
1356 </p>
1357 <dl>
1358
1359 <dt><i>name</i></dt>
1360 <dd>
1361 directory name (string)
1362 </dd>
1363 </dl>
1364 <a NAME="Git.gitGetArchiveFormats" ID="Git.gitGetArchiveFormats"></a>
1365 <h4>Git.gitGetArchiveFormats</h4>
1366 <b>gitGetArchiveFormats</b>(<i>repodir</i>)
1367
1368 <p>
1369 Public method to get a list of supported archive formats.
1370 </p>
1371 <dl>
1372
1373 <dt><i>repodir</i></dt>
1374 <dd>
1375 directory name of the repository (string)
1376 </dd>
1377 </dl>
1378 <dl>
1379 <dt>Return:</dt>
1380 <dd>
1381 list of supported archive formats (list of strings)
1382 </dd>
1383 </dl>
1384 <a NAME="Git.gitGetBranchesList" ID="Git.gitGetBranchesList"></a>
1385 <h4>Git.gitGetBranchesList</h4>
1386 <b>gitGetBranchesList</b>(<i>repodir, withMaster=False, allBranches=False, remotes=False</i>)
1387
1388 <p>
1389 Public method to get the list of branches.
1390 </p>
1391 <dl>
1392
1393 <dt><i>repodir</i></dt>
1394 <dd>
1395 directory name of the repository (string)
1396 </dd>
1397 <dt><i>withMaster</i></dt>
1398 <dd>
1399 flag indicating to get 'master' as well (boolean)
1400 </dd>
1401 <dt><i>allBranches</i></dt>
1402 <dd>
1403 flag indicating to return all branches (boolean)
1404 </dd>
1405 <dt><i>remotes</i></dt>
1406 <dd>
1407 flag indicating to return remote branches only (boolean)
1408 </dd>
1409 </dl>
1410 <dl>
1411 <dt>Return:</dt>
1412 <dd>
1413 list of branches (list of string)
1414 </dd>
1415 </dl>
1416 <a NAME="Git.gitGetBundleHeads" ID="Git.gitGetBundleHeads"></a>
1417 <h4>Git.gitGetBundleHeads</h4>
1418 <b>gitGetBundleHeads</b>(<i>repodir, bundleFile</i>)
1419
1420 <p>
1421 Public method to get a list of heads contained in a bundle file.
1422 </p>
1423 <dl>
1424
1425 <dt><i>repodir</i></dt>
1426 <dd>
1427 directory name of the repository (string)
1428 </dd>
1429 <dt><i>bundleFile</i></dt>
1430 <dd>
1431 file name of a git bundle file (string)
1432 </dd>
1433 </dl>
1434 <dl>
1435 <dt>Return:</dt>
1436 <dd>
1437 list of heads (list of strings)
1438 </dd>
1439 </dl>
1440 <a NAME="Git.gitGetCurrentBranch" ID="Git.gitGetCurrentBranch"></a>
1441 <h4>Git.gitGetCurrentBranch</h4>
1442 <b>gitGetCurrentBranch</b>(<i>repodir</i>)
1443
1444 <p>
1445 Public method used to show the current branch of the working directory.
1446 </p>
1447 <dl>
1448
1449 <dt><i>repodir</i></dt>
1450 <dd>
1451 directory name of the repository (string)
1452 </dd>
1453 </dl>
1454 <dl>
1455 <dt>Return:</dt>
1456 <dd>
1457 name of the current branch (string)
1458 </dd>
1459 </dl>
1460 <a NAME="Git.gitGetRemoteBranchesList" ID="Git.gitGetRemoteBranchesList"></a>
1461 <h4>Git.gitGetRemoteBranchesList</h4>
1462 <b>gitGetRemoteBranchesList</b>(<i>repodir, remote</i>)
1463
1464 <p>
1465 Public method to get the list of a remote repository branches.
1466 </p>
1467 <dl>
1468
1469 <dt><i>repodir</i></dt>
1470 <dd>
1471 directory name of the repository (string)
1472 </dd>
1473 <dt><i>remote</i></dt>
1474 <dd>
1475 remote repository name (string)
1476 </dd>
1477 </dl>
1478 <dl>
1479 <dt>Return:</dt>
1480 <dd>
1481 list of remote repository branches (list of string)
1482 </dd>
1483 </dl>
1484 <a NAME="Git.gitGetRemoteUrl" ID="Git.gitGetRemoteUrl"></a>
1485 <h4>Git.gitGetRemoteUrl</h4>
1486 <b>gitGetRemoteUrl</b>(<i>repodir, remoteName</i>)
1487
1488 <p>
1489 Public method to get the URL of a remote repository.
1490 </p>
1491 <dl>
1492
1493 <dt><i>repodir</i> (str)</dt>
1494 <dd>
1495 directory name of the repository
1496 </dd>
1497 <dt><i>remoteName</i> (str)</dt>
1498 <dd>
1499 name of the remote repository
1500 </dd>
1501 </dl>
1502 <dl>
1503 <dt>Return:</dt>
1504 <dd>
1505 URL of the remote repository
1506 </dd>
1507 </dl>
1508 <dl>
1509 <dt>Return Type:</dt>
1510 <dd>
1511 str
1512 </dd>
1513 </dl>
1514 <a NAME="Git.gitGetRemoteUrlsList" ID="Git.gitGetRemoteUrlsList"></a>
1515 <h4>Git.gitGetRemoteUrlsList</h4>
1516 <b>gitGetRemoteUrlsList</b>(<i>repodir, forFetch=True</i>)
1517
1518 <p>
1519 Public method to get the list of remote repos and their URLs.
1520 </p>
1521 <dl>
1522
1523 <dt><i>repodir</i></dt>
1524 <dd>
1525 directory name of the repository (string)
1526 </dd>
1527 <dt><i>forFetch</i></dt>
1528 <dd>
1529 flag indicating to get Fetch info (string)
1530 </dd>
1531 </dl>
1532 <dl>
1533 <dt>Return:</dt>
1534 <dd>
1535 list of tuples of remote repo name and repo URL (list of
1536 tuple of two strings)
1537 </dd>
1538 </dl>
1539 <a NAME="Git.gitGetRemotesList" ID="Git.gitGetRemotesList"></a>
1540 <h4>Git.gitGetRemotesList</h4>
1541 <b>gitGetRemotesList</b>(<i>repodir</i>)
1542
1543 <p>
1544 Public method to get the list of remote repos.
1545 </p>
1546 <dl>
1547
1548 <dt><i>repodir</i></dt>
1549 <dd>
1550 directory name of the repository (string)
1551 </dd>
1552 </dl>
1553 <dl>
1554 <dt>Return:</dt>
1555 <dd>
1556 list of remote repos (list of string)
1557 </dd>
1558 </dl>
1559 <a NAME="Git.gitGetTagsList" ID="Git.gitGetTagsList"></a>
1560 <h4>Git.gitGetTagsList</h4>
1561 <b>gitGetTagsList</b>(<i>repodir, withType=False</i>)
1562
1563 <p>
1564 Public method to get the list of tags.
1565 </p>
1566 <dl>
1567
1568 <dt><i>repodir</i></dt>
1569 <dd>
1570 directory name of the repository (string)
1571 </dd>
1572 <dt><i>withType</i></dt>
1573 <dd>
1574 flag indicating to get the tag type as well (boolean)
1575 </dd>
1576 </dl>
1577 <dl>
1578 <dt>Return:</dt>
1579 <dd>
1580 list of tags (list of string) or list of tuples of
1581 tag name and flag indicating a local tag (list of tuple of string
1582 and boolean), if withType is True
1583 </dd>
1584 </dl>
1585 <a NAME="Git.gitHouseKeeping" ID="Git.gitHouseKeeping"></a>
1586 <h4>Git.gitHouseKeeping</h4>
1587 <b>gitHouseKeeping</b>(<i>projectDir</i>)
1588
1589 <p>
1590 Public method to cleanup and optimize the local repository.
1591 </p>
1592 <dl>
1593
1594 <dt><i>projectDir</i></dt>
1595 <dd>
1596 name of the project directory (string)
1597 </dd>
1598 </dl>
1599 <a NAME="Git.gitListTagBranch" ID="Git.gitListTagBranch"></a>
1600 <h4>Git.gitListTagBranch</h4>
1601 <b>gitListTagBranch</b>(<i>path, tags=True, listAll=True, merged=True</i>)
1602
1603 <p>
1604 Public method used to list the available tags or branches.
1605 </p>
1606 <dl>
1607
1608 <dt><i>path</i></dt>
1609 <dd>
1610 directory name of the project (string)
1611 </dd>
1612 <dt><i>tags</i></dt>
1613 <dd>
1614 flag indicating listing of branches or tags
1615 (False = branches, True = tags)
1616 </dd>
1617 <dt><i>listAll</i></dt>
1618 <dd>
1619 flag indicating to show all tags or branches (boolean)
1620 </dd>
1621 <dt><i>merged</i></dt>
1622 <dd>
1623 flag indicating to show only merged or non-merged
1624 branches (boolean)
1625 </dd>
1626 </dl>
1627 <a NAME="Git.gitNormalizeURL" ID="Git.gitNormalizeURL"></a>
1628 <h4>Git.gitNormalizeURL</h4>
1629 <b>gitNormalizeURL</b>(<i>url</i>)
1630
1631 <p>
1632 Public method to normalize a url for Git.
1633 </p>
1634 <dl>
1635
1636 <dt><i>url</i></dt>
1637 <dd>
1638 url string (string)
1639 </dd>
1640 </dl>
1641 <dl>
1642 <dt>Return:</dt>
1643 <dd>
1644 properly normalized url for git (string)
1645 </dd>
1646 </dl>
1647 <a NAME="Git.gitPruneRemote" ID="Git.gitPruneRemote"></a>
1648 <h4>Git.gitPruneRemote</h4>
1649 <b>gitPruneRemote</b>(<i>projectDir, remoteName</i>)
1650
1651 <p>
1652 Public method to prune stale remote-tracking branches.
1653 </p>
1654 <dl>
1655
1656 <dt><i>projectDir</i></dt>
1657 <dd>
1658 name of the project directory (string)
1659 </dd>
1660 <dt><i>remoteName</i></dt>
1661 <dd>
1662 name of the remote repository (string)
1663 </dd>
1664 </dl>
1665 <a NAME="Git.gitPull" ID="Git.gitPull"></a>
1666 <h4>Git.gitPull</h4>
1667 <b>gitPull</b>(<i>name</i>)
1668
1669 <p>
1670 Public method used to pull changes from a remote Git repository.
1671 </p>
1672 <dl>
1673
1674 <dt><i>name</i></dt>
1675 <dd>
1676 directory name of the project to be pulled to (string)
1677 </dd>
1678 </dl>
1679 <dl>
1680 <dt>Return:</dt>
1681 <dd>
1682 flag indicating, that the update contained an add
1683 or delete (boolean)
1684 </dd>
1685 </dl>
1686 <a NAME="Git.gitPush" ID="Git.gitPush"></a>
1687 <h4>Git.gitPush</h4>
1688 <b>gitPush</b>(<i>name</i>)
1689
1690 <p>
1691 Public method used to push changes to a remote Git repository.
1692 </p>
1693 <dl>
1694
1695 <dt><i>name</i></dt>
1696 <dd>
1697 directory name of the project to be pushed from (string)
1698 </dd>
1699 </dl>
1700 <a NAME="Git.gitReflogBrowser" ID="Git.gitReflogBrowser"></a>
1701 <h4>Git.gitReflogBrowser</h4>
1702 <b>gitReflogBrowser</b>(<i>projectDir</i>)
1703
1704 <p>
1705 Public method used to browse the reflog of the project.
1706 </p>
1707 <dl>
1708
1709 <dt><i>projectDir</i></dt>
1710 <dd>
1711 name of the project directory (string)
1712 </dd>
1713 </dl>
1714 <a NAME="Git.gitRemoveRemote" ID="Git.gitRemoveRemote"></a>
1715 <h4>Git.gitRemoveRemote</h4>
1716 <b>gitRemoveRemote</b>(<i>projectDir, remoteName</i>)
1717
1718 <p>
1719 Public method to remove a remote repository.
1720 </p>
1721 <dl>
1722
1723 <dt><i>projectDir</i></dt>
1724 <dd>
1725 name of the project directory (string)
1726 </dd>
1727 <dt><i>remoteName</i></dt>
1728 <dd>
1729 name of the remote repository (string)
1730 </dd>
1731 </dl>
1732 <a NAME="Git.gitRenameRemote" ID="Git.gitRenameRemote"></a>
1733 <h4>Git.gitRenameRemote</h4>
1734 <b>gitRenameRemote</b>(<i>projectDir, remoteName</i>)
1735
1736 <p>
1737 Public method to rename a remote repository.
1738 </p>
1739 <dl>
1740
1741 <dt><i>projectDir</i></dt>
1742 <dd>
1743 name of the project directory (string)
1744 </dd>
1745 <dt><i>remoteName</i></dt>
1746 <dd>
1747 name of the remote repository (string)
1748 </dd>
1749 </dl>
1750 <a NAME="Git.gitRevert" ID="Git.gitRevert"></a>
1751 <h4>Git.gitRevert</h4>
1752 <b>gitRevert</b>(<i>name</i>)
1753
1754 <p>
1755 Public method used to revert changes made to a file/directory.
1756 </p>
1757 <dl>
1758
1759 <dt><i>name</i></dt>
1760 <dd>
1761 file/directory name to be reverted (string)
1762 </dd>
1763 </dl>
1764 <dl>
1765 <dt>Return:</dt>
1766 <dd>
1767 flag indicating, that the update contained an add
1768 or delete (boolean)
1769 </dd>
1770 </dl>
1771 <a NAME="Git.gitSbsDiff" ID="Git.gitSbsDiff"></a>
1772 <h4>Git.gitSbsDiff</h4>
1773 <b>gitSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
1774
1775 <p>
1776 Public method used to view the difference of a file to the Git
1777 repository side-by-side.
1778 </p>
1779 <dl>
1780
1781 <dt><i>name</i></dt>
1782 <dd>
1783 file name to be diffed (string)
1784 </dd>
1785 <dt><i>extended</i></dt>
1786 <dd>
1787 flag indicating the extended variant (boolean)
1788 </dd>
1789 <dt><i>revisions</i></dt>
1790 <dd>
1791 tuple of two revisions (tuple of strings)
1792 </dd>
1793 </dl>
1794 <dl>
1795
1796 <dt>Raises <b>ValueError</b>:</dt>
1797 <dd>
1798 raised to indicate an invalid name parameter
1799 </dd>
1800 </dl>
1801 <a NAME="Git.gitShortlog" ID="Git.gitShortlog"></a>
1802 <h4>Git.gitShortlog</h4>
1803 <b>gitShortlog</b>(<i>projectDir, commit</i>)
1804
1805 <p>
1806 Public method to show a short log suitable for inclusion in release
1807 announcements.
1808 </p>
1809 <dl>
1810
1811 <dt><i>projectDir</i></dt>
1812 <dd>
1813 name of the project directory (string)
1814 </dd>
1815 <dt><i>commit</i></dt>
1816 <dd>
1817 commit to start the log at (strings)
1818 </dd>
1819 </dl>
1820 <a NAME="Git.gitShowBranch" ID="Git.gitShowBranch"></a>
1821 <h4>Git.gitShowBranch</h4>
1822 <b>gitShowBranch</b>(<i>name</i>)
1823
1824 <p>
1825 Public method used to show the current branch of the working directory.
1826 </p>
1827 <dl>
1828
1829 <dt><i>name</i></dt>
1830 <dd>
1831 file/directory name (string)
1832 </dd>
1833 </dl>
1834 <a NAME="Git.gitShowConfig" ID="Git.gitShowConfig"></a>
1835 <h4>Git.gitShowConfig</h4>
1836 <b>gitShowConfig</b>(<i>projectDir</i>)
1837
1838 <p>
1839 Public method to show the combined configuration.
1840 </p>
1841 <dl>
1842
1843 <dt><i>projectDir</i></dt>
1844 <dd>
1845 name of the project directory (string)
1846 </dd>
1847 </dl>
1848 <a NAME="Git.gitShowPatchesStatistics" ID="Git.gitShowPatchesStatistics"></a>
1849 <h4>Git.gitShowPatchesStatistics</h4>
1850 <b>gitShowPatchesStatistics</b>(<i>projectDir</i>)
1851
1852 <p>
1853 Public method to show statistics for a set of patch files.
1854 </p>
1855 <dl>
1856
1857 <dt><i>projectDir</i></dt>
1858 <dd>
1859 directory name of the project (string)
1860 </dd>
1861 </dl>
1862 <a NAME="Git.gitShowRemote" ID="Git.gitShowRemote"></a>
1863 <h4>Git.gitShowRemote</h4>
1864 <b>gitShowRemote</b>(<i>projectDir, remoteName</i>)
1865
1866 <p>
1867 Public method to show information about a remote repository.
1868 </p>
1869 <dl>
1870
1871 <dt><i>projectDir</i></dt>
1872 <dd>
1873 name of the project directory (string)
1874 </dd>
1875 <dt><i>remoteName</i></dt>
1876 <dd>
1877 name of the remote repository (string)
1878 </dd>
1879 </dl>
1880 <a NAME="Git.gitShowRemotes" ID="Git.gitShowRemotes"></a>
1881 <h4>Git.gitShowRemotes</h4>
1882 <b>gitShowRemotes</b>(<i>projectDir</i>)
1883
1884 <p>
1885 Public method to show available remote repositories.
1886 </p>
1887 <dl>
1888
1889 <dt><i>projectDir</i></dt>
1890 <dd>
1891 name of the project directory (string)
1892 </dd>
1893 </dl>
1894 <a NAME="Git.gitStashApply" ID="Git.gitStashApply"></a>
1895 <h4>Git.gitStashApply</h4>
1896 <b>gitStashApply</b>(<i>projectDir, stashName=""</i>)
1897
1898 <p>
1899 Public method to apply a stash but keep it.
1900 </p>
1901 <dl>
1902
1903 <dt><i>projectDir</i></dt>
1904 <dd>
1905 name of the project directory (string)
1906 </dd>
1907 <dt><i>stashName</i></dt>
1908 <dd>
1909 name of a stash (string)
1910 </dd>
1911 </dl>
1912 <dl>
1913 <dt>Return:</dt>
1914 <dd>
1915 flag indicating, that the restore contained an add
1916 or delete (boolean)
1917 </dd>
1918 </dl>
1919 <a NAME="Git.gitStashBranch" ID="Git.gitStashBranch"></a>
1920 <h4>Git.gitStashBranch</h4>
1921 <b>gitStashBranch</b>(<i>projectDir, stashName=""</i>)
1922
1923 <p>
1924 Public method to create a branch from a stash.
1925 </p>
1926 <dl>
1927
1928 <dt><i>projectDir</i></dt>
1929 <dd>
1930 name of the project directory (string)
1931 </dd>
1932 <dt><i>stashName</i></dt>
1933 <dd>
1934 name of a stash (string)
1935 </dd>
1936 </dl>
1937 <dl>
1938 <dt>Return:</dt>
1939 <dd>
1940 flag indicating, that the restore contained an add
1941 or delete (boolean)
1942 </dd>
1943 </dl>
1944 <a NAME="Git.gitStashBrowser" ID="Git.gitStashBrowser"></a>
1945 <h4>Git.gitStashBrowser</h4>
1946 <b>gitStashBrowser</b>(<i>projectDir</i>)
1947
1948 <p>
1949 Public method used to browse the stashed changes.
1950 </p>
1951 <dl>
1952
1953 <dt><i>projectDir</i></dt>
1954 <dd>
1955 name of the project directory (string)
1956 </dd>
1957 </dl>
1958 <a NAME="Git.gitStashClear" ID="Git.gitStashClear"></a>
1959 <h4>Git.gitStashClear</h4>
1960 <b>gitStashClear</b>(<i>projectDir</i>)
1961
1962 <p>
1963 Public method to delete all stashes.
1964 </p>
1965 <dl>
1966
1967 <dt><i>projectDir</i></dt>
1968 <dd>
1969 name of the project directory (string)
1970 </dd>
1971 </dl>
1972 <dl>
1973 <dt>Return:</dt>
1974 <dd>
1975 flag indicating a successful deletion (boolean)
1976 </dd>
1977 </dl>
1978 <a NAME="Git.gitStashDrop" ID="Git.gitStashDrop"></a>
1979 <h4>Git.gitStashDrop</h4>
1980 <b>gitStashDrop</b>(<i>projectDir, stashName=""</i>)
1981
1982 <p>
1983 Public method to delete a stash.
1984 </p>
1985 <dl>
1986
1987 <dt><i>projectDir</i></dt>
1988 <dd>
1989 name of the project directory (string)
1990 </dd>
1991 <dt><i>stashName</i></dt>
1992 <dd>
1993 name of a stash (string)
1994 </dd>
1995 </dl>
1996 <dl>
1997 <dt>Return:</dt>
1998 <dd>
1999 flag indicating a successful deletion (boolean)
2000 </dd>
2001 </dl>
2002 <a NAME="Git.gitStashPop" ID="Git.gitStashPop"></a>
2003 <h4>Git.gitStashPop</h4>
2004 <b>gitStashPop</b>(<i>projectDir, stashName=""</i>)
2005
2006 <p>
2007 Public method to apply a stash and delete it.
2008 </p>
2009 <dl>
2010
2011 <dt><i>projectDir</i></dt>
2012 <dd>
2013 name of the project directory (string)
2014 </dd>
2015 <dt><i>stashName</i></dt>
2016 <dd>
2017 name of a stash (string)
2018 </dd>
2019 </dl>
2020 <dl>
2021 <dt>Return:</dt>
2022 <dd>
2023 flag indicating, that the restore contained an add
2024 or delete (boolean)
2025 </dd>
2026 </dl>
2027 <a NAME="Git.gitStashSave" ID="Git.gitStashSave"></a>
2028 <h4>Git.gitStashSave</h4>
2029 <b>gitStashSave</b>(<i>projectDir</i>)
2030
2031 <p>
2032 Public method to save the current changes to a new stash.
2033 </p>
2034 <dl>
2035
2036 <dt><i>projectDir</i></dt>
2037 <dd>
2038 name of the project directory (string)
2039 </dd>
2040 </dl>
2041 <dl>
2042 <dt>Return:</dt>
2043 <dd>
2044 flag indicating, that the save contained an add
2045 or delete (boolean)
2046 </dd>
2047 </dl>
2048 <a NAME="Git.gitStashShowPatch" ID="Git.gitStashShowPatch"></a>
2049 <h4>Git.gitStashShowPatch</h4>
2050 <b>gitStashShowPatch</b>(<i>projectDir, stashName=""</i>)
2051
2052 <p>
2053 Public method to show the contents of a stash.
2054 </p>
2055 <dl>
2056
2057 <dt><i>projectDir</i></dt>
2058 <dd>
2059 name of the project directory (string)
2060 </dd>
2061 <dt><i>stashName</i></dt>
2062 <dd>
2063 name of a stash (string)
2064 </dd>
2065 </dl>
2066 <a NAME="Git.gitStatistics" ID="Git.gitStatistics"></a>
2067 <h4>Git.gitStatistics</h4>
2068 <b>gitStatistics</b>(<i>projectDir</i>)
2069
2070 <p>
2071 Public method to show some statistics of the local repository.
2072 </p>
2073 <dl>
2074
2075 <dt><i>projectDir</i></dt>
2076 <dd>
2077 name of the project directory (string)
2078 </dd>
2079 </dl>
2080 <a NAME="Git.gitSubmoduleAdd" ID="Git.gitSubmoduleAdd"></a>
2081 <h4>Git.gitSubmoduleAdd</h4>
2082 <b>gitSubmoduleAdd</b>(<i>projectDir</i>)
2083
2084 <p>
2085 Public method to add a submodule to the project.
2086 </p>
2087 <dl>
2088
2089 <dt><i>projectDir</i> (str)</dt>
2090 <dd>
2091 name of the project directory
2092 </dd>
2093 </dl>
2094 <a NAME="Git.gitSubmoduleDeinit" ID="Git.gitSubmoduleDeinit"></a>
2095 <h4>Git.gitSubmoduleDeinit</h4>
2096 <b>gitSubmoduleDeinit</b>(<i>projectDir</i>)
2097
2098 <p>
2099 Public method to unregister submodules.
2100 </p>
2101 <dl>
2102
2103 <dt><i>projectDir</i> (str)</dt>
2104 <dd>
2105 name of the project directory
2106 </dd>
2107 </dl>
2108 <a NAME="Git.gitSubmoduleInit" ID="Git.gitSubmoduleInit"></a>
2109 <h4>Git.gitSubmoduleInit</h4>
2110 <b>gitSubmoduleInit</b>(<i>projectDir</i>)
2111
2112 <p>
2113 Public method to initialize one or all submodules.
2114 </p>
2115 <dl>
2116
2117 <dt><i>projectDir</i> (str)</dt>
2118 <dd>
2119 name of the project directory
2120 </dd>
2121 </dl>
2122 <a NAME="Git.gitSubmoduleList" ID="Git.gitSubmoduleList"></a>
2123 <h4>Git.gitSubmoduleList</h4>
2124 <b>gitSubmoduleList</b>(<i>projectDir</i>)
2125
2126 <p>
2127 Public method to show a list of all submodules of the project.
2128 </p>
2129 <dl>
2130
2131 <dt><i>projectDir</i> (str)</dt>
2132 <dd>
2133 name of the project directory
2134 </dd>
2135 </dl>
2136 <a NAME="Git.gitSubmoduleStatus" ID="Git.gitSubmoduleStatus"></a>
2137 <h4>Git.gitSubmoduleStatus</h4>
2138 <b>gitSubmoduleStatus</b>(<i>projectDir</i>)
2139
2140 <p>
2141 Public method to show the status of the submodules.
2142 </p>
2143 <dl>
2144
2145 <dt><i>projectDir</i> (str)</dt>
2146 <dd>
2147 name of the project directory
2148 </dd>
2149 </dl>
2150 <a NAME="Git.gitSubmoduleSummary" ID="Git.gitSubmoduleSummary"></a>
2151 <h4>Git.gitSubmoduleSummary</h4>
2152 <b>gitSubmoduleSummary</b>(<i>projectDir</i>)
2153
2154 <p>
2155 Public method to show the status of the submodules.
2156 </p>
2157 <dl>
2158
2159 <dt><i>projectDir</i> (str)</dt>
2160 <dd>
2161 name of the project directory
2162 </dd>
2163 </dl>
2164 <a NAME="Git.gitSubmoduleSync" ID="Git.gitSubmoduleSync"></a>
2165 <h4>Git.gitSubmoduleSync</h4>
2166 <b>gitSubmoduleSync</b>(<i>projectDir</i>)
2167
2168 <p>
2169 Public method to synchronize submodules.
2170 </p>
2171 <dl>
2172
2173 <dt><i>projectDir</i> (str)</dt>
2174 <dd>
2175 name of the project directory
2176 </dd>
2177 </dl>
2178 <a NAME="Git.gitSubmoduleUpdate" ID="Git.gitSubmoduleUpdate"></a>
2179 <h4>Git.gitSubmoduleUpdate</h4>
2180 <b>gitSubmoduleUpdate</b>(<i>projectDir, initialize=False, remote=False</i>)
2181
2182 <p>
2183 Public method to update submodules.
2184 </p>
2185 <dl>
2186
2187 <dt><i>projectDir</i> (str)</dt>
2188 <dd>
2189 name of the project directory
2190 </dd>
2191 <dt><i>initialize</i> (bool)</dt>
2192 <dd>
2193 flag indicating an initialize and update operation
2194 </dd>
2195 <dt><i>remote</i> (bool)</dt>
2196 <dd>
2197 flag indicating a fetch and update operation
2198 </dd>
2199 </dl>
2200 <a NAME="Git.gitSubmoduleUpdateWithOptions" ID="Git.gitSubmoduleUpdateWithOptions"></a>
2201 <h4>Git.gitSubmoduleUpdateWithOptions</h4>
2202 <b>gitSubmoduleUpdateWithOptions</b>(<i>projectDir</i>)
2203
2204 <p>
2205 Public method to update submodules offering a dialog to select the
2206 update options.
2207 </p>
2208 <dl>
2209
2210 <dt><i>projectDir</i> (str)</dt>
2211 <dd>
2212 name of the project directory
2213 </dd>
2214 </dl>
2215 <a NAME="Git.gitUnstage" ID="Git.gitUnstage"></a>
2216 <h4>Git.gitUnstage</h4>
2217 <b>gitUnstage</b>(<i>name</i>)
2218
2219 <p>
2220 Public method used to unstage a file/directory.
2221 </p>
2222 <dl>
2223
2224 <dt><i>name</i></dt>
2225 <dd>
2226 file/directory name to be reverted (string)
2227 </dd>
2228 </dl>
2229 <dl>
2230 <dt>Return:</dt>
2231 <dd>
2232 flag indicating, that the update contained an add
2233 or delete (boolean)
2234 </dd>
2235 </dl>
2236 <a NAME="Git.gitVerify" ID="Git.gitVerify"></a>
2237 <h4>Git.gitVerify</h4>
2238 <b>gitVerify</b>(<i>projectDir</i>)
2239
2240 <p>
2241 Public method to verify the connectivity and validity of objects
2242 of the database.
2243 </p>
2244 <dl>
2245
2246 <dt><i>projectDir</i></dt>
2247 <dd>
2248 name of the project directory (string)
2249 </dd>
2250 </dl>
2251 <a NAME="Git.gitVerifyBundle" ID="Git.gitVerifyBundle"></a>
2252 <h4>Git.gitVerifyBundle</h4>
2253 <b>gitVerifyBundle</b>(<i>projectDir</i>)
2254
2255 <p>
2256 Public method to verify a bundle file.
2257 </p>
2258 <dl>
2259
2260 <dt><i>projectDir</i></dt>
2261 <dd>
2262 name of the project directory (string)
2263 </dd>
2264 </dl>
2265 <a NAME="Git.initCommand" ID="Git.initCommand"></a>
2266 <h4>Git.initCommand</h4>
2267 <b>initCommand</b>(<i>command</i>)
2268
2269 <p>
2270 Public method to initialize a command arguments list.
2271 </p>
2272 <dl>
2273
2274 <dt><i>command</i></dt>
2275 <dd>
2276 command name (string)
2277 </dd>
2278 </dl>
2279 <dl>
2280 <dt>Return:</dt>
2281 <dd>
2282 list of command options (list of string)
2283 </dd>
2284 </dl>
2285 <a NAME="Git.vcsAdd" ID="Git.vcsAdd"></a>
2286 <h4>Git.vcsAdd</h4>
2287 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
2288
2289 <p>
2290 Public method used to add a file/directory to the Git repository.
2291 </p>
2292 <dl>
2293
2294 <dt><i>name</i></dt>
2295 <dd>
2296 file/directory name to be added (string)
2297 </dd>
2298 <dt><i>isDir</i></dt>
2299 <dd>
2300 flag indicating name is a directory (boolean)
2301 </dd>
2302 <dt><i>noDialog</i></dt>
2303 <dd>
2304 flag indicating quiet operations
2305 </dd>
2306 </dl>
2307 <a NAME="Git.vcsAddBinary" ID="Git.vcsAddBinary"></a>
2308 <h4>Git.vcsAddBinary</h4>
2309 <b>vcsAddBinary</b>(<i>name, isDir=False</i>)
2310
2311 <p>
2312 Public method used to add a file/directory in binary mode to the
2313 Git repository.
2314 </p>
2315 <dl>
2316
2317 <dt><i>name</i></dt>
2318 <dd>
2319 file/directory name to be added (string)
2320 </dd>
2321 <dt><i>isDir</i></dt>
2322 <dd>
2323 flag indicating name is a directory (boolean)
2324 </dd>
2325 </dl>
2326 <a NAME="Git.vcsAddTree" ID="Git.vcsAddTree"></a>
2327 <h4>Git.vcsAddTree</h4>
2328 <b>vcsAddTree</b>(<i>path</i>)
2329
2330 <p>
2331 Public method to add a directory tree rooted at path to the Git
2332 repository.
2333 </p>
2334 <dl>
2335
2336 <dt><i>path</i></dt>
2337 <dd>
2338 root directory of the tree to be added (string or list of
2339 strings))
2340 </dd>
2341 </dl>
2342 <a NAME="Git.vcsAllRegisteredStates" ID="Git.vcsAllRegisteredStates"></a>
2343 <h4>Git.vcsAllRegisteredStates</h4>
2344 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>)
2345
2346 <p>
2347 Public method used to get the registered states of a number of files
2348 in the vcs.
2349 </p>
2350 <p>
2351 <b>Note:</b> If a shortcut is to be taken, the code will only check,
2352 if the named directory has been scanned already. If so, it is assumed,
2353 that the states for all files have been populated by the previous run.
2354 </p>
2355 <dl>
2356
2357 <dt><i>names</i></dt>
2358 <dd>
2359 dictionary with all filenames to be checked as keys
2360 </dd>
2361 <dt><i>dname</i></dt>
2362 <dd>
2363 directory to check in (string)
2364 </dd>
2365 <dt><i>shortcut</i></dt>
2366 <dd>
2367 flag indicating a shortcut should be taken (boolean)
2368 </dd>
2369 </dl>
2370 <dl>
2371 <dt>Return:</dt>
2372 <dd>
2373 the received dictionary completed with a combination of
2374 canBeCommited and canBeAdded or None in order to signal an error
2375 </dd>
2376 </dl>
2377 <a NAME="Git.vcsCheckout" ID="Git.vcsCheckout"></a>
2378 <h4>Git.vcsCheckout</h4>
2379 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
2380
2381 <p>
2382 Public method used to check the project out of a Git repository
2383 (clone).
2384 </p>
2385 <dl>
2386
2387 <dt><i>vcsDataDict</i></dt>
2388 <dd>
2389 dictionary of data required for the checkout
2390 </dd>
2391 <dt><i>projectDir</i></dt>
2392 <dd>
2393 project directory to create (string)
2394 </dd>
2395 <dt><i>noDialog</i></dt>
2396 <dd>
2397 flag indicating quiet operations
2398 </dd>
2399 </dl>
2400 <dl>
2401 <dt>Return:</dt>
2402 <dd>
2403 flag indicating an execution without errors (boolean)
2404 </dd>
2405 </dl>
2406 <a NAME="Git.vcsCleanup" ID="Git.vcsCleanup"></a>
2407 <h4>Git.vcsCleanup</h4>
2408 <b>vcsCleanup</b>(<i>name</i>)
2409
2410 <p>
2411 Public method used to cleanup the working directory.
2412 </p>
2413 <dl>
2414
2415 <dt><i>name</i></dt>
2416 <dd>
2417 directory name to be cleaned up (string)
2418 </dd>
2419 </dl>
2420 <a NAME="Git.vcsCommandLine" ID="Git.vcsCommandLine"></a>
2421 <h4>Git.vcsCommandLine</h4>
2422 <b>vcsCommandLine</b>(<i>name</i>)
2423
2424 <p>
2425 Public method used to execute arbitrary Git commands.
2426 </p>
2427 <dl>
2428
2429 <dt><i>name</i></dt>
2430 <dd>
2431 directory name of the working directory (string)
2432 </dd>
2433 </dl>
2434 <a NAME="Git.vcsCommit" ID="Git.vcsCommit"></a>
2435 <h4>Git.vcsCommit</h4>
2436 <b>vcsCommit</b>(<i>name, message="", noDialog=False, commitAll=True, amend=False</i>)
2437
2438 <p>
2439 Public method used to make the change of a file/directory permanent
2440 in the Git repository.
2441 </p>
2442 <dl>
2443
2444 <dt><i>name</i></dt>
2445 <dd>
2446 file/directory name to be committed (string or list of
2447 strings)
2448 </dd>
2449 <dt><i>message</i></dt>
2450 <dd>
2451 message for this operation (string)
2452 </dd>
2453 <dt><i>noDialog</i></dt>
2454 <dd>
2455 flag indicating quiet operations (boolean)
2456 </dd>
2457 <dt><i>commitAll</i></dt>
2458 <dd>
2459 flag indicating to commit all local changes (boolean)
2460 </dd>
2461 <dt><i>amend</i></dt>
2462 <dd>
2463 flag indicating to amend the HEAD commit (boolean)
2464 </dd>
2465 </dl>
2466 <a NAME="Git.vcsConvertProject" ID="Git.vcsConvertProject"></a>
2467 <h4>Git.vcsConvertProject</h4>
2468 <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>)
2469
2470 <p>
2471 Public method to convert an uncontrolled project to a version
2472 controlled project.
2473 </p>
2474 <dl>
2475
2476 <dt><i>vcsDataDict</i> (dict)</dt>
2477 <dd>
2478 dictionary of data required for the conversion
2479 </dd>
2480 <dt><i>project</i> (Project)</dt>
2481 <dd>
2482 reference to the project object
2483 </dd>
2484 <dt><i>addAll</i> (bool)</dt>
2485 <dd>
2486 flag indicating to add all files to the repository
2487 </dd>
2488 </dl>
2489 <a NAME="Git.vcsDiff" ID="Git.vcsDiff"></a>
2490 <h4>Git.vcsDiff</h4>
2491 <b>vcsDiff</b>(<i>name</i>)
2492
2493 <p>
2494 Public method used to view the difference of a file/directory to the
2495 Git repository.
2496 </p>
2497 <p>
2498 If name is a directory and is the project directory, all project files
2499 are saved first. If name is a file (or list of files), which is/are
2500 being edited and has unsaved modification, they can be saved or the
2501 operation may be aborted.
2502 </p>
2503 <dl>
2504
2505 <dt><i>name</i></dt>
2506 <dd>
2507 file/directory name to be diffed (string)
2508 </dd>
2509 </dl>
2510 <a NAME="Git.vcsExists" ID="Git.vcsExists"></a>
2511 <h4>Git.vcsExists</h4>
2512 <b>vcsExists</b>(<i></i>)
2513
2514 <p>
2515 Public method used to test for the presence of the git executable.
2516 </p>
2517 <dl>
2518 <dt>Return:</dt>
2519 <dd>
2520 flag indicating the existance (boolean) and an error message
2521 (string)
2522 </dd>
2523 </dl>
2524 <a NAME="Git.vcsExport" ID="Git.vcsExport"></a>
2525 <h4>Git.vcsExport</h4>
2526 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
2527
2528 <p>
2529 Public method used to export a directory from the Git repository.
2530 </p>
2531 <dl>
2532
2533 <dt><i>vcsDataDict</i></dt>
2534 <dd>
2535 dictionary of data required for the checkout
2536 </dd>
2537 <dt><i>projectDir</i></dt>
2538 <dd>
2539 project directory to create (string)
2540 </dd>
2541 </dl>
2542 <dl>
2543 <dt>Return:</dt>
2544 <dd>
2545 flag indicating an execution without errors (boolean)
2546 </dd>
2547 </dl>
2548 <a NAME="Git.vcsGetProjectBrowserHelper" ID="Git.vcsGetProjectBrowserHelper"></a>
2549 <h4>Git.vcsGetProjectBrowserHelper</h4>
2550 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
2551
2552 <p>
2553 Public method to instantiate a helper object for the different
2554 project browsers.
2555 </p>
2556 <dl>
2557
2558 <dt><i>browser</i></dt>
2559 <dd>
2560 reference to the project browser object
2561 </dd>
2562 <dt><i>project</i></dt>
2563 <dd>
2564 reference to the project object
2565 </dd>
2566 <dt><i>isTranslationsBrowser</i></dt>
2567 <dd>
2568 flag indicating, the helper is requested
2569 for the translations browser (this needs some special treatment)
2570 </dd>
2571 </dl>
2572 <dl>
2573 <dt>Return:</dt>
2574 <dd>
2575 the project browser helper object
2576 </dd>
2577 </dl>
2578 <a NAME="Git.vcsGetProjectHelper" ID="Git.vcsGetProjectHelper"></a>
2579 <h4>Git.vcsGetProjectHelper</h4>
2580 <b>vcsGetProjectHelper</b>(<i>project</i>)
2581
2582 <p>
2583 Public method to instantiate a helper object for the project.
2584 </p>
2585 <dl>
2586
2587 <dt><i>project</i></dt>
2588 <dd>
2589 reference to the project object
2590 </dd>
2591 </dl>
2592 <dl>
2593 <dt>Return:</dt>
2594 <dd>
2595 the project helper object
2596 </dd>
2597 </dl>
2598 <a NAME="Git.vcsImport" ID="Git.vcsImport"></a>
2599 <h4>Git.vcsImport</h4>
2600 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>)
2601
2602 <p>
2603 Public method used to import the project into the Git repository.
2604 </p>
2605 <dl>
2606
2607 <dt><i>vcsDataDict</i> (dict)</dt>
2608 <dd>
2609 dictionary of data required for the import
2610 </dd>
2611 <dt><i>projectDir</i> (str)</dt>
2612 <dd>
2613 project directory (string)
2614 </dd>
2615 <dt><i>noDialog</i> (bool)</dt>
2616 <dd>
2617 flag indicating quiet operations
2618 </dd>
2619 <dt><i>addAll</i> (bool)</dt>
2620 <dd>
2621 flag indicating to add all files to the repository
2622 </dd>
2623 </dl>
2624 <dl>
2625 <dt>Return:</dt>
2626 <dd>
2627 tuple containing a flag indicating an execution without errors
2628 and a flag indicating the version controll status
2629 </dd>
2630 </dl>
2631 <dl>
2632 <dt>Return Type:</dt>
2633 <dd>
2634 tuple of (bool, bool)
2635 </dd>
2636 </dl>
2637 <a NAME="Git.vcsInit" ID="Git.vcsInit"></a>
2638 <h4>Git.vcsInit</h4>
2639 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
2640
2641 <p>
2642 Public method used to initialize the Git repository.
2643 </p>
2644 <p>
2645 The initialization is done, when a project is converted into a
2646 Git controlled project. Therefore we always return TRUE without
2647 doing anything.
2648 </p>
2649 <dl>
2650
2651 <dt><i>vcsDir</i></dt>
2652 <dd>
2653 name of the VCS directory (string)
2654 </dd>
2655 <dt><i>noDialog</i></dt>
2656 <dd>
2657 flag indicating quiet operations (boolean)
2658 </dd>
2659 </dl>
2660 <dl>
2661 <dt>Return:</dt>
2662 <dd>
2663 always TRUE
2664 </dd>
2665 </dl>
2666 <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a>
2667 <h4>Git.vcsInitConfig</h4>
2668 <b>vcsInitConfig</b>(<i>project</i>)
2669
2670 <p>
2671 Public method to initialize the VCS configuration.
2672 </p>
2673 <p>
2674 This method ensures, that an ignore file exists.
2675 </p>
2676 <dl>
2677
2678 <dt><i>project</i></dt>
2679 <dd>
2680 reference to the project (Project)
2681 </dd>
2682 </dl>
2683 <a NAME="Git.vcsLogBrowser" ID="Git.vcsLogBrowser"></a>
2684 <h4>Git.vcsLogBrowser</h4>
2685 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>)
2686
2687 <p>
2688 Public method used to browse the log of a file/directory from the
2689 Git repository.
2690 </p>
2691 <dl>
2692
2693 <dt><i>name</i></dt>
2694 <dd>
2695 file/directory name to show the log of (string)
2696 </dd>
2697 <dt><i>isFile</i></dt>
2698 <dd>
2699 flag indicating log for a file is to be shown
2700 (boolean)
2701 </dd>
2702 </dl>
2703 <a NAME="Git.vcsMerge" ID="Git.vcsMerge"></a>
2704 <h4>Git.vcsMerge</h4>
2705 <b>vcsMerge</b>(<i>name</i>)
2706
2707 <p>
2708 Public method used to merge a URL/revision into the local project.
2709 </p>
2710 <dl>
2711
2712 <dt><i>name</i></dt>
2713 <dd>
2714 file/directory name to be merged (string)
2715 </dd>
2716 </dl>
2717 <a NAME="Git.vcsMove" ID="Git.vcsMove"></a>
2718 <h4>Git.vcsMove</h4>
2719 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>)
2720
2721 <p>
2722 Public method used to move a file/directory.
2723 </p>
2724 <dl>
2725
2726 <dt><i>name</i></dt>
2727 <dd>
2728 file/directory name to be moved (string)
2729 </dd>
2730 <dt><i>project</i></dt>
2731 <dd>
2732 reference to the project object
2733 </dd>
2734 <dt><i>target</i></dt>
2735 <dd>
2736 new name of the file/directory (string)
2737 </dd>
2738 <dt><i>noDialog</i></dt>
2739 <dd>
2740 flag indicating quiet operations
2741 </dd>
2742 </dl>
2743 <dl>
2744 <dt>Return:</dt>
2745 <dd>
2746 flag indicating successful operation (boolean)
2747 </dd>
2748 </dl>
2749 <a NAME="Git.vcsName" ID="Git.vcsName"></a>
2750 <h4>Git.vcsName</h4>
2751 <b>vcsName</b>(<i></i>)
2752
2753 <p>
2754 Public method returning the name of the vcs.
2755 </p>
2756 <dl>
2757 <dt>Return:</dt>
2758 <dd>
2759 always 'Git' (string)
2760 </dd>
2761 </dl>
2762 <a NAME="Git.vcsNewProjectOptionsDialog" ID="Git.vcsNewProjectOptionsDialog"></a>
2763 <h4>Git.vcsNewProjectOptionsDialog</h4>
2764 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>)
2765
2766 <p>
2767 Public method to get a dialog to enter repository info for getting a
2768 new project.
2769 </p>
2770 <dl>
2771
2772 <dt><i>parent</i></dt>
2773 <dd>
2774 parent widget (QWidget)
2775 </dd>
2776 </dl>
2777 <dl>
2778 <dt>Return:</dt>
2779 <dd>
2780 reference to the instantiated options dialog
2781 (GitNewProjectOptionsDialog)
2782 </dd>
2783 </dl>
2784 <a NAME="Git.vcsOptionsDialog" ID="Git.vcsOptionsDialog"></a>
2785 <h4>Git.vcsOptionsDialog</h4>
2786 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>)
2787
2788 <p>
2789 Public method to get a dialog to enter repository info.
2790 </p>
2791 <dl>
2792
2793 <dt><i>project</i></dt>
2794 <dd>
2795 reference to the project object
2796 </dd>
2797 <dt><i>archive</i></dt>
2798 <dd>
2799 name of the project in the repository (string)
2800 </dd>
2801 <dt><i>editable</i></dt>
2802 <dd>
2803 flag indicating that the project name is editable
2804 (boolean)
2805 </dd>
2806 <dt><i>parent</i></dt>
2807 <dd>
2808 parent widget (QWidget)
2809 </dd>
2810 </dl>
2811 <dl>
2812 <dt>Return:</dt>
2813 <dd>
2814 reference to the instantiated options dialog (GitOptionsDialog)
2815 </dd>
2816 </dl>
2817 <a NAME="Git.vcsRegisteredState" ID="Git.vcsRegisteredState"></a>
2818 <h4>Git.vcsRegisteredState</h4>
2819 <b>vcsRegisteredState</b>(<i>name</i>)
2820
2821 <p>
2822 Public method used to get the registered state of a file in the vcs.
2823 </p>
2824 <dl>
2825
2826 <dt><i>name</i></dt>
2827 <dd>
2828 filename to check (string)
2829 </dd>
2830 </dl>
2831 <dl>
2832 <dt>Return:</dt>
2833 <dd>
2834 a combination of canBeCommited and canBeAdded
2835 </dd>
2836 </dl>
2837 <a NAME="Git.vcsRemove" ID="Git.vcsRemove"></a>
2838 <h4>Git.vcsRemove</h4>
2839 <b>vcsRemove</b>(<i>name, project=False, noDialog=False, stageOnly=False</i>)
2840
2841 <p>
2842 Public method used to remove a file/directory from the Git
2843 repository.
2844 </p>
2845 <p>
2846 The default operation is to remove the local copy as well.
2847 </p>
2848 <dl>
2849
2850 <dt><i>name</i></dt>
2851 <dd>
2852 file/directory name to be removed (string or list of
2853 strings))
2854 </dd>
2855 <dt><i>project</i></dt>
2856 <dd>
2857 flag indicating deletion of a project tree (boolean)
2858 (not needed)
2859 </dd>
2860 <dt><i>noDialog</i></dt>
2861 <dd>
2862 flag indicating quiet operations (boolean)
2863 </dd>
2864 <dt><i>stageOnly</i></dt>
2865 <dd>
2866 flag indicating to just remove the file from the
2867 staging area (boolean)
2868 </dd>
2869 </dl>
2870 <dl>
2871 <dt>Return:</dt>
2872 <dd>
2873 flag indicating successful operation (boolean)
2874 </dd>
2875 </dl>
2876 <a NAME="Git.vcsRepositoryInfos" ID="Git.vcsRepositoryInfos"></a>
2877 <h4>Git.vcsRepositoryInfos</h4>
2878 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
2879
2880 <p>
2881 Public method to retrieve information about the repository.
2882 </p>
2883 <dl>
2884
2885 <dt><i>ppath</i></dt>
2886 <dd>
2887 local path to get the repository infos (string)
2888 </dd>
2889 </dl>
2890 <dl>
2891 <dt>Return:</dt>
2892 <dd>
2893 string with ready formated info for display (string)
2894 </dd>
2895 </dl>
2896 <a NAME="Git.vcsShutdown" ID="Git.vcsShutdown"></a>
2897 <h4>Git.vcsShutdown</h4>
2898 <b>vcsShutdown</b>(<i></i>)
2899
2900 <p>
2901 Public method used to shutdown the Git interface.
2902 </p>
2903 <a NAME="Git.vcsStatus" ID="Git.vcsStatus"></a>
2904 <h4>Git.vcsStatus</h4>
2905 <b>vcsStatus</b>(<i>name</i>)
2906
2907 <p>
2908 Public method used to view the status of files/directories in the
2909 Git repository.
2910 </p>
2911 <dl>
2912
2913 <dt><i>name</i></dt>
2914 <dd>
2915 file/directory name(s) to show the status of
2916 (string or list of strings)
2917 </dd>
2918 </dl>
2919 <a NAME="Git.vcsSupportCommandOptions" ID="Git.vcsSupportCommandOptions"></a>
2920 <h4>Git.vcsSupportCommandOptions</h4>
2921 <b>vcsSupportCommandOptions</b>(<i></i>)
2922
2923 <p>
2924 Public method to signal the support of user settable command options.
2925 </p>
2926 <dl>
2927 <dt>Return:</dt>
2928 <dd>
2929 flag indicating the support of user settable command options
2930 (boolean)
2931 </dd>
2932 </dl>
2933 <a NAME="Git.vcsSwitch" ID="Git.vcsSwitch"></a>
2934 <h4>Git.vcsSwitch</h4>
2935 <b>vcsSwitch</b>(<i>name</i>)
2936
2937 <p>
2938 Public method used to switch a working directory to a different
2939 revision.
2940 </p>
2941 <dl>
2942
2943 <dt><i>name</i></dt>
2944 <dd>
2945 directory name to be switched (string)
2946 </dd>
2947 </dl>
2948 <dl>
2949 <dt>Return:</dt>
2950 <dd>
2951 flag indicating, that the switch contained an add
2952 or delete (boolean)
2953 </dd>
2954 </dl>
2955 <a NAME="Git.vcsTag" ID="Git.vcsTag"></a>
2956 <h4>Git.vcsTag</h4>
2957 <b>vcsTag</b>(<i>name, revision=None, tagName=None</i>)
2958
2959 <p>
2960 Public method used to set/remove a tag in the Git repository.
2961 </p>
2962 <dl>
2963
2964 <dt><i>name</i></dt>
2965 <dd>
2966 file/directory name to determine the repo root from
2967 (string)
2968 </dd>
2969 <dt><i>revision</i></dt>
2970 <dd>
2971 revision to set tag for (string)
2972 </dd>
2973 <dt><i>tagName</i></dt>
2974 <dd>
2975 name of the tag (string)
2976 </dd>
2977 </dl>
2978 <dl>
2979 <dt>Return:</dt>
2980 <dd>
2981 flag indicating a performed tag action (boolean)
2982 </dd>
2983 </dl>
2984 <a NAME="Git.vcsUpdate" ID="Git.vcsUpdate"></a>
2985 <h4>Git.vcsUpdate</h4>
2986 <b>vcsUpdate</b>(<i>name, noDialog=False, revision=None</i>)
2987
2988 <p>
2989 Public method used to update a file/directory with the Git
2990 repository.
2991 </p>
2992 <dl>
2993
2994 <dt><i>name</i></dt>
2995 <dd>
2996 file/directory name to be updated (string or list of
2997 strings)
2998 </dd>
2999 <dt><i>noDialog</i></dt>
3000 <dd>
3001 flag indicating quiet operations (boolean)
3002 </dd>
3003 <dt><i>revision</i></dt>
3004 <dd>
3005 revision to update to (string)
3006 </dd>
3007 </dl>
3008 <dl>
3009 <dt>Return:</dt>
3010 <dd>
3011 flag indicating, that the update contained an add
3012 or delete (boolean)
3013 </dd>
3014 </dl>
3015 <div align="right"><a href="#top">Up</a></div>
3016 <hr />
3017 </body></html>

Mercurial Repository: eric

eric ide

mercurial