Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.git.html
Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.git.html
- changeset 6020
- baf6da1ae288
- child 6324
- b11c36cba2a1
equal
deleted
inserted
replaced
| 6019:58ecdaf0b789 | 6020:baf6da1ae288 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Plugins.VcsPlugins.vcsGit.git</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsGit.git</h1> | |
| 23 <p> | |
| 24 Module implementing the version control systems interface to Git. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#Git">Git</a></td> | |
| 34 <td>Class implementing the version control systems interface to Git.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="Git" ID="Git"></a> | |
| 43 <h2>Git</h2> | |
| 44 <p> | |
| 45 Class implementing the version control systems interface to Git. | |
| 46 </p><h3>Signals</h3> | |
| 47 <dl> | |
| 48 <dt>committed()</dt> | |
| 49 <dd> | |
| 50 emitted after the commit action has completed | |
| 51 </dd> | |
| 52 </dl> | |
| 53 <h3>Derived from</h3> | |
| 54 VersionControl | |
| 55 <h3>Class Attributes</h3> | |
| 56 <table> | |
| 57 <tr><td>IgnoreFileName</td></tr> | |
| 58 </table> | |
| 59 <h3>Class Methods</h3> | |
| 60 <table> | |
| 61 <tr><td>None</td></tr> | |
| 62 </table> | |
| 63 <h3>Methods</h3> | |
| 64 <table> | |
| 65 <tr> | |
| 66 <td><a href="#Git.__init__">Git</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#Git.__gitGetFileForRevision">__gitGetFileForRevision</a></td> | |
| 70 <td>Private method to get a file for a specific revision from the repository.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#Git.__gitGetStashesList">__gitGetStashesList</a></td> | |
| 73 <td>Private method to get a list of stash names.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#Git.__gitSubmodulesList">__gitSubmodulesList</a></td> | |
| 76 <td>Private method to get the data of defined submodules.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#Git.__selectSubmodulePath">__selectSubmodulePath</a></td> | |
| 79 <td>Private method to select a submodule path.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#Git.__selectSubmodulePaths">__selectSubmodulePaths</a></td> | |
| 82 <td>Private method to select a list of submodule paths.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#Git.__vcsCommit_Step2">__vcsCommit_Step2</a></td> | |
| 85 <td>Private slot performing the second step of the commit action.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#Git._createStatusMonitorThread">_createStatusMonitorThread</a></td> | |
| 88 <td>Protected method to create an instance of the VCS status monitor thread.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#Git.clearStatusCache">clearStatusCache</a></td> | |
| 91 <td>Public method to clear the status cache.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#Git.getPlugin">getPlugin</a></td> | |
| 94 <td>Public method to get a reference to the plugin object.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#Git.gitAddRemote">gitAddRemote</a></td> | |
| 97 <td>Public method to add a remote repository.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#Git.gitApply">gitApply</a></td> | |
| 100 <td>Public method to apply a patch stored in a given file.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#Git.gitApplyCheckPatches">gitApplyCheckPatches</a></td> | |
| 103 <td>Public method to apply a list of patch files or check, if they would apply cleanly.</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#Git.gitBisect">gitBisect</a></td> | |
| 106 <td>Public method to perform bisect commands.</td> | |
| 107 </tr><tr> | |
| 108 <td><a href="#Git.gitBisectCreateReplayFile">gitBisectCreateReplayFile</a></td> | |
| 109 <td>Public method used to create a bisect replay file for the project.</td> | |
| 110 </tr><tr> | |
| 111 <td><a href="#Git.gitBisectEditReplayFile">gitBisectEditReplayFile</a></td> | |
| 112 <td>Public method used to edit a bisect replay file.</td> | |
| 113 </tr><tr> | |
| 114 <td><a href="#Git.gitBisectLogBrowser">gitBisectLogBrowser</a></td> | |
| 115 <td>Public method used to browse the bisect log of the project.</td> | |
| 116 </tr><tr> | |
| 117 <td><a href="#Git.gitBisectReplay">gitBisectReplay</a></td> | |
| 118 <td>Public method to replay a bisect session.</td> | |
| 119 </tr><tr> | |
| 120 <td><a href="#Git.gitBlame">gitBlame</a></td> | |
| 121 <td>Public method to show the output of the git blame command.</td> | |
| 122 </tr><tr> | |
| 123 <td><a href="#Git.gitBranch">gitBranch</a></td> | |
| 124 <td>Public method used to create, delete or move a branch in the Git repository.</td> | |
| 125 </tr><tr> | |
| 126 <td><a href="#Git.gitBundle">gitBundle</a></td> | |
| 127 <td>Public method to create a bundle file.</td> | |
| 128 </tr><tr> | |
| 129 <td><a href="#Git.gitBundleFetch">gitBundleFetch</a></td> | |
| 130 <td>Public method to fetch a head of a bundle file into the local repository.</td> | |
| 131 </tr><tr> | |
| 132 <td><a href="#Git.gitBundleListHeads">gitBundleListHeads</a></td> | |
| 133 <td>Public method to list the heads contained in a bundle file.</td> | |
| 134 </tr><tr> | |
| 135 <td><a href="#Git.gitBundlePull">gitBundlePull</a></td> | |
| 136 <td>Public method to pull a head of a bundle file into the local repository and working area.</td> | |
| 137 </tr><tr> | |
| 138 <td><a href="#Git.gitCancelMerge">gitCancelMerge</a></td> | |
| 139 <td>Public method to cancel an uncommitted or failed merge.</td> | |
| 140 </tr><tr> | |
| 141 <td><a href="#Git.gitCherryPick">gitCherryPick</a></td> | |
| 142 <td>Public method to cherry pick commits and apply them to the current branch.</td> | |
| 143 </tr><tr> | |
| 144 <td><a href="#Git.gitCherryPickAbort">gitCherryPickAbort</a></td> | |
| 145 <td>Public method to cancel the last copying session and return to the previous state.</td> | |
| 146 </tr><tr> | |
| 147 <td><a href="#Git.gitCherryPickContinue">gitCherryPickContinue</a></td> | |
| 148 <td>Public method to continue the last copying session after conflicts were resolved.</td> | |
| 149 </tr><tr> | |
| 150 <td><a href="#Git.gitCherryPickQuit">gitCherryPickQuit</a></td> | |
| 151 <td>Public method to quit the current copying operation.</td> | |
| 152 </tr><tr> | |
| 153 <td><a href="#Git.gitCommitMerge">gitCommitMerge</a></td> | |
| 154 <td>Public method to commit a failed merge.</td> | |
| 155 </tr><tr> | |
| 156 <td><a href="#Git.gitCopy">gitCopy</a></td> | |
| 157 <td>Public method used to copy a file/directory.</td> | |
| 158 </tr><tr> | |
| 159 <td><a href="#Git.gitCreateArchive">gitCreateArchive</a></td> | |
| 160 <td>Public method to show some statistics of the local repository.</td> | |
| 161 </tr><tr> | |
| 162 <td><a href="#Git.gitCreateIgnoreFile">gitCreateIgnoreFile</a></td> | |
| 163 <td>Public method to create the ignore file.</td> | |
| 164 </tr><tr> | |
| 165 <td><a href="#Git.gitDeleteRemoteBranch">gitDeleteRemoteBranch</a></td> | |
| 166 <td>Public method to delete a branch from a remote repository.</td> | |
| 167 </tr><tr> | |
| 168 <td><a href="#Git.gitDescribe">gitDescribe</a></td> | |
| 169 <td>Public method to find the most recent tag reachable from each commit.</td> | |
| 170 </tr><tr> | |
| 171 <td><a href="#Git.gitEditConfig">gitEditConfig</a></td> | |
| 172 <td>Public method used to edit the repository configuration file.</td> | |
| 173 </tr><tr> | |
| 174 <td><a href="#Git.gitEditUserConfig">gitEditUserConfig</a></td> | |
| 175 <td>Public method used to edit the user configuration file.</td> | |
| 176 </tr><tr> | |
| 177 <td><a href="#Git.gitExtendedDiff">gitExtendedDiff</a></td> | |
| 178 <td>Public method used to view the difference of a file/directory to the Git repository.</td> | |
| 179 </tr><tr> | |
| 180 <td><a href="#Git.gitFetch">gitFetch</a></td> | |
| 181 <td>Public method to fetch changes from a remote repository.</td> | |
| 182 </tr><tr> | |
| 183 <td><a href="#Git.gitGetArchiveFormats">gitGetArchiveFormats</a></td> | |
| 184 <td>Public method to get a list of supported archive formats.</td> | |
| 185 </tr><tr> | |
| 186 <td><a href="#Git.gitGetBranchesList">gitGetBranchesList</a></td> | |
| 187 <td>Public method to get the list of branches.</td> | |
| 188 </tr><tr> | |
| 189 <td><a href="#Git.gitGetBundleHeads">gitGetBundleHeads</a></td> | |
| 190 <td>Public method to get a list of heads contained in a bundle file.</td> | |
| 191 </tr><tr> | |
| 192 <td><a href="#Git.gitGetCurrentBranch">gitGetCurrentBranch</a></td> | |
| 193 <td>Public method used to show the current branch of the working directory.</td> | |
| 194 </tr><tr> | |
| 195 <td><a href="#Git.gitGetRemoteBranchesList">gitGetRemoteBranchesList</a></td> | |
| 196 <td>Public method to get the list of a remote repository branches.</td> | |
| 197 </tr><tr> | |
| 198 <td><a href="#Git.gitGetRemoteUrlsList">gitGetRemoteUrlsList</a></td> | |
| 199 <td>Public method to get the list of remote repos and their URLs.</td> | |
| 200 </tr><tr> | |
| 201 <td><a href="#Git.gitGetRemotesList">gitGetRemotesList</a></td> | |
| 202 <td>Public method to get the list of remote repos.</td> | |
| 203 </tr><tr> | |
| 204 <td><a href="#Git.gitGetTagsList">gitGetTagsList</a></td> | |
| 205 <td>Public method to get the list of tags.</td> | |
| 206 </tr><tr> | |
| 207 <td><a href="#Git.gitHouseKeeping">gitHouseKeeping</a></td> | |
| 208 <td>Public method to cleanup and optimize the local repository.</td> | |
| 209 </tr><tr> | |
| 210 <td><a href="#Git.gitListTagBranch">gitListTagBranch</a></td> | |
| 211 <td>Public method used to list the available tags or branches.</td> | |
| 212 </tr><tr> | |
| 213 <td><a href="#Git.gitNormalizeURL">gitNormalizeURL</a></td> | |
| 214 <td>Public method to normalize a url for Git.</td> | |
| 215 </tr><tr> | |
| 216 <td><a href="#Git.gitPruneRemote">gitPruneRemote</a></td> | |
| 217 <td>Public method to prune stale remote-tracking branches.</td> | |
| 218 </tr><tr> | |
| 219 <td><a href="#Git.gitPull">gitPull</a></td> | |
| 220 <td>Public method used to pull changes from a remote Git repository.</td> | |
| 221 </tr><tr> | |
| 222 <td><a href="#Git.gitPush">gitPush</a></td> | |
| 223 <td>Public method used to push changes to a remote Git repository.</td> | |
| 224 </tr><tr> | |
| 225 <td><a href="#Git.gitReflogBrowser">gitReflogBrowser</a></td> | |
| 226 <td>Public method used to browse the reflog of the project.</td> | |
| 227 </tr><tr> | |
| 228 <td><a href="#Git.gitRemoveRemote">gitRemoveRemote</a></td> | |
| 229 <td>Public method to remove a remote repository.</td> | |
| 230 </tr><tr> | |
| 231 <td><a href="#Git.gitRenameRemote">gitRenameRemote</a></td> | |
| 232 <td>Public method to rename a remote repository.</td> | |
| 233 </tr><tr> | |
| 234 <td><a href="#Git.gitRevert">gitRevert</a></td> | |
| 235 <td>Public method used to revert changes made to a file/directory.</td> | |
| 236 </tr><tr> | |
| 237 <td><a href="#Git.gitSbsDiff">gitSbsDiff</a></td> | |
| 238 <td>Public method used to view the difference of a file to the Git repository side-by-side.</td> | |
| 239 </tr><tr> | |
| 240 <td><a href="#Git.gitShortlog">gitShortlog</a></td> | |
| 241 <td>Public method to show a short log suitable for inclusion in release announcements.</td> | |
| 242 </tr><tr> | |
| 243 <td><a href="#Git.gitShowBranch">gitShowBranch</a></td> | |
| 244 <td>Public method used to show the current branch of the working directory.</td> | |
| 245 </tr><tr> | |
| 246 <td><a href="#Git.gitShowConfig">gitShowConfig</a></td> | |
| 247 <td>Public method to show the combined configuration.</td> | |
| 248 </tr><tr> | |
| 249 <td><a href="#Git.gitShowPatchesStatistics">gitShowPatchesStatistics</a></td> | |
| 250 <td>Public method to show statistics for a set of patch files.</td> | |
| 251 </tr><tr> | |
| 252 <td><a href="#Git.gitShowRemote">gitShowRemote</a></td> | |
| 253 <td>Public method to show information about a remote repository.</td> | |
| 254 </tr><tr> | |
| 255 <td><a href="#Git.gitShowRemotes">gitShowRemotes</a></td> | |
| 256 <td>Public method to show available remote repositories.</td> | |
| 257 </tr><tr> | |
| 258 <td><a href="#Git.gitStashApply">gitStashApply</a></td> | |
| 259 <td>Public method to apply a stash but keep it.</td> | |
| 260 </tr><tr> | |
| 261 <td><a href="#Git.gitStashBranch">gitStashBranch</a></td> | |
| 262 <td>Public method to create a branch from a stash.</td> | |
| 263 </tr><tr> | |
| 264 <td><a href="#Git.gitStashBrowser">gitStashBrowser</a></td> | |
| 265 <td>Public method used to browse the stashed changes.</td> | |
| 266 </tr><tr> | |
| 267 <td><a href="#Git.gitStashClear">gitStashClear</a></td> | |
| 268 <td>Public method to delete all stashes.</td> | |
| 269 </tr><tr> | |
| 270 <td><a href="#Git.gitStashDrop">gitStashDrop</a></td> | |
| 271 <td>Public method to delete a stash.</td> | |
| 272 </tr><tr> | |
| 273 <td><a href="#Git.gitStashPop">gitStashPop</a></td> | |
| 274 <td>Public method to apply a stash and delete it.</td> | |
| 275 </tr><tr> | |
| 276 <td><a href="#Git.gitStashSave">gitStashSave</a></td> | |
| 277 <td>Public method to save the current changes to a new stash.</td> | |
| 278 </tr><tr> | |
| 279 <td><a href="#Git.gitStashShowPatch">gitStashShowPatch</a></td> | |
| 280 <td>Public method to show the contents of a stash.</td> | |
| 281 </tr><tr> | |
| 282 <td><a href="#Git.gitStatistics">gitStatistics</a></td> | |
| 283 <td>Public method to show some statistics of the local repository.</td> | |
| 284 </tr><tr> | |
| 285 <td><a href="#Git.gitSubmoduleAdd">gitSubmoduleAdd</a></td> | |
| 286 <td>Public method to add a submodule to the project.</td> | |
| 287 </tr><tr> | |
| 288 <td><a href="#Git.gitSubmoduleDeinit">gitSubmoduleDeinit</a></td> | |
| 289 <td>Public method to unregister submodules.</td> | |
| 290 </tr><tr> | |
| 291 <td><a href="#Git.gitSubmoduleInit">gitSubmoduleInit</a></td> | |
| 292 <td>Public method to initialize one or all submodules.</td> | |
| 293 </tr><tr> | |
| 294 <td><a href="#Git.gitSubmoduleList">gitSubmoduleList</a></td> | |
| 295 <td>Public method to show a list of all submodules of the project.</td> | |
| 296 </tr><tr> | |
| 297 <td><a href="#Git.gitSubmoduleStatus">gitSubmoduleStatus</a></td> | |
| 298 <td>Public method to show the status of the submodules.</td> | |
| 299 </tr><tr> | |
| 300 <td><a href="#Git.gitSubmoduleSummary">gitSubmoduleSummary</a></td> | |
| 301 <td>Public method to show the status of the submodules.</td> | |
| 302 </tr><tr> | |
| 303 <td><a href="#Git.gitSubmoduleSync">gitSubmoduleSync</a></td> | |
| 304 <td>Public method to synchronize submodules.</td> | |
| 305 </tr><tr> | |
| 306 <td><a href="#Git.gitSubmoduleUpdate">gitSubmoduleUpdate</a></td> | |
| 307 <td>Public method to update submodules.</td> | |
| 308 </tr><tr> | |
| 309 <td><a href="#Git.gitSubmoduleUpdateWithOptions">gitSubmoduleUpdateWithOptions</a></td> | |
| 310 <td>Public method to update submodules offering a dialog to select the update options.</td> | |
| 311 </tr><tr> | |
| 312 <td><a href="#Git.gitUnstage">gitUnstage</a></td> | |
| 313 <td>Public method used to unstage a file/directory.</td> | |
| 314 </tr><tr> | |
| 315 <td><a href="#Git.gitVerify">gitVerify</a></td> | |
| 316 <td>Public method to verify the connectivity and validity of objects of the database.</td> | |
| 317 </tr><tr> | |
| 318 <td><a href="#Git.gitVerifyBundle">gitVerifyBundle</a></td> | |
| 319 <td>Public method to verify a bundle file.</td> | |
| 320 </tr><tr> | |
| 321 <td><a href="#Git.initCommand">initCommand</a></td> | |
| 322 <td>Public method to initialize a command arguments list.</td> | |
| 323 </tr><tr> | |
| 324 <td><a href="#Git.vcsAdd">vcsAdd</a></td> | |
| 325 <td>Public method used to add a file/directory to the Git repository.</td> | |
| 326 </tr><tr> | |
| 327 <td><a href="#Git.vcsAddBinary">vcsAddBinary</a></td> | |
| 328 <td>Public method used to add a file/directory in binary mode to the Git repository.</td> | |
| 329 </tr><tr> | |
| 330 <td><a href="#Git.vcsAddTree">vcsAddTree</a></td> | |
| 331 <td>Public method to add a directory tree rooted at path to the Git repository.</td> | |
| 332 </tr><tr> | |
| 333 <td><a href="#Git.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td> | |
| 334 <td>Public method used to get the registered states of a number of files in the vcs.</td> | |
| 335 </tr><tr> | |
| 336 <td><a href="#Git.vcsCheckout">vcsCheckout</a></td> | |
| 337 <td>Public method used to check the project out of a Git repository (clone).</td> | |
| 338 </tr><tr> | |
| 339 <td><a href="#Git.vcsCleanup">vcsCleanup</a></td> | |
| 340 <td>Public method used to cleanup the working directory.</td> | |
| 341 </tr><tr> | |
| 342 <td><a href="#Git.vcsCommandLine">vcsCommandLine</a></td> | |
| 343 <td>Public method used to execute arbitrary Git commands.</td> | |
| 344 </tr><tr> | |
| 345 <td><a href="#Git.vcsCommit">vcsCommit</a></td> | |
| 346 <td>Public method used to make the change of a file/directory permanent in the Git repository.</td> | |
| 347 </tr><tr> | |
| 348 <td><a href="#Git.vcsConvertProject">vcsConvertProject</a></td> | |
| 349 <td>Public method to convert an uncontrolled project to a version controlled project.</td> | |
| 350 </tr><tr> | |
| 351 <td><a href="#Git.vcsDiff">vcsDiff</a></td> | |
| 352 <td>Public method used to view the difference of a file/directory to the Git repository.</td> | |
| 353 </tr><tr> | |
| 354 <td><a href="#Git.vcsExists">vcsExists</a></td> | |
| 355 <td>Public method used to test for the presence of the git executable.</td> | |
| 356 </tr><tr> | |
| 357 <td><a href="#Git.vcsExport">vcsExport</a></td> | |
| 358 <td>Public method used to export a directory from the Git repository.</td> | |
| 359 </tr><tr> | |
| 360 <td><a href="#Git.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td> | |
| 361 <td>Public method to instantiate a helper object for the different project browsers.</td> | |
| 362 </tr><tr> | |
| 363 <td><a href="#Git.vcsGetProjectHelper">vcsGetProjectHelper</a></td> | |
| 364 <td>Public method to instantiate a helper object for the project.</td> | |
| 365 </tr><tr> | |
| 366 <td><a href="#Git.vcsImport">vcsImport</a></td> | |
| 367 <td>Public method used to import the project into the Git repository.</td> | |
| 368 </tr><tr> | |
| 369 <td><a href="#Git.vcsInit">vcsInit</a></td> | |
| 370 <td>Public method used to initialize the Git repository.</td> | |
| 371 </tr><tr> | |
| 372 <td><a href="#Git.vcsInitConfig">vcsInitConfig</a></td> | |
| 373 <td>Public method to initialize the VCS configuration.</td> | |
| 374 </tr><tr> | |
| 375 <td><a href="#Git.vcsLogBrowser">vcsLogBrowser</a></td> | |
| 376 <td>Public method used to browse the log of a file/directory from the Git repository.</td> | |
| 377 </tr><tr> | |
| 378 <td><a href="#Git.vcsMerge">vcsMerge</a></td> | |
| 379 <td>Public method used to merge a URL/revision into the local project.</td> | |
| 380 </tr><tr> | |
| 381 <td><a href="#Git.vcsMove">vcsMove</a></td> | |
| 382 <td>Public method used to move a file/directory.</td> | |
| 383 </tr><tr> | |
| 384 <td><a href="#Git.vcsName">vcsName</a></td> | |
| 385 <td>Public method returning the name of the vcs.</td> | |
| 386 </tr><tr> | |
| 387 <td><a href="#Git.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td> | |
| 388 <td>Public method to get a dialog to enter repository info for getting a new project.</td> | |
| 389 </tr><tr> | |
| 390 <td><a href="#Git.vcsOptionsDialog">vcsOptionsDialog</a></td> | |
| 391 <td>Public method to get a dialog to enter repository info.</td> | |
| 392 </tr><tr> | |
| 393 <td><a href="#Git.vcsRegisteredState">vcsRegisteredState</a></td> | |
| 394 <td>Public method used to get the registered state of a file in the vcs.</td> | |
| 395 </tr><tr> | |
| 396 <td><a href="#Git.vcsRemove">vcsRemove</a></td> | |
| 397 <td>Public method used to remove a file/directory from the Git repository.</td> | |
| 398 </tr><tr> | |
| 399 <td><a href="#Git.vcsRepositoryInfos">vcsRepositoryInfos</a></td> | |
| 400 <td>Public method to retrieve information about the repository.</td> | |
| 401 </tr><tr> | |
| 402 <td><a href="#Git.vcsShutdown">vcsShutdown</a></td> | |
| 403 <td>Public method used to shutdown the Git interface.</td> | |
| 404 </tr><tr> | |
| 405 <td><a href="#Git.vcsStatus">vcsStatus</a></td> | |
| 406 <td>Public method used to view the status of files/directories in the Git repository.</td> | |
| 407 </tr><tr> | |
| 408 <td><a href="#Git.vcsSupportCommandOptions">vcsSupportCommandOptions</a></td> | |
| 409 <td>Public method to signal the support of user settable command options.</td> | |
| 410 </tr><tr> | |
| 411 <td><a href="#Git.vcsSwitch">vcsSwitch</a></td> | |
| 412 <td>Public method used to switch a working directory to a different revision.</td> | |
| 413 </tr><tr> | |
| 414 <td><a href="#Git.vcsTag">vcsTag</a></td> | |
| 415 <td>Public method used to set/remove a tag in the Git repository.</td> | |
| 416 </tr><tr> | |
| 417 <td><a href="#Git.vcsUpdate">vcsUpdate</a></td> | |
| 418 <td>Public method used to update a file/directory with the Git repository.</td> | |
| 419 </tr> | |
| 420 </table> | |
| 421 <h3>Static Methods</h3> | |
| 422 <table> | |
| 423 <tr><td>None</td></tr> | |
| 424 </table> | |
| 425 <a NAME="Git.__init__" ID="Git.__init__"></a> | |
| 426 <h4>Git (Constructor)</h4> | |
| 427 <b>Git</b>(<i>plugin, parent=None, name=None</i>) | |
| 428 <p> | |
| 429 Constructor | |
| 430 </p><dl> | |
| 431 <dt><i>plugin</i></dt> | |
| 432 <dd> | |
| 433 reference to the plugin object | |
| 434 </dd><dt><i>parent</i></dt> | |
| 435 <dd> | |
| 436 parent widget (QWidget) | |
| 437 </dd><dt><i>name</i></dt> | |
| 438 <dd> | |
| 439 name of this object (string) | |
| 440 </dd> | |
| 441 </dl><a NAME="Git.__gitGetFileForRevision" ID="Git.__gitGetFileForRevision"></a> | |
| 442 <h4>Git.__gitGetFileForRevision</h4> | |
| 443 <b>__gitGetFileForRevision</b>(<i>name, rev=""</i>) | |
| 444 <p> | |
| 445 Private method to get a file for a specific revision from the | |
| 446 repository. | |
| 447 </p><dl> | |
| 448 <dt><i>name</i></dt> | |
| 449 <dd> | |
| 450 file name to get from the repository (string) | |
| 451 </dd><dt><i>rev=</i></dt> | |
| 452 <dd> | |
| 453 revision to retrieve (string) | |
| 454 </dd> | |
| 455 </dl><dl> | |
| 456 <dt>Returns:</dt> | |
| 457 <dd> | |
| 458 contents of the file (string) and an error message (string) | |
| 459 </dd> | |
| 460 </dl><a NAME="Git.__gitGetStashesList" ID="Git.__gitGetStashesList"></a> | |
| 461 <h4>Git.__gitGetStashesList</h4> | |
| 462 <b>__gitGetStashesList</b>(<i>projectDir</i>) | |
| 463 <p> | |
| 464 Private method to get a list of stash names. | |
| 465 </p><dl> | |
| 466 <dt><i>projectDir</i></dt> | |
| 467 <dd> | |
| 468 name of the project directory (string) | |
| 469 </dd> | |
| 470 </dl><dl> | |
| 471 <dt>Returns:</dt> | |
| 472 <dd> | |
| 473 list of available stashes (list of string) | |
| 474 </dd> | |
| 475 </dl><a NAME="Git.__gitSubmodulesList" ID="Git.__gitSubmodulesList"></a> | |
| 476 <h4>Git.__gitSubmodulesList</h4> | |
| 477 <b>__gitSubmodulesList</b>(<i>repodir</i>) | |
| 478 <p> | |
| 479 Private method to get the data of defined submodules. | |
| 480 </p><dl> | |
| 481 <dt><i>repodir</i> (str)</dt> | |
| 482 <dd> | |
| 483 name of the directory containing the repo subdirectory | |
| 484 </dd> | |
| 485 </dl><dl> | |
| 486 <dt>Returns:</dt> | |
| 487 <dd> | |
| 488 list of dictionaries with submodule name, path, URL and branch | |
| 489 </dd> | |
| 490 </dl><dl> | |
| 491 <dt>Return Type:</dt> | |
| 492 <dd> | |
| 493 list of dict | |
| 494 </dd> | |
| 495 </dl><a NAME="Git.__selectSubmodulePath" ID="Git.__selectSubmodulePath"></a> | |
| 496 <h4>Git.__selectSubmodulePath</h4> | |
| 497 <b>__selectSubmodulePath</b>(<i>repodir</i>) | |
| 498 <p> | |
| 499 Private method to select a submodule path. | |
| 500 </p><dl> | |
| 501 <dt><i>repodir</i> (str)</dt> | |
| 502 <dd> | |
| 503 name of the directory containing the repo subdirectory | |
| 504 </dd> | |
| 505 </dl><dl> | |
| 506 <dt>Returns:</dt> | |
| 507 <dd> | |
| 508 tuple of selected submodule path and flag indicating | |
| 509 a cancellation | |
| 510 </dd> | |
| 511 </dl><dl> | |
| 512 <dt>Return Type:</dt> | |
| 513 <dd> | |
| 514 tuple of (str, bool) | |
| 515 </dd> | |
| 516 </dl><a NAME="Git.__selectSubmodulePaths" ID="Git.__selectSubmodulePaths"></a> | |
| 517 <h4>Git.__selectSubmodulePaths</h4> | |
| 518 <b>__selectSubmodulePaths</b>(<i>repodir</i>) | |
| 519 <p> | |
| 520 Private method to select a list of submodule paths. | |
| 521 </p><dl> | |
| 522 <dt><i>repodir</i> (str)</dt> | |
| 523 <dd> | |
| 524 name of the directory containing the repo subdirectory | |
| 525 </dd> | |
| 526 </dl><dl> | |
| 527 <dt>Returns:</dt> | |
| 528 <dd> | |
| 529 tuple of selected submodule paths and flag indicating | |
| 530 a cancellation | |
| 531 </dd> | |
| 532 </dl><dl> | |
| 533 <dt>Return Type:</dt> | |
| 534 <dd> | |
| 535 tuple of (list of str, bool) | |
| 536 </dd> | |
| 537 </dl><a NAME="Git.__vcsCommit_Step2" ID="Git.__vcsCommit_Step2"></a> | |
| 538 <h4>Git.__vcsCommit_Step2</h4> | |
| 539 <b>__vcsCommit_Step2</b>(<i></i>) | |
| 540 <p> | |
| 541 Private slot performing the second step of the commit action. | |
| 542 </p><a NAME="Git._createStatusMonitorThread" ID="Git._createStatusMonitorThread"></a> | |
| 543 <h4>Git._createStatusMonitorThread</h4> | |
| 544 <b>_createStatusMonitorThread</b>(<i>interval, project</i>) | |
| 545 <p> | |
| 546 Protected method to create an instance of the VCS status monitor | |
| 547 thread. | |
| 548 </p><dl> | |
| 549 <dt><i>interval</i></dt> | |
| 550 <dd> | |
| 551 check interval for the monitor thread in seconds | |
| 552 (integer) | |
| 553 </dd><dt><i>project</i></dt> | |
| 554 <dd> | |
| 555 reference to the project object (Project) | |
| 556 </dd> | |
| 557 </dl><dl> | |
| 558 <dt>Returns:</dt> | |
| 559 <dd> | |
| 560 reference to the monitor thread (QThread) | |
| 561 </dd> | |
| 562 </dl><a NAME="Git.clearStatusCache" ID="Git.clearStatusCache"></a> | |
| 563 <h4>Git.clearStatusCache</h4> | |
| 564 <b>clearStatusCache</b>(<i></i>) | |
| 565 <p> | |
| 566 Public method to clear the status cache. | |
| 567 </p><a NAME="Git.getPlugin" ID="Git.getPlugin"></a> | |
| 568 <h4>Git.getPlugin</h4> | |
| 569 <b>getPlugin</b>(<i></i>) | |
| 570 <p> | |
| 571 Public method to get a reference to the plugin object. | |
| 572 </p><dl> | |
| 573 <dt>Returns:</dt> | |
| 574 <dd> | |
| 575 reference to the plugin object (VcsGitPlugin) | |
| 576 </dd> | |
| 577 </dl><a NAME="Git.gitAddRemote" ID="Git.gitAddRemote"></a> | |
| 578 <h4>Git.gitAddRemote</h4> | |
| 579 <b>gitAddRemote</b>(<i>projectDir</i>) | |
| 580 <p> | |
| 581 Public method to add a remote repository. | |
| 582 </p><dl> | |
| 583 <dt><i>projectDir</i></dt> | |
| 584 <dd> | |
| 585 name of the project directory (string) | |
| 586 </dd> | |
| 587 </dl><a NAME="Git.gitApply" ID="Git.gitApply"></a> | |
| 588 <h4>Git.gitApply</h4> | |
| 589 <b>gitApply</b>(<i>repodir, patchFile, cached=False, reverse=False, noDialog=False</i>) | |
| 590 <p> | |
| 591 Public method to apply a patch stored in a given file. | |
| 592 </p><dl> | |
| 593 <dt><i>repodir</i></dt> | |
| 594 <dd> | |
| 595 directory name of the repository (string) | |
| 596 </dd><dt><i>patchFile</i></dt> | |
| 597 <dd> | |
| 598 name of the patch file (string) | |
| 599 </dd><dt><i>cached</i></dt> | |
| 600 <dd> | |
| 601 flag indicating to apply the patch to the staging area | |
| 602 (boolean) | |
| 603 </dd><dt><i>reverse</i></dt> | |
| 604 <dd> | |
| 605 flag indicating to apply the patch in reverse (boolean) | |
| 606 </dd><dt><i>noDialog</i></dt> | |
| 607 <dd> | |
| 608 flag indicating quiet operations (boolean) | |
| 609 </dd> | |
| 610 </dl><a NAME="Git.gitApplyCheckPatches" ID="Git.gitApplyCheckPatches"></a> | |
| 611 <h4>Git.gitApplyCheckPatches</h4> | |
| 612 <b>gitApplyCheckPatches</b>(<i>projectDir, check=False</i>) | |
| 613 <p> | |
| 614 Public method to apply a list of patch files or check, if they would | |
| 615 apply cleanly. | |
| 616 </p><dl> | |
| 617 <dt><i>projectDir</i></dt> | |
| 618 <dd> | |
| 619 directory name of the project (string) | |
| 620 </dd><dt><i>check</i></dt> | |
| 621 <dd> | |
| 622 flag indicating to perform a check operation (boolean) | |
| 623 </dd> | |
| 624 </dl><a NAME="Git.gitBisect" ID="Git.gitBisect"></a> | |
| 625 <h4>Git.gitBisect</h4> | |
| 626 <b>gitBisect</b>(<i>projectDir, subcommand</i>) | |
| 627 <p> | |
| 628 Public method to perform bisect commands. | |
| 629 </p><dl> | |
| 630 <dt><i>projectDir</i></dt> | |
| 631 <dd> | |
| 632 name of the project directory (string) | |
| 633 </dd><dt><i>subcommand</i></dt> | |
| 634 <dd> | |
| 635 name of the subcommand (string, one of 'start', | |
| 636 'start_extended', 'good', 'bad', 'skip' or 'reset') | |
| 637 </dd> | |
| 638 </dl><dl> | |
| 639 <dt>Returns:</dt> | |
| 640 <dd> | |
| 641 flag indicating, that the update contained an add | |
| 642 or delete (boolean) | |
| 643 </dd> | |
| 644 </dl><dl> | |
| 645 <dt>Raises <b>ValueError</b>:</dt> | |
| 646 <dd> | |
| 647 raised to indicate an invalid bisect subcommand | |
| 648 </dd> | |
| 649 </dl><a NAME="Git.gitBisectCreateReplayFile" ID="Git.gitBisectCreateReplayFile"></a> | |
| 650 <h4>Git.gitBisectCreateReplayFile</h4> | |
| 651 <b>gitBisectCreateReplayFile</b>(<i>projectDir</i>) | |
| 652 <p> | |
| 653 Public method used to create a bisect replay file for the project. | |
| 654 </p><dl> | |
| 655 <dt><i>projectDir</i></dt> | |
| 656 <dd> | |
| 657 name of the project directory (string) | |
| 658 </dd> | |
| 659 </dl><a NAME="Git.gitBisectEditReplayFile" ID="Git.gitBisectEditReplayFile"></a> | |
| 660 <h4>Git.gitBisectEditReplayFile</h4> | |
| 661 <b>gitBisectEditReplayFile</b>(<i>projectDir</i>) | |
| 662 <p> | |
| 663 Public method used to edit a bisect replay file. | |
| 664 </p><dl> | |
| 665 <dt><i>projectDir</i></dt> | |
| 666 <dd> | |
| 667 name of the project directory (string) | |
| 668 </dd> | |
| 669 </dl><a NAME="Git.gitBisectLogBrowser" ID="Git.gitBisectLogBrowser"></a> | |
| 670 <h4>Git.gitBisectLogBrowser</h4> | |
| 671 <b>gitBisectLogBrowser</b>(<i>projectDir</i>) | |
| 672 <p> | |
| 673 Public method used to browse the bisect log of the project. | |
| 674 </p><dl> | |
| 675 <dt><i>projectDir</i></dt> | |
| 676 <dd> | |
| 677 name of the project directory (string) | |
| 678 </dd> | |
| 679 </dl><a NAME="Git.gitBisectReplay" ID="Git.gitBisectReplay"></a> | |
| 680 <h4>Git.gitBisectReplay</h4> | |
| 681 <b>gitBisectReplay</b>(<i>projectDir</i>) | |
| 682 <p> | |
| 683 Public method to replay a bisect session. | |
| 684 </p><dl> | |
| 685 <dt><i>projectDir</i></dt> | |
| 686 <dd> | |
| 687 name of the project directory (string) | |
| 688 </dd> | |
| 689 </dl><dl> | |
| 690 <dt>Returns:</dt> | |
| 691 <dd> | |
| 692 flag indicating, that the update contained an add | |
| 693 or delete (boolean) | |
| 694 </dd> | |
| 695 </dl><a NAME="Git.gitBlame" ID="Git.gitBlame"></a> | |
| 696 <h4>Git.gitBlame</h4> | |
| 697 <b>gitBlame</b>(<i>name</i>) | |
| 698 <p> | |
| 699 Public method to show the output of the git blame command. | |
| 700 </p><dl> | |
| 701 <dt><i>name</i></dt> | |
| 702 <dd> | |
| 703 file name to show the annotations for (string) | |
| 704 </dd> | |
| 705 </dl><a NAME="Git.gitBranch" ID="Git.gitBranch"></a> | |
| 706 <h4>Git.gitBranch</h4> | |
| 707 <b>gitBranch</b>(<i>name, revision=None, branchName=None, branchOp=None</i>) | |
| 708 <p> | |
| 709 Public method used to create, delete or move a branch in the Git | |
| 710 repository. | |
| 711 </p><dl> | |
| 712 <dt><i>name</i></dt> | |
| 713 <dd> | |
| 714 file/directory name to be branched (string) | |
| 715 </dd><dt><i>revision</i></dt> | |
| 716 <dd> | |
| 717 revision to set tag for (string) | |
| 718 </dd><dt><i>branchName</i></dt> | |
| 719 <dd> | |
| 720 name of the branch (string) | |
| 721 </dd><dt><i>branchOp</i></dt> | |
| 722 <dd> | |
| 723 desired branch operation (integer) | |
| 724 </dd> | |
| 725 </dl><dl> | |
| 726 <dt>Returns:</dt> | |
| 727 <dd> | |
| 728 flag indicating a performed branch action (boolean) and | |
| 729 a flag indicating, that the branch operation contained an add | |
| 730 or delete (boolean) | |
| 731 </dd> | |
| 732 </dl><a NAME="Git.gitBundle" ID="Git.gitBundle"></a> | |
| 733 <h4>Git.gitBundle</h4> | |
| 734 <b>gitBundle</b>(<i>projectDir</i>) | |
| 735 <p> | |
| 736 Public method to create a bundle file. | |
| 737 </p><dl> | |
| 738 <dt><i>projectDir</i></dt> | |
| 739 <dd> | |
| 740 name of the project directory (string) | |
| 741 </dd> | |
| 742 </dl><a NAME="Git.gitBundleFetch" ID="Git.gitBundleFetch"></a> | |
| 743 <h4>Git.gitBundleFetch</h4> | |
| 744 <b>gitBundleFetch</b>(<i>projectDir</i>) | |
| 745 <p> | |
| 746 Public method to fetch a head of a bundle file into the local | |
| 747 repository. | |
| 748 </p><dl> | |
| 749 <dt><i>projectDir</i></dt> | |
| 750 <dd> | |
| 751 name of the project directory (string) | |
| 752 </dd> | |
| 753 </dl><a NAME="Git.gitBundleListHeads" ID="Git.gitBundleListHeads"></a> | |
| 754 <h4>Git.gitBundleListHeads</h4> | |
| 755 <b>gitBundleListHeads</b>(<i>projectDir</i>) | |
| 756 <p> | |
| 757 Public method to list the heads contained in a bundle file. | |
| 758 </p><dl> | |
| 759 <dt><i>projectDir</i></dt> | |
| 760 <dd> | |
| 761 name of the project directory (string) | |
| 762 </dd> | |
| 763 </dl><a NAME="Git.gitBundlePull" ID="Git.gitBundlePull"></a> | |
| 764 <h4>Git.gitBundlePull</h4> | |
| 765 <b>gitBundlePull</b>(<i>projectDir</i>) | |
| 766 <p> | |
| 767 Public method to pull a head of a bundle file into the local | |
| 768 repository and working area. | |
| 769 </p><dl> | |
| 770 <dt><i>projectDir</i></dt> | |
| 771 <dd> | |
| 772 name of the project directory (string) | |
| 773 </dd> | |
| 774 </dl><dl> | |
| 775 <dt>Returns:</dt> | |
| 776 <dd> | |
| 777 flag indicating, that the update contained an add | |
| 778 or delete (boolean) | |
| 779 </dd> | |
| 780 </dl><a NAME="Git.gitCancelMerge" ID="Git.gitCancelMerge"></a> | |
| 781 <h4>Git.gitCancelMerge</h4> | |
| 782 <b>gitCancelMerge</b>(<i>name</i>) | |
| 783 <p> | |
| 784 Public method to cancel an uncommitted or failed merge. | |
| 785 </p><dl> | |
| 786 <dt><i>name</i></dt> | |
| 787 <dd> | |
| 788 file/directory name (string) | |
| 789 </dd> | |
| 790 </dl><dl> | |
| 791 <dt>Returns:</dt> | |
| 792 <dd> | |
| 793 flag indicating, that the cancellation contained an add | |
| 794 or delete (boolean) | |
| 795 </dd> | |
| 796 </dl><a NAME="Git.gitCherryPick" ID="Git.gitCherryPick"></a> | |
| 797 <h4>Git.gitCherryPick</h4> | |
| 798 <b>gitCherryPick</b>(<i>projectDir, commits=None</i>) | |
| 799 <p> | |
| 800 Public method to cherry pick commits and apply them to the current | |
| 801 branch. | |
| 802 </p><dl> | |
| 803 <dt><i>projectDir</i></dt> | |
| 804 <dd> | |
| 805 name of the project directory (string) | |
| 806 </dd><dt><i>commits</i></dt> | |
| 807 <dd> | |
| 808 list of commits to be applied (list of strings) | |
| 809 </dd> | |
| 810 </dl><dl> | |
| 811 <dt>Returns:</dt> | |
| 812 <dd> | |
| 813 flag indicating that the project should be reread (boolean) | |
| 814 </dd> | |
| 815 </dl><a NAME="Git.gitCherryPickAbort" ID="Git.gitCherryPickAbort"></a> | |
| 816 <h4>Git.gitCherryPickAbort</h4> | |
| 817 <b>gitCherryPickAbort</b>(<i>projectDir</i>) | |
| 818 <p> | |
| 819 Public method to cancel the last copying session and return to | |
| 820 the previous state. | |
| 821 </p><dl> | |
| 822 <dt><i>projectDir</i></dt> | |
| 823 <dd> | |
| 824 name of the project directory (string) | |
| 825 </dd> | |
| 826 </dl><dl> | |
| 827 <dt>Returns:</dt> | |
| 828 <dd> | |
| 829 flag indicating that the project should be reread (boolean) | |
| 830 </dd> | |
| 831 </dl><a NAME="Git.gitCherryPickContinue" ID="Git.gitCherryPickContinue"></a> | |
| 832 <h4>Git.gitCherryPickContinue</h4> | |
| 833 <b>gitCherryPickContinue</b>(<i>projectDir</i>) | |
| 834 <p> | |
| 835 Public method to continue the last copying session after conflicts | |
| 836 were resolved. | |
| 837 </p><dl> | |
| 838 <dt><i>projectDir</i></dt> | |
| 839 <dd> | |
| 840 name of the project directory (string) | |
| 841 </dd> | |
| 842 </dl><dl> | |
| 843 <dt>Returns:</dt> | |
| 844 <dd> | |
| 845 flag indicating that the project should be reread (boolean) | |
| 846 </dd> | |
| 847 </dl><a NAME="Git.gitCherryPickQuit" ID="Git.gitCherryPickQuit"></a> | |
| 848 <h4>Git.gitCherryPickQuit</h4> | |
| 849 <b>gitCherryPickQuit</b>(<i>projectDir</i>) | |
| 850 <p> | |
| 851 Public method to quit the current copying operation. | |
| 852 </p><dl> | |
| 853 <dt><i>projectDir</i></dt> | |
| 854 <dd> | |
| 855 name of the project directory (string) | |
| 856 </dd> | |
| 857 </dl><dl> | |
| 858 <dt>Returns:</dt> | |
| 859 <dd> | |
| 860 flag indicating that the project should be reread (boolean) | |
| 861 </dd> | |
| 862 </dl><a NAME="Git.gitCommitMerge" ID="Git.gitCommitMerge"></a> | |
| 863 <h4>Git.gitCommitMerge</h4> | |
| 864 <b>gitCommitMerge</b>(<i>name</i>) | |
| 865 <p> | |
| 866 Public method to commit a failed merge. | |
| 867 </p><dl> | |
| 868 <dt><i>name</i></dt> | |
| 869 <dd> | |
| 870 file/directory name (string) | |
| 871 </dd> | |
| 872 </dl><a NAME="Git.gitCopy" ID="Git.gitCopy"></a> | |
| 873 <h4>Git.gitCopy</h4> | |
| 874 <b>gitCopy</b>(<i>name, project</i>) | |
| 875 <p> | |
| 876 Public method used to copy a file/directory. | |
| 877 </p><dl> | |
| 878 <dt><i>name</i></dt> | |
| 879 <dd> | |
| 880 file/directory name to be copied (string) | |
| 881 </dd><dt><i>project</i></dt> | |
| 882 <dd> | |
| 883 reference to the project object | |
| 884 </dd> | |
| 885 </dl><dl> | |
| 886 <dt>Returns:</dt> | |
| 887 <dd> | |
| 888 flag indicating successful operation (boolean) | |
| 889 </dd> | |
| 890 </dl><a NAME="Git.gitCreateArchive" ID="Git.gitCreateArchive"></a> | |
| 891 <h4>Git.gitCreateArchive</h4> | |
| 892 <b>gitCreateArchive</b>(<i>projectDir</i>) | |
| 893 <p> | |
| 894 Public method to show some statistics of the local repository. | |
| 895 </p><dl> | |
| 896 <dt><i>projectDir</i></dt> | |
| 897 <dd> | |
| 898 name of the project directory (string) | |
| 899 </dd> | |
| 900 </dl><a NAME="Git.gitCreateIgnoreFile" ID="Git.gitCreateIgnoreFile"></a> | |
| 901 <h4>Git.gitCreateIgnoreFile</h4> | |
| 902 <b>gitCreateIgnoreFile</b>(<i>name, autoAdd=False</i>) | |
| 903 <p> | |
| 904 Public method to create the ignore file. | |
| 905 </p><dl> | |
| 906 <dt><i>name</i></dt> | |
| 907 <dd> | |
| 908 directory name to create the ignore file in (string) | |
| 909 </dd><dt><i>autoAdd</i></dt> | |
| 910 <dd> | |
| 911 flag indicating to add it automatically (boolean) | |
| 912 </dd> | |
| 913 </dl><dl> | |
| 914 <dt>Returns:</dt> | |
| 915 <dd> | |
| 916 flag indicating success | |
| 917 </dd> | |
| 918 </dl><a NAME="Git.gitDeleteRemoteBranch" ID="Git.gitDeleteRemoteBranch"></a> | |
| 919 <h4>Git.gitDeleteRemoteBranch</h4> | |
| 920 <b>gitDeleteRemoteBranch</b>(<i>name</i>) | |
| 921 <p> | |
| 922 Public method to delete a branch from a remote repository. | |
| 923 </p><dl> | |
| 924 <dt><i>name</i></dt> | |
| 925 <dd> | |
| 926 file/directory name (string) | |
| 927 </dd> | |
| 928 </dl><a NAME="Git.gitDescribe" ID="Git.gitDescribe"></a> | |
| 929 <h4>Git.gitDescribe</h4> | |
| 930 <b>gitDescribe</b>(<i>projectDir, commits</i>) | |
| 931 <p> | |
| 932 Public method to find the most recent tag reachable from each commit. | |
| 933 </p><dl> | |
| 934 <dt><i>projectDir</i></dt> | |
| 935 <dd> | |
| 936 name of the project directory (string) | |
| 937 </dd><dt><i>commits</i></dt> | |
| 938 <dd> | |
| 939 list of commits to start the search from | |
| 940 (list of strings) | |
| 941 </dd> | |
| 942 </dl><a NAME="Git.gitEditConfig" ID="Git.gitEditConfig"></a> | |
| 943 <h4>Git.gitEditConfig</h4> | |
| 944 <b>gitEditConfig</b>(<i>projectDir</i>) | |
| 945 <p> | |
| 946 Public method used to edit the repository configuration file. | |
| 947 </p><dl> | |
| 948 <dt><i>projectDir</i></dt> | |
| 949 <dd> | |
| 950 name of the project directory (string) | |
| 951 </dd> | |
| 952 </dl><a NAME="Git.gitEditUserConfig" ID="Git.gitEditUserConfig"></a> | |
| 953 <h4>Git.gitEditUserConfig</h4> | |
| 954 <b>gitEditUserConfig</b>(<i></i>) | |
| 955 <p> | |
| 956 Public method used to edit the user configuration file. | |
| 957 </p><a NAME="Git.gitExtendedDiff" ID="Git.gitExtendedDiff"></a> | |
| 958 <h4>Git.gitExtendedDiff</h4> | |
| 959 <b>gitExtendedDiff</b>(<i>name</i>) | |
| 960 <p> | |
| 961 Public method used to view the difference of a file/directory to the | |
| 962 Git repository. | |
| 963 </p><p> | |
| 964 If name is a directory and is the project directory, all project files | |
| 965 are saved first. If name is a file (or list of files), which is/are | |
| 966 being edited and has unsaved modification, they can be saved or the | |
| 967 operation may be aborted. | |
| 968 </p><p> | |
| 969 This method gives the chance to enter the revisions to be compared. | |
| 970 </p><dl> | |
| 971 <dt><i>name</i></dt> | |
| 972 <dd> | |
| 973 file/directory name to be diffed (string) | |
| 974 </dd> | |
| 975 </dl><a NAME="Git.gitFetch" ID="Git.gitFetch"></a> | |
| 976 <h4>Git.gitFetch</h4> | |
| 977 <b>gitFetch</b>(<i>name</i>) | |
| 978 <p> | |
| 979 Public method to fetch changes from a remote repository. | |
| 980 </p><dl> | |
| 981 <dt><i>name</i></dt> | |
| 982 <dd> | |
| 983 directory name (string) | |
| 984 </dd> | |
| 985 </dl><a NAME="Git.gitGetArchiveFormats" ID="Git.gitGetArchiveFormats"></a> | |
| 986 <h4>Git.gitGetArchiveFormats</h4> | |
| 987 <b>gitGetArchiveFormats</b>(<i>repodir</i>) | |
| 988 <p> | |
| 989 Public method to get a list of supported archive formats. | |
| 990 </p><dl> | |
| 991 <dt><i>repodir</i></dt> | |
| 992 <dd> | |
| 993 directory name of the repository (string) | |
| 994 </dd> | |
| 995 </dl><dl> | |
| 996 <dt>Returns:</dt> | |
| 997 <dd> | |
| 998 list of supported archive formats (list of strings) | |
| 999 </dd> | |
| 1000 </dl><a NAME="Git.gitGetBranchesList" ID="Git.gitGetBranchesList"></a> | |
| 1001 <h4>Git.gitGetBranchesList</h4> | |
| 1002 <b>gitGetBranchesList</b>(<i>repodir, withMaster=False, allBranches=False, remotes=False</i>) | |
| 1003 <p> | |
| 1004 Public method to get the list of branches. | |
| 1005 </p><dl> | |
| 1006 <dt><i>repodir</i></dt> | |
| 1007 <dd> | |
| 1008 directory name of the repository (string) | |
| 1009 </dd><dt><i>withMaster</i></dt> | |
| 1010 <dd> | |
| 1011 flag indicating to get 'master' as well (boolean) | |
| 1012 </dd><dt><i>allBranches</i></dt> | |
| 1013 <dd> | |
| 1014 flag indicating to return all branches (boolean) | |
| 1015 </dd><dt><i>remotes</i></dt> | |
| 1016 <dd> | |
| 1017 flag indicating to return remote branches only (boolean) | |
| 1018 </dd> | |
| 1019 </dl><dl> | |
| 1020 <dt>Returns:</dt> | |
| 1021 <dd> | |
| 1022 list of branches (list of string) | |
| 1023 </dd> | |
| 1024 </dl><a NAME="Git.gitGetBundleHeads" ID="Git.gitGetBundleHeads"></a> | |
| 1025 <h4>Git.gitGetBundleHeads</h4> | |
| 1026 <b>gitGetBundleHeads</b>(<i>repodir, bundleFile</i>) | |
| 1027 <p> | |
| 1028 Public method to get a list of heads contained in a bundle file. | |
| 1029 </p><dl> | |
| 1030 <dt><i>repodir</i></dt> | |
| 1031 <dd> | |
| 1032 directory name of the repository (string) | |
| 1033 </dd><dt><i>bundleFile</i></dt> | |
| 1034 <dd> | |
| 1035 file name of a git bundle file (string) | |
| 1036 </dd> | |
| 1037 </dl><dl> | |
| 1038 <dt>Returns:</dt> | |
| 1039 <dd> | |
| 1040 list of heads (list of strings) | |
| 1041 </dd> | |
| 1042 </dl><a NAME="Git.gitGetCurrentBranch" ID="Git.gitGetCurrentBranch"></a> | |
| 1043 <h4>Git.gitGetCurrentBranch</h4> | |
| 1044 <b>gitGetCurrentBranch</b>(<i>repodir</i>) | |
| 1045 <p> | |
| 1046 Public method used to show the current branch of the working directory. | |
| 1047 </p><dl> | |
| 1048 <dt><i>repodir</i></dt> | |
| 1049 <dd> | |
| 1050 directory name of the repository (string) | |
| 1051 </dd> | |
| 1052 </dl><dl> | |
| 1053 <dt>Returns:</dt> | |
| 1054 <dd> | |
| 1055 name of the current branch (string) | |
| 1056 </dd> | |
| 1057 </dl><a NAME="Git.gitGetRemoteBranchesList" ID="Git.gitGetRemoteBranchesList"></a> | |
| 1058 <h4>Git.gitGetRemoteBranchesList</h4> | |
| 1059 <b>gitGetRemoteBranchesList</b>(<i>repodir, remote</i>) | |
| 1060 <p> | |
| 1061 Public method to get the list of a remote repository branches. | |
| 1062 </p><dl> | |
| 1063 <dt><i>repodir</i></dt> | |
| 1064 <dd> | |
| 1065 directory name of the repository (string) | |
| 1066 </dd><dt><i>remote</i></dt> | |
| 1067 <dd> | |
| 1068 remote repository name (string) | |
| 1069 </dd> | |
| 1070 </dl><dl> | |
| 1071 <dt>Returns:</dt> | |
| 1072 <dd> | |
| 1073 list of remote repository branches (list of string) | |
| 1074 </dd> | |
| 1075 </dl><a NAME="Git.gitGetRemoteUrlsList" ID="Git.gitGetRemoteUrlsList"></a> | |
| 1076 <h4>Git.gitGetRemoteUrlsList</h4> | |
| 1077 <b>gitGetRemoteUrlsList</b>(<i>repodir, forFetch=True</i>) | |
| 1078 <p> | |
| 1079 Public method to get the list of remote repos and their URLs. | |
| 1080 </p><dl> | |
| 1081 <dt><i>repodir</i></dt> | |
| 1082 <dd> | |
| 1083 directory name of the repository (string) | |
| 1084 </dd><dt><i>forFetch</i></dt> | |
| 1085 <dd> | |
| 1086 flag indicating to get Fetch info (string) | |
| 1087 </dd> | |
| 1088 </dl><dl> | |
| 1089 <dt>Returns:</dt> | |
| 1090 <dd> | |
| 1091 list of tuples of remote repo name and repo URL (list of | |
| 1092 tuple of two strings) | |
| 1093 </dd> | |
| 1094 </dl><a NAME="Git.gitGetRemotesList" ID="Git.gitGetRemotesList"></a> | |
| 1095 <h4>Git.gitGetRemotesList</h4> | |
| 1096 <b>gitGetRemotesList</b>(<i>repodir</i>) | |
| 1097 <p> | |
| 1098 Public method to get the list of remote repos. | |
| 1099 </p><dl> | |
| 1100 <dt><i>repodir</i></dt> | |
| 1101 <dd> | |
| 1102 directory name of the repository (string) | |
| 1103 </dd> | |
| 1104 </dl><dl> | |
| 1105 <dt>Returns:</dt> | |
| 1106 <dd> | |
| 1107 list of remote repos (list of string) | |
| 1108 </dd> | |
| 1109 </dl><a NAME="Git.gitGetTagsList" ID="Git.gitGetTagsList"></a> | |
| 1110 <h4>Git.gitGetTagsList</h4> | |
| 1111 <b>gitGetTagsList</b>(<i>repodir, withType=False</i>) | |
| 1112 <p> | |
| 1113 Public method to get the list of tags. | |
| 1114 </p><dl> | |
| 1115 <dt><i>repodir</i></dt> | |
| 1116 <dd> | |
| 1117 directory name of the repository (string) | |
| 1118 </dd><dt><i>withType</i></dt> | |
| 1119 <dd> | |
| 1120 flag indicating to get the tag type as well (boolean) | |
| 1121 </dd> | |
| 1122 </dl><dl> | |
| 1123 <dt>Returns:</dt> | |
| 1124 <dd> | |
| 1125 list of tags (list of string) or list of tuples of | |
| 1126 tag name and flag indicating a local tag (list of tuple of string | |
| 1127 and boolean), if withType is True | |
| 1128 </dd> | |
| 1129 </dl><a NAME="Git.gitHouseKeeping" ID="Git.gitHouseKeeping"></a> | |
| 1130 <h4>Git.gitHouseKeeping</h4> | |
| 1131 <b>gitHouseKeeping</b>(<i>projectDir</i>) | |
| 1132 <p> | |
| 1133 Public method to cleanup and optimize the local repository. | |
| 1134 </p><dl> | |
| 1135 <dt><i>projectDir</i></dt> | |
| 1136 <dd> | |
| 1137 name of the project directory (string) | |
| 1138 </dd> | |
| 1139 </dl><a NAME="Git.gitListTagBranch" ID="Git.gitListTagBranch"></a> | |
| 1140 <h4>Git.gitListTagBranch</h4> | |
| 1141 <b>gitListTagBranch</b>(<i>path, tags=True, listAll=True, merged=True</i>) | |
| 1142 <p> | |
| 1143 Public method used to list the available tags or branches. | |
| 1144 </p><dl> | |
| 1145 <dt><i>path</i></dt> | |
| 1146 <dd> | |
| 1147 directory name of the project (string) | |
| 1148 </dd><dt><i>tags</i></dt> | |
| 1149 <dd> | |
| 1150 flag indicating listing of branches or tags | |
| 1151 (False = branches, True = tags) | |
| 1152 </dd><dt><i>listAll</i></dt> | |
| 1153 <dd> | |
| 1154 flag indicating to show all tags or branches (boolean) | |
| 1155 </dd><dt><i>merged</i></dt> | |
| 1156 <dd> | |
| 1157 flag indicating to show only merged or non-merged | |
| 1158 branches (boolean) | |
| 1159 </dd> | |
| 1160 </dl><a NAME="Git.gitNormalizeURL" ID="Git.gitNormalizeURL"></a> | |
| 1161 <h4>Git.gitNormalizeURL</h4> | |
| 1162 <b>gitNormalizeURL</b>(<i>url</i>) | |
| 1163 <p> | |
| 1164 Public method to normalize a url for Git. | |
| 1165 </p><dl> | |
| 1166 <dt><i>url</i></dt> | |
| 1167 <dd> | |
| 1168 url string (string) | |
| 1169 </dd> | |
| 1170 </dl><dl> | |
| 1171 <dt>Returns:</dt> | |
| 1172 <dd> | |
| 1173 properly normalized url for git (string) | |
| 1174 </dd> | |
| 1175 </dl><a NAME="Git.gitPruneRemote" ID="Git.gitPruneRemote"></a> | |
| 1176 <h4>Git.gitPruneRemote</h4> | |
| 1177 <b>gitPruneRemote</b>(<i>projectDir, remoteName</i>) | |
| 1178 <p> | |
| 1179 Public method to prune stale remote-tracking branches. | |
| 1180 </p><dl> | |
| 1181 <dt><i>projectDir</i></dt> | |
| 1182 <dd> | |
| 1183 name of the project directory (string) | |
| 1184 </dd><dt><i>remoteName</i></dt> | |
| 1185 <dd> | |
| 1186 name of the remote repository (string) | |
| 1187 </dd> | |
| 1188 </dl><a NAME="Git.gitPull" ID="Git.gitPull"></a> | |
| 1189 <h4>Git.gitPull</h4> | |
| 1190 <b>gitPull</b>(<i>name</i>) | |
| 1191 <p> | |
| 1192 Public method used to pull changes from a remote Git repository. | |
| 1193 </p><dl> | |
| 1194 <dt><i>name</i></dt> | |
| 1195 <dd> | |
| 1196 directory name of the project to be pulled to (string) | |
| 1197 </dd> | |
| 1198 </dl><dl> | |
| 1199 <dt>Returns:</dt> | |
| 1200 <dd> | |
| 1201 flag indicating, that the update contained an add | |
| 1202 or delete (boolean) | |
| 1203 </dd> | |
| 1204 </dl><a NAME="Git.gitPush" ID="Git.gitPush"></a> | |
| 1205 <h4>Git.gitPush</h4> | |
| 1206 <b>gitPush</b>(<i>name</i>) | |
| 1207 <p> | |
| 1208 Public method used to push changes to a remote Git repository. | |
| 1209 </p><dl> | |
| 1210 <dt><i>name</i></dt> | |
| 1211 <dd> | |
| 1212 directory name of the project to be pushed from (string) | |
| 1213 </dd> | |
| 1214 </dl><a NAME="Git.gitReflogBrowser" ID="Git.gitReflogBrowser"></a> | |
| 1215 <h4>Git.gitReflogBrowser</h4> | |
| 1216 <b>gitReflogBrowser</b>(<i>projectDir</i>) | |
| 1217 <p> | |
| 1218 Public method used to browse the reflog of the project. | |
| 1219 </p><dl> | |
| 1220 <dt><i>projectDir</i></dt> | |
| 1221 <dd> | |
| 1222 name of the project directory (string) | |
| 1223 </dd> | |
| 1224 </dl><a NAME="Git.gitRemoveRemote" ID="Git.gitRemoveRemote"></a> | |
| 1225 <h4>Git.gitRemoveRemote</h4> | |
| 1226 <b>gitRemoveRemote</b>(<i>projectDir, remoteName</i>) | |
| 1227 <p> | |
| 1228 Public method to remove a remote repository. | |
| 1229 </p><dl> | |
| 1230 <dt><i>projectDir</i></dt> | |
| 1231 <dd> | |
| 1232 name of the project directory (string) | |
| 1233 </dd><dt><i>remoteName</i></dt> | |
| 1234 <dd> | |
| 1235 name of the remote repository (string) | |
| 1236 </dd> | |
| 1237 </dl><a NAME="Git.gitRenameRemote" ID="Git.gitRenameRemote"></a> | |
| 1238 <h4>Git.gitRenameRemote</h4> | |
| 1239 <b>gitRenameRemote</b>(<i>projectDir, remoteName</i>) | |
| 1240 <p> | |
| 1241 Public method to rename a remote repository. | |
| 1242 </p><dl> | |
| 1243 <dt><i>projectDir</i></dt> | |
| 1244 <dd> | |
| 1245 name of the project directory (string) | |
| 1246 </dd><dt><i>remoteName</i></dt> | |
| 1247 <dd> | |
| 1248 name of the remote repository (string) | |
| 1249 </dd> | |
| 1250 </dl><a NAME="Git.gitRevert" ID="Git.gitRevert"></a> | |
| 1251 <h4>Git.gitRevert</h4> | |
| 1252 <b>gitRevert</b>(<i>name</i>) | |
| 1253 <p> | |
| 1254 Public method used to revert changes made to a file/directory. | |
| 1255 </p><dl> | |
| 1256 <dt><i>name</i></dt> | |
| 1257 <dd> | |
| 1258 file/directory name to be reverted (string) | |
| 1259 </dd> | |
| 1260 </dl><dl> | |
| 1261 <dt>Returns:</dt> | |
| 1262 <dd> | |
| 1263 flag indicating, that the update contained an add | |
| 1264 or delete (boolean) | |
| 1265 </dd> | |
| 1266 </dl><a NAME="Git.gitSbsDiff" ID="Git.gitSbsDiff"></a> | |
| 1267 <h4>Git.gitSbsDiff</h4> | |
| 1268 <b>gitSbsDiff</b>(<i>name, extended=False, revisions=None</i>) | |
| 1269 <p> | |
| 1270 Public method used to view the difference of a file to the Git | |
| 1271 repository side-by-side. | |
| 1272 </p><dl> | |
| 1273 <dt><i>name</i></dt> | |
| 1274 <dd> | |
| 1275 file name to be diffed (string) | |
| 1276 </dd><dt><i>extended=</i></dt> | |
| 1277 <dd> | |
| 1278 flag indicating the extended variant (boolean) | |
| 1279 </dd><dt><i>revisions=</i></dt> | |
| 1280 <dd> | |
| 1281 tuple of two revisions (tuple of strings) | |
| 1282 </dd> | |
| 1283 </dl><dl> | |
| 1284 <dt>Raises <b>ValueError</b>:</dt> | |
| 1285 <dd> | |
| 1286 raised to indicate an invalid name parameter | |
| 1287 </dd> | |
| 1288 </dl><a NAME="Git.gitShortlog" ID="Git.gitShortlog"></a> | |
| 1289 <h4>Git.gitShortlog</h4> | |
| 1290 <b>gitShortlog</b>(<i>projectDir, commit</i>) | |
| 1291 <p> | |
| 1292 Public method to show a short log suitable for inclusion in release | |
| 1293 announcements. | |
| 1294 </p><dl> | |
| 1295 <dt><i>projectDir</i></dt> | |
| 1296 <dd> | |
| 1297 name of the project directory (string) | |
| 1298 </dd><dt><i>commit</i></dt> | |
| 1299 <dd> | |
| 1300 commit to start the log at (strings) | |
| 1301 </dd> | |
| 1302 </dl><a NAME="Git.gitShowBranch" ID="Git.gitShowBranch"></a> | |
| 1303 <h4>Git.gitShowBranch</h4> | |
| 1304 <b>gitShowBranch</b>(<i>name</i>) | |
| 1305 <p> | |
| 1306 Public method used to show the current branch of the working directory. | |
| 1307 </p><dl> | |
| 1308 <dt><i>name</i></dt> | |
| 1309 <dd> | |
| 1310 file/directory name (string) | |
| 1311 </dd> | |
| 1312 </dl><a NAME="Git.gitShowConfig" ID="Git.gitShowConfig"></a> | |
| 1313 <h4>Git.gitShowConfig</h4> | |
| 1314 <b>gitShowConfig</b>(<i>projectDir</i>) | |
| 1315 <p> | |
| 1316 Public method to show the combined configuration. | |
| 1317 </p><dl> | |
| 1318 <dt><i>projectDir</i></dt> | |
| 1319 <dd> | |
| 1320 name of the project directory (string) | |
| 1321 </dd> | |
| 1322 </dl><a NAME="Git.gitShowPatchesStatistics" ID="Git.gitShowPatchesStatistics"></a> | |
| 1323 <h4>Git.gitShowPatchesStatistics</h4> | |
| 1324 <b>gitShowPatchesStatistics</b>(<i>projectDir</i>) | |
| 1325 <p> | |
| 1326 Public method to show statistics for a set of patch files. | |
| 1327 </p><dl> | |
| 1328 <dt><i>projectDir</i></dt> | |
| 1329 <dd> | |
| 1330 directory name of the project (string) | |
| 1331 </dd> | |
| 1332 </dl><a NAME="Git.gitShowRemote" ID="Git.gitShowRemote"></a> | |
| 1333 <h4>Git.gitShowRemote</h4> | |
| 1334 <b>gitShowRemote</b>(<i>projectDir, remoteName</i>) | |
| 1335 <p> | |
| 1336 Public method to show information about a remote repository. | |
| 1337 </p><dl> | |
| 1338 <dt><i>projectDir</i></dt> | |
| 1339 <dd> | |
| 1340 name of the project directory (string) | |
| 1341 </dd><dt><i>remoteName</i></dt> | |
| 1342 <dd> | |
| 1343 name of the remote repository (string) | |
| 1344 </dd> | |
| 1345 </dl><a NAME="Git.gitShowRemotes" ID="Git.gitShowRemotes"></a> | |
| 1346 <h4>Git.gitShowRemotes</h4> | |
| 1347 <b>gitShowRemotes</b>(<i>projectDir</i>) | |
| 1348 <p> | |
| 1349 Public method to show available remote repositories. | |
| 1350 </p><dl> | |
| 1351 <dt><i>projectDir</i></dt> | |
| 1352 <dd> | |
| 1353 name of the project directory (string) | |
| 1354 </dd> | |
| 1355 </dl><a NAME="Git.gitStashApply" ID="Git.gitStashApply"></a> | |
| 1356 <h4>Git.gitStashApply</h4> | |
| 1357 <b>gitStashApply</b>(<i>projectDir, stashName=""</i>) | |
| 1358 <p> | |
| 1359 Public method to apply a stash but keep it. | |
| 1360 </p><dl> | |
| 1361 <dt><i>projectDir</i></dt> | |
| 1362 <dd> | |
| 1363 name of the project directory (string) | |
| 1364 </dd><dt><i>stashName</i></dt> | |
| 1365 <dd> | |
| 1366 name of a stash (string) | |
| 1367 </dd> | |
| 1368 </dl><dl> | |
| 1369 <dt>Returns:</dt> | |
| 1370 <dd> | |
| 1371 flag indicating, that the restore contained an add | |
| 1372 or delete (boolean) | |
| 1373 </dd> | |
| 1374 </dl><a NAME="Git.gitStashBranch" ID="Git.gitStashBranch"></a> | |
| 1375 <h4>Git.gitStashBranch</h4> | |
| 1376 <b>gitStashBranch</b>(<i>projectDir, stashName=""</i>) | |
| 1377 <p> | |
| 1378 Public method to create a branch from a stash. | |
| 1379 </p><dl> | |
| 1380 <dt><i>projectDir</i></dt> | |
| 1381 <dd> | |
| 1382 name of the project directory (string) | |
| 1383 </dd><dt><i>stashName</i></dt> | |
| 1384 <dd> | |
| 1385 name of a stash (string) | |
| 1386 </dd> | |
| 1387 </dl><dl> | |
| 1388 <dt>Returns:</dt> | |
| 1389 <dd> | |
| 1390 flag indicating, that the restore contained an add | |
| 1391 or delete (boolean) | |
| 1392 </dd> | |
| 1393 </dl><a NAME="Git.gitStashBrowser" ID="Git.gitStashBrowser"></a> | |
| 1394 <h4>Git.gitStashBrowser</h4> | |
| 1395 <b>gitStashBrowser</b>(<i>projectDir</i>) | |
| 1396 <p> | |
| 1397 Public method used to browse the stashed changes. | |
| 1398 </p><dl> | |
| 1399 <dt><i>projectDir</i></dt> | |
| 1400 <dd> | |
| 1401 name of the project directory (string) | |
| 1402 </dd> | |
| 1403 </dl><a NAME="Git.gitStashClear" ID="Git.gitStashClear"></a> | |
| 1404 <h4>Git.gitStashClear</h4> | |
| 1405 <b>gitStashClear</b>(<i>projectDir</i>) | |
| 1406 <p> | |
| 1407 Public method to delete all stashes. | |
| 1408 </p><dl> | |
| 1409 <dt><i>projectDir</i></dt> | |
| 1410 <dd> | |
| 1411 name of the project directory (string) | |
| 1412 </dd> | |
| 1413 </dl><dl> | |
| 1414 <dt>Returns:</dt> | |
| 1415 <dd> | |
| 1416 flag indicating a successful deletion (boolean) | |
| 1417 </dd> | |
| 1418 </dl><a NAME="Git.gitStashDrop" ID="Git.gitStashDrop"></a> | |
| 1419 <h4>Git.gitStashDrop</h4> | |
| 1420 <b>gitStashDrop</b>(<i>projectDir, stashName=""</i>) | |
| 1421 <p> | |
| 1422 Public method to delete a stash. | |
| 1423 </p><dl> | |
| 1424 <dt><i>projectDir</i></dt> | |
| 1425 <dd> | |
| 1426 name of the project directory (string) | |
| 1427 </dd><dt><i>stashName</i></dt> | |
| 1428 <dd> | |
| 1429 name of a stash (string) | |
| 1430 </dd> | |
| 1431 </dl><dl> | |
| 1432 <dt>Returns:</dt> | |
| 1433 <dd> | |
| 1434 flag indicating a successful deletion (boolean) | |
| 1435 </dd> | |
| 1436 </dl><a NAME="Git.gitStashPop" ID="Git.gitStashPop"></a> | |
| 1437 <h4>Git.gitStashPop</h4> | |
| 1438 <b>gitStashPop</b>(<i>projectDir, stashName=""</i>) | |
| 1439 <p> | |
| 1440 Public method to apply a stash and delete it. | |
| 1441 </p><dl> | |
| 1442 <dt><i>projectDir</i></dt> | |
| 1443 <dd> | |
| 1444 name of the project directory (string) | |
| 1445 </dd><dt><i>stashName</i></dt> | |
| 1446 <dd> | |
| 1447 name of a stash (string) | |
| 1448 </dd> | |
| 1449 </dl><dl> | |
| 1450 <dt>Returns:</dt> | |
| 1451 <dd> | |
| 1452 flag indicating, that the restore contained an add | |
| 1453 or delete (boolean) | |
| 1454 </dd> | |
| 1455 </dl><a NAME="Git.gitStashSave" ID="Git.gitStashSave"></a> | |
| 1456 <h4>Git.gitStashSave</h4> | |
| 1457 <b>gitStashSave</b>(<i>projectDir</i>) | |
| 1458 <p> | |
| 1459 Public method to save the current changes to a new stash. | |
| 1460 </p><dl> | |
| 1461 <dt><i>projectDir</i></dt> | |
| 1462 <dd> | |
| 1463 name of the project directory (string) | |
| 1464 </dd> | |
| 1465 </dl><dl> | |
| 1466 <dt>Returns:</dt> | |
| 1467 <dd> | |
| 1468 flag indicating, that the save contained an add | |
| 1469 or delete (boolean) | |
| 1470 </dd> | |
| 1471 </dl><a NAME="Git.gitStashShowPatch" ID="Git.gitStashShowPatch"></a> | |
| 1472 <h4>Git.gitStashShowPatch</h4> | |
| 1473 <b>gitStashShowPatch</b>(<i>projectDir, stashName=""</i>) | |
| 1474 <p> | |
| 1475 Public method to show the contents of a stash. | |
| 1476 </p><dl> | |
| 1477 <dt><i>projectDir</i></dt> | |
| 1478 <dd> | |
| 1479 name of the project directory (string) | |
| 1480 </dd><dt><i>stashName</i></dt> | |
| 1481 <dd> | |
| 1482 name of a stash (string) | |
| 1483 </dd> | |
| 1484 </dl><a NAME="Git.gitStatistics" ID="Git.gitStatistics"></a> | |
| 1485 <h4>Git.gitStatistics</h4> | |
| 1486 <b>gitStatistics</b>(<i>projectDir</i>) | |
| 1487 <p> | |
| 1488 Public method to show some statistics of the local repository. | |
| 1489 </p><dl> | |
| 1490 <dt><i>projectDir</i></dt> | |
| 1491 <dd> | |
| 1492 name of the project directory (string) | |
| 1493 </dd> | |
| 1494 </dl><a NAME="Git.gitSubmoduleAdd" ID="Git.gitSubmoduleAdd"></a> | |
| 1495 <h4>Git.gitSubmoduleAdd</h4> | |
| 1496 <b>gitSubmoduleAdd</b>(<i>projectDir</i>) | |
| 1497 <p> | |
| 1498 Public method to add a submodule to the project. | |
| 1499 </p><dl> | |
| 1500 <dt><i>projectDir</i> (str)</dt> | |
| 1501 <dd> | |
| 1502 name of the project directory | |
| 1503 </dd> | |
| 1504 </dl><a NAME="Git.gitSubmoduleDeinit" ID="Git.gitSubmoduleDeinit"></a> | |
| 1505 <h4>Git.gitSubmoduleDeinit</h4> | |
| 1506 <b>gitSubmoduleDeinit</b>(<i>projectDir</i>) | |
| 1507 <p> | |
| 1508 Public method to unregister submodules. | |
| 1509 </p><dl> | |
| 1510 <dt><i>projectDir</i> (str)</dt> | |
| 1511 <dd> | |
| 1512 name of the project directory | |
| 1513 </dd> | |
| 1514 </dl><a NAME="Git.gitSubmoduleInit" ID="Git.gitSubmoduleInit"></a> | |
| 1515 <h4>Git.gitSubmoduleInit</h4> | |
| 1516 <b>gitSubmoduleInit</b>(<i>projectDir</i>) | |
| 1517 <p> | |
| 1518 Public method to initialize one or all submodules. | |
| 1519 </p><dl> | |
| 1520 <dt><i>projectDir</i> (str)</dt> | |
| 1521 <dd> | |
| 1522 name of the project directory | |
| 1523 </dd> | |
| 1524 </dl><a NAME="Git.gitSubmoduleList" ID="Git.gitSubmoduleList"></a> | |
| 1525 <h4>Git.gitSubmoduleList</h4> | |
| 1526 <b>gitSubmoduleList</b>(<i>projectDir</i>) | |
| 1527 <p> | |
| 1528 Public method to show a list of all submodules of the project. | |
| 1529 </p><dl> | |
| 1530 <dt><i>projectDir</i> (str)</dt> | |
| 1531 <dd> | |
| 1532 name of the project directory | |
| 1533 </dd> | |
| 1534 </dl><a NAME="Git.gitSubmoduleStatus" ID="Git.gitSubmoduleStatus"></a> | |
| 1535 <h4>Git.gitSubmoduleStatus</h4> | |
| 1536 <b>gitSubmoduleStatus</b>(<i>projectDir</i>) | |
| 1537 <p> | |
| 1538 Public method to show the status of the submodules. | |
| 1539 </p><dl> | |
| 1540 <dt><i>projectDir</i> (str)</dt> | |
| 1541 <dd> | |
| 1542 name of the project directory | |
| 1543 </dd> | |
| 1544 </dl><a NAME="Git.gitSubmoduleSummary" ID="Git.gitSubmoduleSummary"></a> | |
| 1545 <h4>Git.gitSubmoduleSummary</h4> | |
| 1546 <b>gitSubmoduleSummary</b>(<i>projectDir</i>) | |
| 1547 <p> | |
| 1548 Public method to show the status of the submodules. | |
| 1549 </p><dl> | |
| 1550 <dt><i>projectDir</i> (str)</dt> | |
| 1551 <dd> | |
| 1552 name of the project directory | |
| 1553 </dd> | |
| 1554 </dl><a NAME="Git.gitSubmoduleSync" ID="Git.gitSubmoduleSync"></a> | |
| 1555 <h4>Git.gitSubmoduleSync</h4> | |
| 1556 <b>gitSubmoduleSync</b>(<i>projectDir</i>) | |
| 1557 <p> | |
| 1558 Public method to synchronize submodules. | |
| 1559 </p><dl> | |
| 1560 <dt><i>projectDir</i> (str)</dt> | |
| 1561 <dd> | |
| 1562 name of the project directory | |
| 1563 </dd> | |
| 1564 </dl><a NAME="Git.gitSubmoduleUpdate" ID="Git.gitSubmoduleUpdate"></a> | |
| 1565 <h4>Git.gitSubmoduleUpdate</h4> | |
| 1566 <b>gitSubmoduleUpdate</b>(<i>projectDir, initialize=False, remote=False</i>) | |
| 1567 <p> | |
| 1568 Public method to update submodules. | |
| 1569 </p><dl> | |
| 1570 <dt><i>projectDir</i> (str)</dt> | |
| 1571 <dd> | |
| 1572 name of the project directory | |
| 1573 </dd><dt><i>initialize</i> (bool)</dt> | |
| 1574 <dd> | |
| 1575 flag indicating an initialize and update operation | |
| 1576 </dd><dt><i>remote</i> (bool)</dt> | |
| 1577 <dd> | |
| 1578 flag indicating a fetch and update operation | |
| 1579 </dd> | |
| 1580 </dl><a NAME="Git.gitSubmoduleUpdateWithOptions" ID="Git.gitSubmoduleUpdateWithOptions"></a> | |
| 1581 <h4>Git.gitSubmoduleUpdateWithOptions</h4> | |
| 1582 <b>gitSubmoduleUpdateWithOptions</b>(<i>projectDir</i>) | |
| 1583 <p> | |
| 1584 Public method to update submodules offering a dialog to select the | |
| 1585 update options. | |
| 1586 </p><dl> | |
| 1587 <dt><i>projectDir</i> (str)</dt> | |
| 1588 <dd> | |
| 1589 name of the project directory | |
| 1590 </dd> | |
| 1591 </dl><a NAME="Git.gitUnstage" ID="Git.gitUnstage"></a> | |
| 1592 <h4>Git.gitUnstage</h4> | |
| 1593 <b>gitUnstage</b>(<i>name</i>) | |
| 1594 <p> | |
| 1595 Public method used to unstage a file/directory. | |
| 1596 </p><dl> | |
| 1597 <dt><i>name</i></dt> | |
| 1598 <dd> | |
| 1599 file/directory name to be reverted (string) | |
| 1600 </dd> | |
| 1601 </dl><dl> | |
| 1602 <dt>Returns:</dt> | |
| 1603 <dd> | |
| 1604 flag indicating, that the update contained an add | |
| 1605 or delete (boolean) | |
| 1606 </dd> | |
| 1607 </dl><a NAME="Git.gitVerify" ID="Git.gitVerify"></a> | |
| 1608 <h4>Git.gitVerify</h4> | |
| 1609 <b>gitVerify</b>(<i>projectDir</i>) | |
| 1610 <p> | |
| 1611 Public method to verify the connectivity and validity of objects | |
| 1612 of the database. | |
| 1613 </p><dl> | |
| 1614 <dt><i>projectDir</i></dt> | |
| 1615 <dd> | |
| 1616 name of the project directory (string) | |
| 1617 </dd> | |
| 1618 </dl><a NAME="Git.gitVerifyBundle" ID="Git.gitVerifyBundle"></a> | |
| 1619 <h4>Git.gitVerifyBundle</h4> | |
| 1620 <b>gitVerifyBundle</b>(<i>projectDir</i>) | |
| 1621 <p> | |
| 1622 Public method to verify a bundle file. | |
| 1623 </p><dl> | |
| 1624 <dt><i>projectDir</i></dt> | |
| 1625 <dd> | |
| 1626 name of the project directory (string) | |
| 1627 </dd> | |
| 1628 </dl><a NAME="Git.initCommand" ID="Git.initCommand"></a> | |
| 1629 <h4>Git.initCommand</h4> | |
| 1630 <b>initCommand</b>(<i>command</i>) | |
| 1631 <p> | |
| 1632 Public method to initialize a command arguments list. | |
| 1633 </p><dl> | |
| 1634 <dt><i>command</i></dt> | |
| 1635 <dd> | |
| 1636 command name (string) | |
| 1637 </dd> | |
| 1638 </dl><dl> | |
| 1639 <dt>Returns:</dt> | |
| 1640 <dd> | |
| 1641 list of command options (list of string) | |
| 1642 </dd> | |
| 1643 </dl><a NAME="Git.vcsAdd" ID="Git.vcsAdd"></a> | |
| 1644 <h4>Git.vcsAdd</h4> | |
| 1645 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) | |
| 1646 <p> | |
| 1647 Public method used to add a file/directory to the Git repository. | |
| 1648 </p><dl> | |
| 1649 <dt><i>name</i></dt> | |
| 1650 <dd> | |
| 1651 file/directory name to be added (string) | |
| 1652 </dd><dt><i>isDir</i></dt> | |
| 1653 <dd> | |
| 1654 flag indicating name is a directory (boolean) | |
| 1655 </dd><dt><i>noDialog</i></dt> | |
| 1656 <dd> | |
| 1657 flag indicating quiet operations | |
| 1658 </dd> | |
| 1659 </dl><a NAME="Git.vcsAddBinary" ID="Git.vcsAddBinary"></a> | |
| 1660 <h4>Git.vcsAddBinary</h4> | |
| 1661 <b>vcsAddBinary</b>(<i>name, isDir=False</i>) | |
| 1662 <p> | |
| 1663 Public method used to add a file/directory in binary mode to the | |
| 1664 Git repository. | |
| 1665 </p><dl> | |
| 1666 <dt><i>name</i></dt> | |
| 1667 <dd> | |
| 1668 file/directory name to be added (string) | |
| 1669 </dd><dt><i>isDir</i></dt> | |
| 1670 <dd> | |
| 1671 flag indicating name is a directory (boolean) | |
| 1672 </dd> | |
| 1673 </dl><a NAME="Git.vcsAddTree" ID="Git.vcsAddTree"></a> | |
| 1674 <h4>Git.vcsAddTree</h4> | |
| 1675 <b>vcsAddTree</b>(<i>path</i>) | |
| 1676 <p> | |
| 1677 Public method to add a directory tree rooted at path to the Git | |
| 1678 repository. | |
| 1679 </p><dl> | |
| 1680 <dt><i>path</i></dt> | |
| 1681 <dd> | |
| 1682 root directory of the tree to be added (string or list of | |
| 1683 strings)) | |
| 1684 </dd> | |
| 1685 </dl><a NAME="Git.vcsAllRegisteredStates" ID="Git.vcsAllRegisteredStates"></a> | |
| 1686 <h4>Git.vcsAllRegisteredStates</h4> | |
| 1687 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) | |
| 1688 <p> | |
| 1689 Public method used to get the registered states of a number of files | |
| 1690 in the vcs. | |
| 1691 </p><p> | |
| 1692 <b>Note:</b> If a shortcut is to be taken, the code will only check, | |
| 1693 if the named directory has been scanned already. If so, it is assumed, | |
| 1694 that the states for all files have been populated by the previous run. | |
| 1695 </p><dl> | |
| 1696 <dt><i>names</i></dt> | |
| 1697 <dd> | |
| 1698 dictionary with all filenames to be checked as keys | |
| 1699 </dd><dt><i>dname</i></dt> | |
| 1700 <dd> | |
| 1701 directory to check in (string) | |
| 1702 </dd><dt><i>shortcut</i></dt> | |
| 1703 <dd> | |
| 1704 flag indicating a shortcut should be taken (boolean) | |
| 1705 </dd> | |
| 1706 </dl><dl> | |
| 1707 <dt>Returns:</dt> | |
| 1708 <dd> | |
| 1709 the received dictionary completed with a combination of | |
| 1710 canBeCommited and canBeAdded or None in order to signal an error | |
| 1711 </dd> | |
| 1712 </dl><a NAME="Git.vcsCheckout" ID="Git.vcsCheckout"></a> | |
| 1713 <h4>Git.vcsCheckout</h4> | |
| 1714 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) | |
| 1715 <p> | |
| 1716 Public method used to check the project out of a Git repository | |
| 1717 (clone). | |
| 1718 </p><dl> | |
| 1719 <dt><i>vcsDataDict</i></dt> | |
| 1720 <dd> | |
| 1721 dictionary of data required for the checkout | |
| 1722 </dd><dt><i>projectDir</i></dt> | |
| 1723 <dd> | |
| 1724 project directory to create (string) | |
| 1725 </dd><dt><i>noDialog</i></dt> | |
| 1726 <dd> | |
| 1727 flag indicating quiet operations | |
| 1728 </dd> | |
| 1729 </dl><dl> | |
| 1730 <dt>Returns:</dt> | |
| 1731 <dd> | |
| 1732 flag indicating an execution without errors (boolean) | |
| 1733 </dd> | |
| 1734 </dl><a NAME="Git.vcsCleanup" ID="Git.vcsCleanup"></a> | |
| 1735 <h4>Git.vcsCleanup</h4> | |
| 1736 <b>vcsCleanup</b>(<i>name</i>) | |
| 1737 <p> | |
| 1738 Public method used to cleanup the working directory. | |
| 1739 </p><dl> | |
| 1740 <dt><i>name</i></dt> | |
| 1741 <dd> | |
| 1742 directory name to be cleaned up (string) | |
| 1743 </dd> | |
| 1744 </dl><a NAME="Git.vcsCommandLine" ID="Git.vcsCommandLine"></a> | |
| 1745 <h4>Git.vcsCommandLine</h4> | |
| 1746 <b>vcsCommandLine</b>(<i>name</i>) | |
| 1747 <p> | |
| 1748 Public method used to execute arbitrary Git commands. | |
| 1749 </p><dl> | |
| 1750 <dt><i>name</i></dt> | |
| 1751 <dd> | |
| 1752 directory name of the working directory (string) | |
| 1753 </dd> | |
| 1754 </dl><a NAME="Git.vcsCommit" ID="Git.vcsCommit"></a> | |
| 1755 <h4>Git.vcsCommit</h4> | |
| 1756 <b>vcsCommit</b>(<i>name, message="", noDialog=False, commitAll=True, amend=False</i>) | |
| 1757 <p> | |
| 1758 Public method used to make the change of a file/directory permanent | |
| 1759 in the Git repository. | |
| 1760 </p><dl> | |
| 1761 <dt><i>name</i></dt> | |
| 1762 <dd> | |
| 1763 file/directory name to be committed (string or list of | |
| 1764 strings) | |
| 1765 </dd><dt><i>message</i></dt> | |
| 1766 <dd> | |
| 1767 message for this operation (string) | |
| 1768 </dd><dt><i>noDialog</i></dt> | |
| 1769 <dd> | |
| 1770 flag indicating quiet operations (boolean) | |
| 1771 </dd><dt><i>commitAll</i></dt> | |
| 1772 <dd> | |
| 1773 flag indicating to commit all local changes (boolean) | |
| 1774 </dd><dt><i>amend</i></dt> | |
| 1775 <dd> | |
| 1776 flag indicating to amend the HEAD commit (boolean) | |
| 1777 </dd> | |
| 1778 </dl><a NAME="Git.vcsConvertProject" ID="Git.vcsConvertProject"></a> | |
| 1779 <h4>Git.vcsConvertProject</h4> | |
| 1780 <b>vcsConvertProject</b>(<i>vcsDataDict, project</i>) | |
| 1781 <p> | |
| 1782 Public method to convert an uncontrolled project to a version | |
| 1783 controlled project. | |
| 1784 </p><dl> | |
| 1785 <dt><i>vcsDataDict</i></dt> | |
| 1786 <dd> | |
| 1787 dictionary of data required for the conversion | |
| 1788 </dd><dt><i>project</i></dt> | |
| 1789 <dd> | |
| 1790 reference to the project object | |
| 1791 </dd> | |
| 1792 </dl><a NAME="Git.vcsDiff" ID="Git.vcsDiff"></a> | |
| 1793 <h4>Git.vcsDiff</h4> | |
| 1794 <b>vcsDiff</b>(<i>name</i>) | |
| 1795 <p> | |
| 1796 Public method used to view the difference of a file/directory to the | |
| 1797 Git repository. | |
| 1798 </p><p> | |
| 1799 If name is a directory and is the project directory, all project files | |
| 1800 are saved first. If name is a file (or list of files), which is/are | |
| 1801 being edited and has unsaved modification, they can be saved or the | |
| 1802 operation may be aborted. | |
| 1803 </p><dl> | |
| 1804 <dt><i>name</i></dt> | |
| 1805 <dd> | |
| 1806 file/directory name to be diffed (string) | |
| 1807 </dd> | |
| 1808 </dl><a NAME="Git.vcsExists" ID="Git.vcsExists"></a> | |
| 1809 <h4>Git.vcsExists</h4> | |
| 1810 <b>vcsExists</b>(<i></i>) | |
| 1811 <p> | |
| 1812 Public method used to test for the presence of the git executable. | |
| 1813 </p><dl> | |
| 1814 <dt>Returns:</dt> | |
| 1815 <dd> | |
| 1816 flag indicating the existance (boolean) and an error message | |
| 1817 (string) | |
| 1818 </dd> | |
| 1819 </dl><a NAME="Git.vcsExport" ID="Git.vcsExport"></a> | |
| 1820 <h4>Git.vcsExport</h4> | |
| 1821 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>) | |
| 1822 <p> | |
| 1823 Public method used to export a directory from the Git repository. | |
| 1824 </p><dl> | |
| 1825 <dt><i>vcsDataDict</i></dt> | |
| 1826 <dd> | |
| 1827 dictionary of data required for the checkout | |
| 1828 </dd><dt><i>projectDir</i></dt> | |
| 1829 <dd> | |
| 1830 project directory to create (string) | |
| 1831 </dd> | |
| 1832 </dl><dl> | |
| 1833 <dt>Returns:</dt> | |
| 1834 <dd> | |
| 1835 flag indicating an execution without errors (boolean) | |
| 1836 </dd> | |
| 1837 </dl><a NAME="Git.vcsGetProjectBrowserHelper" ID="Git.vcsGetProjectBrowserHelper"></a> | |
| 1838 <h4>Git.vcsGetProjectBrowserHelper</h4> | |
| 1839 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) | |
| 1840 <p> | |
| 1841 Public method to instantiate a helper object for the different | |
| 1842 project browsers. | |
| 1843 </p><dl> | |
| 1844 <dt><i>browser</i></dt> | |
| 1845 <dd> | |
| 1846 reference to the project browser object | |
| 1847 </dd><dt><i>project</i></dt> | |
| 1848 <dd> | |
| 1849 reference to the project object | |
| 1850 </dd><dt><i>isTranslationsBrowser</i></dt> | |
| 1851 <dd> | |
| 1852 flag indicating, the helper is requested | |
| 1853 for the translations browser (this needs some special treatment) | |
| 1854 </dd> | |
| 1855 </dl><dl> | |
| 1856 <dt>Returns:</dt> | |
| 1857 <dd> | |
| 1858 the project browser helper object | |
| 1859 </dd> | |
| 1860 </dl><a NAME="Git.vcsGetProjectHelper" ID="Git.vcsGetProjectHelper"></a> | |
| 1861 <h4>Git.vcsGetProjectHelper</h4> | |
| 1862 <b>vcsGetProjectHelper</b>(<i>project</i>) | |
| 1863 <p> | |
| 1864 Public method to instantiate a helper object for the project. | |
| 1865 </p><dl> | |
| 1866 <dt><i>project</i></dt> | |
| 1867 <dd> | |
| 1868 reference to the project object | |
| 1869 </dd> | |
| 1870 </dl><dl> | |
| 1871 <dt>Returns:</dt> | |
| 1872 <dd> | |
| 1873 the project helper object | |
| 1874 </dd> | |
| 1875 </dl><a NAME="Git.vcsImport" ID="Git.vcsImport"></a> | |
| 1876 <h4>Git.vcsImport</h4> | |
| 1877 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) | |
| 1878 <p> | |
| 1879 Public method used to import the project into the Git repository. | |
| 1880 </p><dl> | |
| 1881 <dt><i>vcsDataDict</i></dt> | |
| 1882 <dd> | |
| 1883 dictionary of data required for the import | |
| 1884 </dd><dt><i>projectDir</i></dt> | |
| 1885 <dd> | |
| 1886 project directory (string) | |
| 1887 </dd><dt><i>noDialog</i></dt> | |
| 1888 <dd> | |
| 1889 flag indicating quiet operations | |
| 1890 </dd> | |
| 1891 </dl><dl> | |
| 1892 <dt>Returns:</dt> | |
| 1893 <dd> | |
| 1894 flag indicating an execution without errors (boolean) | |
| 1895 and a flag indicating the version controll status (boolean) | |
| 1896 </dd> | |
| 1897 </dl><a NAME="Git.vcsInit" ID="Git.vcsInit"></a> | |
| 1898 <h4>Git.vcsInit</h4> | |
| 1899 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) | |
| 1900 <p> | |
| 1901 Public method used to initialize the Git repository. | |
| 1902 </p><p> | |
| 1903 The initialization is done, when a project is converted into a | |
| 1904 Git controlled project. Therefore we always return TRUE without | |
| 1905 doing anything. | |
| 1906 </p><dl> | |
| 1907 <dt><i>vcsDir</i></dt> | |
| 1908 <dd> | |
| 1909 name of the VCS directory (string) | |
| 1910 </dd><dt><i>noDialog</i></dt> | |
| 1911 <dd> | |
| 1912 flag indicating quiet operations (boolean) | |
| 1913 </dd> | |
| 1914 </dl><dl> | |
| 1915 <dt>Returns:</dt> | |
| 1916 <dd> | |
| 1917 always TRUE | |
| 1918 </dd> | |
| 1919 </dl><a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a> | |
| 1920 <h4>Git.vcsInitConfig</h4> | |
| 1921 <b>vcsInitConfig</b>(<i>project</i>) | |
| 1922 <p> | |
| 1923 Public method to initialize the VCS configuration. | |
| 1924 </p><p> | |
| 1925 This method ensures, that an ignore file exists. | |
| 1926 </p><dl> | |
| 1927 <dt><i>project</i></dt> | |
| 1928 <dd> | |
| 1929 reference to the project (Project) | |
| 1930 </dd> | |
| 1931 </dl><a NAME="Git.vcsLogBrowser" ID="Git.vcsLogBrowser"></a> | |
| 1932 <h4>Git.vcsLogBrowser</h4> | |
| 1933 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) | |
| 1934 <p> | |
| 1935 Public method used to browse the log of a file/directory from the | |
| 1936 Git repository. | |
| 1937 </p><dl> | |
| 1938 <dt><i>name</i></dt> | |
| 1939 <dd> | |
| 1940 file/directory name to show the log of (string) | |
| 1941 </dd><dt><i>isFile=</i></dt> | |
| 1942 <dd> | |
| 1943 flag indicating log for a file is to be shown | |
| 1944 (boolean) | |
| 1945 </dd> | |
| 1946 </dl><a NAME="Git.vcsMerge" ID="Git.vcsMerge"></a> | |
| 1947 <h4>Git.vcsMerge</h4> | |
| 1948 <b>vcsMerge</b>(<i>name</i>) | |
| 1949 <p> | |
| 1950 Public method used to merge a URL/revision into the local project. | |
| 1951 </p><dl> | |
| 1952 <dt><i>name</i></dt> | |
| 1953 <dd> | |
| 1954 file/directory name to be merged (string) | |
| 1955 </dd> | |
| 1956 </dl><a NAME="Git.vcsMove" ID="Git.vcsMove"></a> | |
| 1957 <h4>Git.vcsMove</h4> | |
| 1958 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) | |
| 1959 <p> | |
| 1960 Public method used to move a file/directory. | |
| 1961 </p><dl> | |
| 1962 <dt><i>name</i></dt> | |
| 1963 <dd> | |
| 1964 file/directory name to be moved (string) | |
| 1965 </dd><dt><i>project</i></dt> | |
| 1966 <dd> | |
| 1967 reference to the project object | |
| 1968 </dd><dt><i>target</i></dt> | |
| 1969 <dd> | |
| 1970 new name of the file/directory (string) | |
| 1971 </dd><dt><i>noDialog</i></dt> | |
| 1972 <dd> | |
| 1973 flag indicating quiet operations | |
| 1974 </dd> | |
| 1975 </dl><dl> | |
| 1976 <dt>Returns:</dt> | |
| 1977 <dd> | |
| 1978 flag indicating successful operation (boolean) | |
| 1979 </dd> | |
| 1980 </dl><a NAME="Git.vcsName" ID="Git.vcsName"></a> | |
| 1981 <h4>Git.vcsName</h4> | |
| 1982 <b>vcsName</b>(<i></i>) | |
| 1983 <p> | |
| 1984 Public method returning the name of the vcs. | |
| 1985 </p><dl> | |
| 1986 <dt>Returns:</dt> | |
| 1987 <dd> | |
| 1988 always 'Git' (string) | |
| 1989 </dd> | |
| 1990 </dl><a NAME="Git.vcsNewProjectOptionsDialog" ID="Git.vcsNewProjectOptionsDialog"></a> | |
| 1991 <h4>Git.vcsNewProjectOptionsDialog</h4> | |
| 1992 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) | |
| 1993 <p> | |
| 1994 Public method to get a dialog to enter repository info for getting a | |
| 1995 new project. | |
| 1996 </p><dl> | |
| 1997 <dt><i>parent</i></dt> | |
| 1998 <dd> | |
| 1999 parent widget (QWidget) | |
| 2000 </dd> | |
| 2001 </dl><dl> | |
| 2002 <dt>Returns:</dt> | |
| 2003 <dd> | |
| 2004 reference to the instantiated options dialog | |
| 2005 (GitNewProjectOptionsDialog) | |
| 2006 </dd> | |
| 2007 </dl><a NAME="Git.vcsOptionsDialog" ID="Git.vcsOptionsDialog"></a> | |
| 2008 <h4>Git.vcsOptionsDialog</h4> | |
| 2009 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) | |
| 2010 <p> | |
| 2011 Public method to get a dialog to enter repository info. | |
| 2012 </p><dl> | |
| 2013 <dt><i>project</i></dt> | |
| 2014 <dd> | |
| 2015 reference to the project object | |
| 2016 </dd><dt><i>archive</i></dt> | |
| 2017 <dd> | |
| 2018 name of the project in the repository (string) | |
| 2019 </dd><dt><i>editable</i></dt> | |
| 2020 <dd> | |
| 2021 flag indicating that the project name is editable | |
| 2022 (boolean) | |
| 2023 </dd><dt><i>parent</i></dt> | |
| 2024 <dd> | |
| 2025 parent widget (QWidget) | |
| 2026 </dd> | |
| 2027 </dl><dl> | |
| 2028 <dt>Returns:</dt> | |
| 2029 <dd> | |
| 2030 reference to the instantiated options dialog (GitOptionsDialog) | |
| 2031 </dd> | |
| 2032 </dl><a NAME="Git.vcsRegisteredState" ID="Git.vcsRegisteredState"></a> | |
| 2033 <h4>Git.vcsRegisteredState</h4> | |
| 2034 <b>vcsRegisteredState</b>(<i>name</i>) | |
| 2035 <p> | |
| 2036 Public method used to get the registered state of a file in the vcs. | |
| 2037 </p><dl> | |
| 2038 <dt><i>name</i></dt> | |
| 2039 <dd> | |
| 2040 filename to check (string) | |
| 2041 </dd> | |
| 2042 </dl><dl> | |
| 2043 <dt>Returns:</dt> | |
| 2044 <dd> | |
| 2045 a combination of canBeCommited and canBeAdded | |
| 2046 </dd> | |
| 2047 </dl><a NAME="Git.vcsRemove" ID="Git.vcsRemove"></a> | |
| 2048 <h4>Git.vcsRemove</h4> | |
| 2049 <b>vcsRemove</b>(<i>name, project=False, noDialog=False, stageOnly=False</i>) | |
| 2050 <p> | |
| 2051 Public method used to remove a file/directory from the Git | |
| 2052 repository. | |
| 2053 </p><p> | |
| 2054 The default operation is to remove the local copy as well. | |
| 2055 </p><dl> | |
| 2056 <dt><i>name</i></dt> | |
| 2057 <dd> | |
| 2058 file/directory name to be removed (string or list of | |
| 2059 strings)) | |
| 2060 </dd><dt><i>project</i></dt> | |
| 2061 <dd> | |
| 2062 flag indicating deletion of a project tree (boolean) | |
| 2063 (not needed) | |
| 2064 </dd><dt><i>noDialog</i></dt> | |
| 2065 <dd> | |
| 2066 flag indicating quiet operations (boolean) | |
| 2067 </dd><dt><i>stageOnly</i></dt> | |
| 2068 <dd> | |
| 2069 flag indicating to just remove the file from the | |
| 2070 staging area (boolean) | |
| 2071 </dd> | |
| 2072 </dl><dl> | |
| 2073 <dt>Returns:</dt> | |
| 2074 <dd> | |
| 2075 flag indicating successful operation (boolean) | |
| 2076 </dd> | |
| 2077 </dl><a NAME="Git.vcsRepositoryInfos" ID="Git.vcsRepositoryInfos"></a> | |
| 2078 <h4>Git.vcsRepositoryInfos</h4> | |
| 2079 <b>vcsRepositoryInfos</b>(<i>ppath</i>) | |
| 2080 <p> | |
| 2081 Public method to retrieve information about the repository. | |
| 2082 </p><dl> | |
| 2083 <dt><i>ppath</i></dt> | |
| 2084 <dd> | |
| 2085 local path to get the repository infos (string) | |
| 2086 </dd> | |
| 2087 </dl><dl> | |
| 2088 <dt>Returns:</dt> | |
| 2089 <dd> | |
| 2090 string with ready formated info for display (string) | |
| 2091 </dd> | |
| 2092 </dl><a NAME="Git.vcsShutdown" ID="Git.vcsShutdown"></a> | |
| 2093 <h4>Git.vcsShutdown</h4> | |
| 2094 <b>vcsShutdown</b>(<i></i>) | |
| 2095 <p> | |
| 2096 Public method used to shutdown the Git interface. | |
| 2097 </p><a NAME="Git.vcsStatus" ID="Git.vcsStatus"></a> | |
| 2098 <h4>Git.vcsStatus</h4> | |
| 2099 <b>vcsStatus</b>(<i>name</i>) | |
| 2100 <p> | |
| 2101 Public method used to view the status of files/directories in the | |
| 2102 Git repository. | |
| 2103 </p><dl> | |
| 2104 <dt><i>name</i></dt> | |
| 2105 <dd> | |
| 2106 file/directory name(s) to show the status of | |
| 2107 (string or list of strings) | |
| 2108 </dd> | |
| 2109 </dl><a NAME="Git.vcsSupportCommandOptions" ID="Git.vcsSupportCommandOptions"></a> | |
| 2110 <h4>Git.vcsSupportCommandOptions</h4> | |
| 2111 <b>vcsSupportCommandOptions</b>(<i></i>) | |
| 2112 <p> | |
| 2113 Public method to signal the support of user settable command options. | |
| 2114 </p><dl> | |
| 2115 <dt>Returns:</dt> | |
| 2116 <dd> | |
| 2117 flag indicating the support of user settable command options | |
| 2118 (boolean) | |
| 2119 </dd> | |
| 2120 </dl><a NAME="Git.vcsSwitch" ID="Git.vcsSwitch"></a> | |
| 2121 <h4>Git.vcsSwitch</h4> | |
| 2122 <b>vcsSwitch</b>(<i>name</i>) | |
| 2123 <p> | |
| 2124 Public method used to switch a working directory to a different | |
| 2125 revision. | |
| 2126 </p><dl> | |
| 2127 <dt><i>name</i></dt> | |
| 2128 <dd> | |
| 2129 directory name to be switched (string) | |
| 2130 </dd> | |
| 2131 </dl><dl> | |
| 2132 <dt>Returns:</dt> | |
| 2133 <dd> | |
| 2134 flag indicating, that the switch contained an add | |
| 2135 or delete (boolean) | |
| 2136 </dd> | |
| 2137 </dl><a NAME="Git.vcsTag" ID="Git.vcsTag"></a> | |
| 2138 <h4>Git.vcsTag</h4> | |
| 2139 <b>vcsTag</b>(<i>name, revision=None, tagName=None</i>) | |
| 2140 <p> | |
| 2141 Public method used to set/remove a tag in the Git repository. | |
| 2142 </p><dl> | |
| 2143 <dt><i>name</i></dt> | |
| 2144 <dd> | |
| 2145 file/directory name to determine the repo root from | |
| 2146 (string) | |
| 2147 </dd><dt><i>revision</i></dt> | |
| 2148 <dd> | |
| 2149 revision to set tag for (string) | |
| 2150 </dd><dt><i>tagName</i></dt> | |
| 2151 <dd> | |
| 2152 name of the tag (string) | |
| 2153 </dd> | |
| 2154 </dl><dl> | |
| 2155 <dt>Returns:</dt> | |
| 2156 <dd> | |
| 2157 flag indicating a performed tag action (boolean) | |
| 2158 </dd> | |
| 2159 </dl><a NAME="Git.vcsUpdate" ID="Git.vcsUpdate"></a> | |
| 2160 <h4>Git.vcsUpdate</h4> | |
| 2161 <b>vcsUpdate</b>(<i>name, noDialog=False, revision=None</i>) | |
| 2162 <p> | |
| 2163 Public method used to update a file/directory with the Git | |
| 2164 repository. | |
| 2165 </p><dl> | |
| 2166 <dt><i>name</i></dt> | |
| 2167 <dd> | |
| 2168 file/directory name to be updated (string or list of | |
| 2169 strings) | |
| 2170 </dd><dt><i>noDialog</i></dt> | |
| 2171 <dd> | |
| 2172 flag indicating quiet operations (boolean) | |
| 2173 </dd><dt><i>revision=</i></dt> | |
| 2174 <dd> | |
| 2175 revision to update to (string) | |
| 2176 </dd> | |
| 2177 </dl><dl> | |
| 2178 <dt>Returns:</dt> | |
| 2179 <dd> | |
| 2180 flag indicating, that the update contained an add | |
| 2181 or delete (boolean) | |
| 2182 </dd> | |
| 2183 </dl> | |
| 2184 <div align="right"><a href="#top">Up</a></div> | |
| 2185 <hr /> | |
| 2186 </body></html> |
