eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.git.html

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

eric ide

mercurial