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