Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8652
- 8cacde11f4fd
- child 9244
- 3bf1a02df07a
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.hg</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.vcsMercurial.hg</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the version control systems interface to Mercurial. | |
| 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="#Hg">Hg</a></td> | |
| 25 <td>Class implementing the version control systems interface to Mercurial.</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="Hg" ID="Hg"></a> | |
| 36 <h2>Hg</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the version control systems interface to Mercurial. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>activeExtensionsChanged()</dt> | |
| 45 <dd> | |
| 46 emitted when the list of active | |
| 47 extensions has changed | |
| 48 </dd> | |
| 49 <dt>committed()</dt> | |
| 50 <dd> | |
| 51 emitted after the commit action has completed | |
| 52 </dd> | |
| 53 <dt>iniFileChanged()</dt> | |
| 54 <dd> | |
| 55 emitted when a Mercurial/repo configuration file | |
| 56 has changed | |
| 57 </dd> | |
| 58 </dl> | |
| 59 <h3>Derived from</h3> | |
| 60 VersionControl | |
| 61 <h3>Class Attributes</h3> | |
| 62 | |
| 63 <table> | |
| 64 <tr><td>IgnoreFileName</td></tr> | |
| 65 </table> | |
| 66 <h3>Class Methods</h3> | |
| 67 | |
| 68 <table> | |
| 69 <tr><td>None</td></tr> | |
| 70 </table> | |
| 71 <h3>Methods</h3> | |
| 72 | |
| 73 <table> | |
| 74 | |
| 75 <tr> | |
| 76 <td><a href="#Hg.__init__">Hg</a></td> | |
| 77 <td>Constructor</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#Hg.__checkDefaults">__checkDefaults</a></td> | |
| 81 <td>Private method to check, if the default and default-push URLs have been configured.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#Hg.__createClient">__createClient</a></td> | |
| 85 <td>Private method to create a Mercurial command server client.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#Hg.__getExtensionsInfo">__getExtensionsInfo</a></td> | |
| 89 <td>Private method to get the active extensions from Mercurial.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#Hg.__getInOutBookmarks">__getInOutBookmarks</a></td> | |
| 93 <td>Private method to get the list of incoming or outgoing bookmarks.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#Hg.__getMostRecentCommitMessage">__getMostRecentCommitMessage</a></td> | |
| 97 <td>Private method to get the most recent commit message.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#Hg.__hgGetFileForRevision">__hgGetFileForRevision</a></td> | |
| 101 <td>Private method to get a file for a specific revision from the repository.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#Hg.__hgGraftSubCommand">__hgGraftSubCommand</a></td> | |
| 105 <td>Private method to perform a Mercurial graft subcommand.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#Hg.__iniFileChanged">__iniFileChanged</a></td> | |
| 109 <td>Private slot to handle a change of the Mercurial configuration file.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#Hg.__monitorRepoIniFile">__monitorRepoIniFile</a></td> | |
| 113 <td>Private slot to add a repository configuration file to the list of monitored files.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#Hg.__vcsCommit_Step2">__vcsCommit_Step2</a></td> | |
| 117 <td>Private slot performing the second step of the commit action.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#Hg._createStatusMonitorThread">_createStatusMonitorThread</a></td> | |
| 121 <td>Protected method to create an instance of the VCS status monitor thread.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#Hg.canCommitMerge">canCommitMerge</a></td> | |
| 125 <td>Public method to check, if the working directory is an uncommitted merge.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 128 <td><a href="#Hg.canPull">canPull</a></td> | |
| 129 <td>Public method to check, if pull is possible.</td> | |
| 130 </tr> | |
| 131 <tr> | |
| 132 <td><a href="#Hg.canPush">canPush</a></td> | |
| 133 <td>Public method to check, if push is possible.</td> | |
| 134 </tr> | |
| 135 <tr> | |
| 136 <td><a href="#Hg.clearStatusCache">clearStatusCache</a></td> | |
| 137 <td>Public method to clear the status cache.</td> | |
| 138 </tr> | |
| 139 <tr> | |
| 140 <td><a href="#Hg.getClient">getClient</a></td> | |
| 141 <td>Public method to get a reference to the command server interface.</td> | |
| 142 </tr> | |
| 143 <tr> | |
| 144 <td><a href="#Hg.getEncoding">getEncoding</a></td> | |
| 145 <td>Public method to get the encoding to be used by Mercurial.</td> | |
| 146 </tr> | |
| 147 <tr> | |
| 148 <td><a href="#Hg.getExtensionObject">getExtensionObject</a></td> | |
| 149 <td>Public method to get a reference to an extension object.</td> | |
| 150 </tr> | |
| 151 <tr> | |
| 152 <td><a href="#Hg.getHgSubPath">getHgSubPath</a></td> | |
| 153 <td>Public method to get the path to the .hgsub file containing the definitions of sub-repositories.</td> | |
| 154 </tr> | |
| 155 <tr> | |
| 156 <td><a href="#Hg.getPlugin">getPlugin</a></td> | |
| 157 <td>Public method to get a reference to the plugin object.</td> | |
| 158 </tr> | |
| 159 <tr> | |
| 160 <td><a href="#Hg.hasSubrepositories">hasSubrepositories</a></td> | |
| 161 <td>Public method to check, if the project might have sub-repositories.</td> | |
| 162 </tr> | |
| 163 <tr> | |
| 164 <td><a href="#Hg.hgAbortMerge">hgAbortMerge</a></td> | |
| 165 <td>Public method to abort an uncommitted merge.</td> | |
| 166 </tr> | |
| 167 <tr> | |
| 168 <td><a href="#Hg.hgAddSubrepository">hgAddSubrepository</a></td> | |
| 169 <td>Public method to add a sub-repository.</td> | |
| 170 </tr> | |
| 171 <tr> | |
| 172 <td><a href="#Hg.hgAnnotate">hgAnnotate</a></td> | |
| 173 <td>Public method to show the output of the hg annotate command.</td> | |
| 174 </tr> | |
| 175 <tr> | |
| 176 <td><a href="#Hg.hgArchive">hgArchive</a></td> | |
| 177 <td>Public method to create an unversioned archive from the repository.</td> | |
| 178 </tr> | |
| 179 <tr> | |
| 180 <td><a href="#Hg.hgBackout">hgBackout</a></td> | |
| 181 <td>Public method used to backout an earlier changeset from the Mercurial repository.</td> | |
| 182 </tr> | |
| 183 <tr> | |
| 184 <td><a href="#Hg.hgBisect">hgBisect</a></td> | |
| 185 <td>Public method to perform bisect commands.</td> | |
| 186 </tr> | |
| 187 <tr> | |
| 188 <td><a href="#Hg.hgBookmarkDefine">hgBookmarkDefine</a></td> | |
| 189 <td>Public method to define a bookmark.</td> | |
| 190 </tr> | |
| 191 <tr> | |
| 192 <td><a href="#Hg.hgBookmarkDelete">hgBookmarkDelete</a></td> | |
| 193 <td>Public method to delete a bookmark.</td> | |
| 194 </tr> | |
| 195 <tr> | |
| 196 <td><a href="#Hg.hgBookmarkIncoming">hgBookmarkIncoming</a></td> | |
| 197 <td>Public method to show a list of incoming bookmarks.</td> | |
| 198 </tr> | |
| 199 <tr> | |
| 200 <td><a href="#Hg.hgBookmarkMove">hgBookmarkMove</a></td> | |
| 201 <td>Public method to move a bookmark.</td> | |
| 202 </tr> | |
| 203 <tr> | |
| 204 <td><a href="#Hg.hgBookmarkOutgoing">hgBookmarkOutgoing</a></td> | |
| 205 <td>Public method to show a list of outgoing bookmarks.</td> | |
| 206 </tr> | |
| 207 <tr> | |
| 208 <td><a href="#Hg.hgBookmarkPull">hgBookmarkPull</a></td> | |
| 209 <td>Public method to pull a bookmark from a remote repository.</td> | |
| 210 </tr> | |
| 211 <tr> | |
| 212 <td><a href="#Hg.hgBookmarkPush">hgBookmarkPush</a></td> | |
| 213 <td>Public method to push a bookmark to a remote repository.</td> | |
| 214 </tr> | |
| 215 <tr> | |
| 216 <td><a href="#Hg.hgBookmarkRename">hgBookmarkRename</a></td> | |
| 217 <td>Public method to rename a bookmark.</td> | |
| 218 </tr> | |
| 219 <tr> | |
| 220 <td><a href="#Hg.hgBranch">hgBranch</a></td> | |
| 221 <td>Public method used to create a branch in the Mercurial repository.</td> | |
| 222 </tr> | |
| 223 <tr> | |
| 224 <td><a href="#Hg.hgBundle">hgBundle</a></td> | |
| 225 <td>Public method to create a changegroup file.</td> | |
| 226 </tr> | |
| 227 <tr> | |
| 228 <td><a href="#Hg.hgConflicts">hgConflicts</a></td> | |
| 229 <td>Public method used to show a list of files containing conflicts.</td> | |
| 230 </tr> | |
| 231 <tr> | |
| 232 <td><a href="#Hg.hgCopy">hgCopy</a></td> | |
| 233 <td>Public method used to copy a file/directory.</td> | |
| 234 </tr> | |
| 235 <tr> | |
| 236 <td><a href="#Hg.hgCreateIgnoreFile">hgCreateIgnoreFile</a></td> | |
| 237 <td>Public method to create the ignore file.</td> | |
| 238 </tr> | |
| 239 <tr> | |
| 240 <td><a href="#Hg.hgDeleteBackups">hgDeleteBackups</a></td> | |
| 241 <td>Public method to delete all backup bundles in the backup area.</td> | |
| 242 </tr> | |
| 243 <tr> | |
| 244 <td><a href="#Hg.hgEditConfig">hgEditConfig</a></td> | |
| 245 <td>Public method used to edit the repository configuration file.</td> | |
| 246 </tr> | |
| 247 <tr> | |
| 248 <td><a href="#Hg.hgEditUserConfig">hgEditUserConfig</a></td> | |
| 249 <td>Public method used to edit the user configuration file.</td> | |
| 250 </tr> | |
| 251 <tr> | |
| 252 <td><a href="#Hg.hgExport">hgExport</a></td> | |
| 253 <td>Public method to export patches to files.</td> | |
| 254 </tr> | |
| 255 <tr> | |
| 256 <td><a href="#Hg.hgExtendedDiff">hgExtendedDiff</a></td> | |
| 257 <td>Public method used to view the difference of a file/directory to the Mercurial repository.</td> | |
| 258 </tr> | |
| 259 <tr> | |
| 260 <td><a href="#Hg.hgGetBookmarksList">hgGetBookmarksList</a></td> | |
| 261 <td>Public method to get the list of bookmarks.</td> | |
| 262 </tr> | |
| 263 <tr> | |
| 264 <td><a href="#Hg.hgGetBranchesList">hgGetBranchesList</a></td> | |
| 265 <td>Public method to get the list of branches.</td> | |
| 266 </tr> | |
| 267 <tr> | |
| 268 <td><a href="#Hg.hgGetCurrentBranch">hgGetCurrentBranch</a></td> | |
| 269 <td>Public method to get the current branch of the working directory.</td> | |
| 270 </tr> | |
| 271 <tr> | |
| 272 <td><a href="#Hg.hgGetTagsList">hgGetTagsList</a></td> | |
| 273 <td>Public method to get the list of tags.</td> | |
| 274 </tr> | |
| 275 <tr> | |
| 276 <td><a href="#Hg.hgGraft">hgGraft</a></td> | |
| 277 <td>Public method to copy changesets from another branch.</td> | |
| 278 </tr> | |
| 279 <tr> | |
| 280 <td><a href="#Hg.hgGraftAbort">hgGraftAbort</a></td> | |
| 281 <td>Public method to abort an interrupted copying session and perform a rollback.</td> | |
| 282 </tr> | |
| 283 <tr> | |
| 284 <td><a href="#Hg.hgGraftContinue">hgGraftContinue</a></td> | |
| 285 <td>Public method to continue copying changesets from another branch.</td> | |
| 286 </tr> | |
| 287 <tr> | |
| 288 <td><a href="#Hg.hgGraftStop">hgGraftStop</a></td> | |
| 289 <td>Public method to stop an interrupted copying session.</td> | |
| 290 </tr> | |
| 291 <tr> | |
| 292 <td><a href="#Hg.hgIdentify">hgIdentify</a></td> | |
| 293 <td>Public method to identify the current working directory.</td> | |
| 294 </tr> | |
| 295 <tr> | |
| 296 <td><a href="#Hg.hgImport">hgImport</a></td> | |
| 297 <td>Public method to import a patch file.</td> | |
| 298 </tr> | |
| 299 <tr> | |
| 300 <td><a href="#Hg.hgIncoming">hgIncoming</a></td> | |
| 301 <td>Public method used to view the log of incoming changes from the Mercurial repository.</td> | |
| 302 </tr> | |
| 303 <tr> | |
| 304 <td><a href="#Hg.hgInfo">hgInfo</a></td> | |
| 305 <td>Public method to show information about the heads of the repository.</td> | |
| 306 </tr> | |
| 307 <tr> | |
| 308 <td><a href="#Hg.hgListBookmarks">hgListBookmarks</a></td> | |
| 309 <td>Public method used to list the available bookmarks.</td> | |
| 310 </tr> | |
| 311 <tr> | |
| 312 <td><a href="#Hg.hgListTagBranch">hgListTagBranch</a></td> | |
| 313 <td>Public method used to list the available tags or branches.</td> | |
| 314 </tr> | |
| 315 <tr> | |
| 316 <td><a href="#Hg.hgNormalizeURL">hgNormalizeURL</a></td> | |
| 317 <td>Public method to normalize a url for Mercurial.</td> | |
| 318 </tr> | |
| 319 <tr> | |
| 320 <td><a href="#Hg.hgOutgoing">hgOutgoing</a></td> | |
| 321 <td>Public method used to view the log of outgoing changes from the Mercurial repository.</td> | |
| 322 </tr> | |
| 323 <tr> | |
| 324 <td><a href="#Hg.hgPhase">hgPhase</a></td> | |
| 325 <td>Public method to change the phase of revisions.</td> | |
| 326 </tr> | |
| 327 <tr> | |
| 328 <td><a href="#Hg.hgPreviewBundle">hgPreviewBundle</a></td> | |
| 329 <td>Public method used to view the log of incoming changes from a changegroup file.</td> | |
| 330 </tr> | |
| 331 <tr> | |
| 332 <td><a href="#Hg.hgPull">hgPull</a></td> | |
| 333 <td>Public method used to pull changes from a remote Mercurial repository.</td> | |
| 334 </tr> | |
| 335 <tr> | |
| 336 <td><a href="#Hg.hgPush">hgPush</a></td> | |
| 337 <td>Public method used to push changes to a remote Mercurial repository.</td> | |
| 338 </tr> | |
| 339 <tr> | |
| 340 <td><a href="#Hg.hgReMerge">hgReMerge</a></td> | |
| 341 <td>Public method used to merge a URL/revision into the local project.</td> | |
| 342 </tr> | |
| 343 <tr> | |
| 344 <td><a href="#Hg.hgRecover">hgRecover</a></td> | |
| 345 <td>Public method to recover an interrupted transaction.</td> | |
| 346 </tr> | |
| 347 <tr> | |
| 348 <td><a href="#Hg.hgRemoveSubrepositories">hgRemoveSubrepositories</a></td> | |
| 349 <td>Public method to remove sub-repositories.</td> | |
| 350 </tr> | |
| 351 <tr> | |
| 352 <td><a href="#Hg.hgRollback">hgRollback</a></td> | |
| 353 <td>Public method used to rollback the last transaction.</td> | |
| 354 </tr> | |
| 355 <tr> | |
| 356 <td><a href="#Hg.hgServe">hgServe</a></td> | |
| 357 <td>Public method used to serve the project.</td> | |
| 358 </tr> | |
| 359 <tr> | |
| 360 <td><a href="#Hg.hgShowBranch">hgShowBranch</a></td> | |
| 361 <td>Public method used to show the current branch of the working directory.</td> | |
| 362 </tr> | |
| 363 <tr> | |
| 364 <td><a href="#Hg.hgShowConfig">hgShowConfig</a></td> | |
| 365 <td>Public method to show the combined configuration.</td> | |
| 366 </tr> | |
| 367 <tr> | |
| 368 <td><a href="#Hg.hgShowPaths">hgShowPaths</a></td> | |
| 369 <td>Public method to show the path aliases for remote repositories.</td> | |
| 370 </tr> | |
| 371 <tr> | |
| 372 <td><a href="#Hg.hgSummary">hgSummary</a></td> | |
| 373 <td>Public method used to show some summary information of the working directory state.</td> | |
| 374 </tr> | |
| 375 <tr> | |
| 376 <td><a href="#Hg.hgUnbundle">hgUnbundle</a></td> | |
| 377 <td>Public method to apply changegroup files.</td> | |
| 378 </tr> | |
| 379 <tr> | |
| 380 <td><a href="#Hg.hgVerify">hgVerify</a></td> | |
| 381 <td>Public method to verify the integrity of the repository.</td> | |
| 382 </tr> | |
| 383 <tr> | |
| 384 <td><a href="#Hg.initCommand">initCommand</a></td> | |
| 385 <td>Public method to initialize a command arguments list.</td> | |
| 386 </tr> | |
| 387 <tr> | |
| 388 <td><a href="#Hg.isExtensionActive">isExtensionActive</a></td> | |
| 389 <td>Public method to check, if an extension is active.</td> | |
| 390 </tr> | |
| 391 <tr> | |
| 392 <td><a href="#Hg.stopClient">stopClient</a></td> | |
| 393 <td>Public method to stop the command server client.</td> | |
| 394 </tr> | |
| 395 <tr> | |
| 396 <td><a href="#Hg.vcsAdd">vcsAdd</a></td> | |
| 397 <td>Public method used to add a file/directory to the Mercurial repository.</td> | |
| 398 </tr> | |
| 399 <tr> | |
| 400 <td><a href="#Hg.vcsAddBinary">vcsAddBinary</a></td> | |
| 401 <td>Public method used to add a file/directory in binary mode to the Mercurial repository.</td> | |
| 402 </tr> | |
| 403 <tr> | |
| 404 <td><a href="#Hg.vcsAddCommitMessage">vcsAddCommitMessage</a></td> | |
| 405 <td>Public method to add a commit message to the list of saved messages.</td> | |
| 406 </tr> | |
| 407 <tr> | |
| 408 <td><a href="#Hg.vcsAddTree">vcsAddTree</a></td> | |
| 409 <td>Public method to add a directory tree rooted at path to the Mercurial repository.</td> | |
| 410 </tr> | |
| 411 <tr> | |
| 412 <td><a href="#Hg.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td> | |
| 413 <td>Public method used to get the registered states of a number of files in the vcs.</td> | |
| 414 </tr> | |
| 415 <tr> | |
| 416 <td><a href="#Hg.vcsCheckout">vcsCheckout</a></td> | |
| 417 <td>Public method used to check the project out of a Mercurial repository (clone).</td> | |
| 418 </tr> | |
| 419 <tr> | |
| 420 <td><a href="#Hg.vcsCleanup">vcsCleanup</a></td> | |
| 421 <td>Public method used to cleanup the working directory.</td> | |
| 422 </tr> | |
| 423 <tr> | |
| 424 <td><a href="#Hg.vcsClearCommitMessages">vcsClearCommitMessages</a></td> | |
| 425 <td>Public method to clear the list of saved messages.</td> | |
| 426 </tr> | |
| 427 <tr> | |
| 428 <td><a href="#Hg.vcsCommandLine">vcsCommandLine</a></td> | |
| 429 <td>Public method used to execute arbitrary mercurial commands.</td> | |
| 430 </tr> | |
| 431 <tr> | |
| 432 <td><a href="#Hg.vcsCommit">vcsCommit</a></td> | |
| 433 <td>Public method used to make the change of a file/directory permanent in the Mercurial repository.</td> | |
| 434 </tr> | |
| 435 <tr> | |
| 436 <td><a href="#Hg.vcsCommitMessages">vcsCommitMessages</a></td> | |
| 437 <td>Public method to get the list of saved commit messages.</td> | |
| 438 </tr> | |
| 439 <tr> | |
| 440 <td><a href="#Hg.vcsConvertProject">vcsConvertProject</a></td> | |
| 441 <td>Public method to convert an uncontrolled project to a version controlled project.</td> | |
| 442 </tr> | |
| 443 <tr> | |
| 444 <td><a href="#Hg.vcsDiff">vcsDiff</a></td> | |
| 445 <td>Public method used to view the difference of a file/directory to the Mercurial repository.</td> | |
| 446 </tr> | |
| 447 <tr> | |
| 448 <td><a href="#Hg.vcsExists">vcsExists</a></td> | |
| 449 <td>Public method used to test for the presence of the hg executable.</td> | |
| 450 </tr> | |
| 451 <tr> | |
| 452 <td><a href="#Hg.vcsExport">vcsExport</a></td> | |
| 453 <td>Public method used to export a directory from the Mercurial repository.</td> | |
| 454 </tr> | |
| 455 <tr> | |
| 456 <td><a href="#Hg.vcsForget">vcsForget</a></td> | |
| 457 <td>Public method used to remove a file from the Mercurial repository.</td> | |
| 458 </tr> | |
| 459 <tr> | |
| 460 <td><a href="#Hg.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td> | |
| 461 <td>Public method to instantiate a helper object for the different project browsers.</td> | |
| 462 </tr> | |
| 463 <tr> | |
| 464 <td><a href="#Hg.vcsGetProjectHelper">vcsGetProjectHelper</a></td> | |
| 465 <td>Public method to instantiate a helper object for the project.</td> | |
| 466 </tr> | |
| 467 <tr> | |
| 468 <td><a href="#Hg.vcsImport">vcsImport</a></td> | |
| 469 <td>Public method used to import the project into the Mercurial repository.</td> | |
| 470 </tr> | |
| 471 <tr> | |
| 472 <td><a href="#Hg.vcsInit">vcsInit</a></td> | |
| 473 <td>Public method used to initialize the mercurial repository.</td> | |
| 474 </tr> | |
| 475 <tr> | |
| 476 <td><a href="#Hg.vcsInitConfig">vcsInitConfig</a></td> | |
| 477 <td>Public method to initialize the VCS configuration.</td> | |
| 478 </tr> | |
| 479 <tr> | |
| 480 <td><a href="#Hg.vcsLogBrowser">vcsLogBrowser</a></td> | |
| 481 <td>Public method used to browse the log of a file/directory from the Mercurial repository.</td> | |
| 482 </tr> | |
| 483 <tr> | |
| 484 <td><a href="#Hg.vcsMerge">vcsMerge</a></td> | |
| 485 <td>Public method used to merge a URL/revision into the local project.</td> | |
| 486 </tr> | |
| 487 <tr> | |
| 488 <td><a href="#Hg.vcsMove">vcsMove</a></td> | |
| 489 <td>Public method used to move a file/directory.</td> | |
| 490 </tr> | |
| 491 <tr> | |
| 492 <td><a href="#Hg.vcsName">vcsName</a></td> | |
| 493 <td>Public method returning the name of the vcs.</td> | |
| 494 </tr> | |
| 495 <tr> | |
| 496 <td><a href="#Hg.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td> | |
| 497 <td>Public method to get a dialog to enter repository info for getting a new project.</td> | |
| 498 </tr> | |
| 499 <tr> | |
| 500 <td><a href="#Hg.vcsOptionsDialog">vcsOptionsDialog</a></td> | |
| 501 <td>Public method to get a dialog to enter repository info.</td> | |
| 502 </tr> | |
| 503 <tr> | |
| 504 <td><a href="#Hg.vcsRegisteredState">vcsRegisteredState</a></td> | |
| 505 <td>Public method used to get the registered state of a file in the vcs.</td> | |
| 506 </tr> | |
| 507 <tr> | |
| 508 <td><a href="#Hg.vcsRemove">vcsRemove</a></td> | |
| 509 <td>Public method used to remove a file/directory from the Mercurial repository.</td> | |
| 510 </tr> | |
| 511 <tr> | |
| 512 <td><a href="#Hg.vcsRepositoryInfos">vcsRepositoryInfos</a></td> | |
| 513 <td>Public method to retrieve information about the repository.</td> | |
| 514 </tr> | |
| 515 <tr> | |
| 516 <td><a href="#Hg.vcsResolved">vcsResolved</a></td> | |
| 517 <td>Public method used to resolve conflicts of a file/directory.</td> | |
| 518 </tr> | |
| 519 <tr> | |
| 520 <td><a href="#Hg.vcsRevert">vcsRevert</a></td> | |
| 521 <td>Public method used to revert changes made to a file/directory.</td> | |
| 522 </tr> | |
| 523 <tr> | |
| 524 <td><a href="#Hg.vcsSbsDiff">vcsSbsDiff</a></td> | |
| 525 <td>Public method used to view the difference of a file to the Mercurial repository side-by-side.</td> | |
| 526 </tr> | |
| 527 <tr> | |
| 528 <td><a href="#Hg.vcsShutdown">vcsShutdown</a></td> | |
| 529 <td>Public method used to shutdown the Mercurial interface.</td> | |
| 530 </tr> | |
| 531 <tr> | |
| 532 <td><a href="#Hg.vcsStatus">vcsStatus</a></td> | |
| 533 <td>Public method used to view the status of files/directories in the Mercurial repository.</td> | |
| 534 </tr> | |
| 535 <tr> | |
| 536 <td><a href="#Hg.vcsSupportCommandOptions">vcsSupportCommandOptions</a></td> | |
| 537 <td>Public method to signal the support of user settable command options.</td> | |
| 538 </tr> | |
| 539 <tr> | |
| 540 <td><a href="#Hg.vcsSwitch">vcsSwitch</a></td> | |
| 541 <td>Public method used to switch a working directory to a different revision.</td> | |
| 542 </tr> | |
| 543 <tr> | |
| 544 <td><a href="#Hg.vcsTag">vcsTag</a></td> | |
| 545 <td>Public method used to set/remove a tag in the Mercurial repository.</td> | |
| 546 </tr> | |
| 547 <tr> | |
| 548 <td><a href="#Hg.vcsUpdate">vcsUpdate</a></td> | |
| 549 <td>Public method used to update a file/directory with the Mercurial repository.</td> | |
| 550 </tr> | |
| 551 </table> | |
| 552 <h3>Static Methods</h3> | |
| 553 | |
| 554 <table> | |
| 555 <tr><td>None</td></tr> | |
| 556 </table> | |
| 557 | |
| 558 <a NAME="Hg.__init__" ID="Hg.__init__"></a> | |
| 559 <h4>Hg (Constructor)</h4> | |
| 560 <b>Hg</b>(<i>plugin, parent=None, name=None</i>) | |
| 561 | |
| 562 <p> | |
| 563 Constructor | |
| 564 </p> | |
| 565 <dl> | |
| 566 | |
| 567 <dt><i>plugin</i></dt> | |
| 568 <dd> | |
| 569 reference to the plugin object | |
| 570 </dd> | |
| 571 <dt><i>parent</i></dt> | |
| 572 <dd> | |
| 573 parent widget (QWidget) | |
| 574 </dd> | |
| 575 <dt><i>name</i></dt> | |
| 576 <dd> | |
| 577 name of this object (string) | |
| 578 </dd> | |
| 579 </dl> | |
| 580 <a NAME="Hg.__checkDefaults" ID="Hg.__checkDefaults"></a> | |
| 581 <h4>Hg.__checkDefaults</h4> | |
| 582 <b>__checkDefaults</b>(<i></i>) | |
| 583 | |
| 584 <p> | |
| 585 Private method to check, if the default and default-push URLs | |
| 586 have been configured. | |
| 587 </p> | |
| 588 <a NAME="Hg.__createClient" ID="Hg.__createClient"></a> | |
| 589 <h4>Hg.__createClient</h4> | |
| 590 <b>__createClient</b>(<i>repodir=""</i>) | |
| 591 | |
| 592 <p> | |
| 593 Private method to create a Mercurial command server client. | |
| 594 </p> | |
| 595 <dl> | |
| 596 | |
| 597 <dt><i>repodir</i> (str)</dt> | |
| 598 <dd> | |
| 599 path of the local repository | |
| 600 </dd> | |
| 601 </dl> | |
| 602 <a NAME="Hg.__getExtensionsInfo" ID="Hg.__getExtensionsInfo"></a> | |
| 603 <h4>Hg.__getExtensionsInfo</h4> | |
| 604 <b>__getExtensionsInfo</b>(<i></i>) | |
| 605 | |
| 606 <p> | |
| 607 Private method to get the active extensions from Mercurial. | |
| 608 </p> | |
| 609 <a NAME="Hg.__getInOutBookmarks" ID="Hg.__getInOutBookmarks"></a> | |
| 610 <h4>Hg.__getInOutBookmarks</h4> | |
| 611 <b>__getInOutBookmarks</b>(<i>incoming</i>) | |
| 612 | |
| 613 <p> | |
| 614 Private method to get the list of incoming or outgoing bookmarks. | |
| 615 </p> | |
| 616 <dl> | |
| 617 | |
| 618 <dt><i>incoming</i></dt> | |
| 619 <dd> | |
| 620 flag indicating to get incoming bookmarks (boolean) | |
| 621 </dd> | |
| 622 </dl> | |
| 623 <dl> | |
| 624 <dt>Return:</dt> | |
| 625 <dd> | |
| 626 list of bookmarks (list of string) | |
| 627 </dd> | |
| 628 </dl> | |
| 629 <a NAME="Hg.__getMostRecentCommitMessage" ID="Hg.__getMostRecentCommitMessage"></a> | |
| 630 <h4>Hg.__getMostRecentCommitMessage</h4> | |
| 631 <b>__getMostRecentCommitMessage</b>(<i></i>) | |
| 632 | |
| 633 <p> | |
| 634 Private method to get the most recent commit message. | |
| 635 </p> | |
| 636 <p> | |
| 637 Note: This message is extracted from the parent commit of the | |
| 638 working directory. | |
| 639 </p> | |
| 640 <dl> | |
| 641 <dt>Return:</dt> | |
| 642 <dd> | |
| 643 most recent commit message | |
| 644 </dd> | |
| 645 </dl> | |
| 646 <dl> | |
| 647 <dt>Return Type:</dt> | |
| 648 <dd> | |
| 649 str | |
| 650 </dd> | |
| 651 </dl> | |
| 652 <a NAME="Hg.__hgGetFileForRevision" ID="Hg.__hgGetFileForRevision"></a> | |
| 653 <h4>Hg.__hgGetFileForRevision</h4> | |
| 654 <b>__hgGetFileForRevision</b>(<i>name, rev=""</i>) | |
| 655 | |
| 656 <p> | |
| 657 Private method to get a file for a specific revision from the | |
| 658 repository. | |
| 659 </p> | |
| 660 <dl> | |
| 661 | |
| 662 <dt><i>name</i></dt> | |
| 663 <dd> | |
| 664 file name to get from the repository (string) | |
| 665 </dd> | |
| 666 <dt><i>rev</i></dt> | |
| 667 <dd> | |
| 668 revision to retrieve (string) | |
| 669 </dd> | |
| 670 </dl> | |
| 671 <dl> | |
| 672 <dt>Return:</dt> | |
| 673 <dd> | |
| 674 contents of the file (string) and an error message (string) | |
| 675 </dd> | |
| 676 </dl> | |
| 677 <a NAME="Hg.__hgGraftSubCommand" ID="Hg.__hgGraftSubCommand"></a> | |
| 678 <h4>Hg.__hgGraftSubCommand</h4> | |
| 679 <b>__hgGraftSubCommand</b>(<i>subcommand, title</i>) | |
| 680 | |
| 681 <p> | |
| 682 Private method to perform a Mercurial graft subcommand. | |
| 683 </p> | |
| 684 <dl> | |
| 685 | |
| 686 <dt><i>subcommand</i> (str)</dt> | |
| 687 <dd> | |
| 688 subcommand flag | |
| 689 </dd> | |
| 690 <dt><i>title</i> (str)</dt> | |
| 691 <dd> | |
| 692 tirle of the dialog | |
| 693 </dd> | |
| 694 </dl> | |
| 695 <dl> | |
| 696 <dt>Return:</dt> | |
| 697 <dd> | |
| 698 flag indicating that the project should be reread | |
| 699 </dd> | |
| 700 </dl> | |
| 701 <dl> | |
| 702 <dt>Return Type:</dt> | |
| 703 <dd> | |
| 704 bool | |
| 705 </dd> | |
| 706 </dl> | |
| 707 <a NAME="Hg.__iniFileChanged" ID="Hg.__iniFileChanged"></a> | |
| 708 <h4>Hg.__iniFileChanged</h4> | |
| 709 <b>__iniFileChanged</b>(<i>path</i>) | |
| 710 | |
| 711 <p> | |
| 712 Private slot to handle a change of the Mercurial configuration file. | |
| 713 </p> | |
| 714 <dl> | |
| 715 | |
| 716 <dt><i>path</i></dt> | |
| 717 <dd> | |
| 718 name of the changed file (string) | |
| 719 </dd> | |
| 720 </dl> | |
| 721 <a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a> | |
| 722 <h4>Hg.__monitorRepoIniFile</h4> | |
| 723 <b>__monitorRepoIniFile</b>(<i>repodir</i>) | |
| 724 | |
| 725 <p> | |
| 726 Private slot to add a repository configuration file to the list of | |
| 727 monitored files. | |
| 728 </p> | |
| 729 <dl> | |
| 730 | |
| 731 <dt><i>repodir</i> (str)</dt> | |
| 732 <dd> | |
| 733 directory name of the repository | |
| 734 </dd> | |
| 735 </dl> | |
| 736 <a NAME="Hg.__vcsCommit_Step2" ID="Hg.__vcsCommit_Step2"></a> | |
| 737 <h4>Hg.__vcsCommit_Step2</h4> | |
| 738 <b>__vcsCommit_Step2</b>(<i></i>) | |
| 739 | |
| 740 <p> | |
| 741 Private slot performing the second step of the commit action. | |
| 742 </p> | |
| 743 <a NAME="Hg._createStatusMonitorThread" ID="Hg._createStatusMonitorThread"></a> | |
| 744 <h4>Hg._createStatusMonitorThread</h4> | |
| 745 <b>_createStatusMonitorThread</b>(<i>interval, project</i>) | |
| 746 | |
| 747 <p> | |
| 748 Protected method to create an instance of the VCS status monitor | |
| 749 thread. | |
| 750 </p> | |
| 751 <dl> | |
| 752 | |
| 753 <dt><i>interval</i></dt> | |
| 754 <dd> | |
| 755 check interval for the monitor thread in seconds | |
| 756 (integer) | |
| 757 </dd> | |
| 758 <dt><i>project</i></dt> | |
| 759 <dd> | |
| 760 reference to the project object (Project) | |
| 761 </dd> | |
| 762 </dl> | |
| 763 <dl> | |
| 764 <dt>Return:</dt> | |
| 765 <dd> | |
| 766 reference to the monitor thread (QThread) | |
| 767 </dd> | |
| 768 </dl> | |
| 769 <a NAME="Hg.canCommitMerge" ID="Hg.canCommitMerge"></a> | |
| 770 <h4>Hg.canCommitMerge</h4> | |
| 771 <b>canCommitMerge</b>(<i></i>) | |
| 772 | |
| 773 <p> | |
| 774 Public method to check, if the working directory is an uncommitted | |
| 775 merge. | |
| 776 </p> | |
| 777 <dl> | |
| 778 <dt>Return:</dt> | |
| 779 <dd> | |
| 780 flag indicating commit merge capability | |
| 781 </dd> | |
| 782 </dl> | |
| 783 <dl> | |
| 784 <dt>Return Type:</dt> | |
| 785 <dd> | |
| 786 bool | |
| 787 </dd> | |
| 788 </dl> | |
| 789 <a NAME="Hg.canPull" ID="Hg.canPull"></a> | |
| 790 <h4>Hg.canPull</h4> | |
| 791 <b>canPull</b>(<i></i>) | |
| 792 | |
| 793 <p> | |
| 794 Public method to check, if pull is possible. | |
| 795 </p> | |
| 796 <dl> | |
| 797 <dt>Return:</dt> | |
| 798 <dd> | |
| 799 flag indicating pull capability (boolean) | |
| 800 </dd> | |
| 801 </dl> | |
| 802 <a NAME="Hg.canPush" ID="Hg.canPush"></a> | |
| 803 <h4>Hg.canPush</h4> | |
| 804 <b>canPush</b>(<i></i>) | |
| 805 | |
| 806 <p> | |
| 807 Public method to check, if push is possible. | |
| 808 </p> | |
| 809 <dl> | |
| 810 <dt>Return:</dt> | |
| 811 <dd> | |
| 812 flag indicating push capability (boolean) | |
| 813 </dd> | |
| 814 </dl> | |
| 815 <a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a> | |
| 816 <h4>Hg.clearStatusCache</h4> | |
| 817 <b>clearStatusCache</b>(<i></i>) | |
| 818 | |
| 819 <p> | |
| 820 Public method to clear the status cache. | |
| 821 </p> | |
| 822 <a NAME="Hg.getClient" ID="Hg.getClient"></a> | |
| 823 <h4>Hg.getClient</h4> | |
| 824 <b>getClient</b>(<i></i>) | |
| 825 | |
| 826 <p> | |
| 827 Public method to get a reference to the command server interface. | |
| 828 </p> | |
| 829 <dl> | |
| 830 <dt>Return:</dt> | |
| 831 <dd> | |
| 832 reference to the client (HgClient) | |
| 833 </dd> | |
| 834 </dl> | |
| 835 <a NAME="Hg.getEncoding" ID="Hg.getEncoding"></a> | |
| 836 <h4>Hg.getEncoding</h4> | |
| 837 <b>getEncoding</b>(<i></i>) | |
| 838 | |
| 839 <p> | |
| 840 Public method to get the encoding to be used by Mercurial. | |
| 841 </p> | |
| 842 <dl> | |
| 843 <dt>Return:</dt> | |
| 844 <dd> | |
| 845 encoding (string) | |
| 846 </dd> | |
| 847 </dl> | |
| 848 <a NAME="Hg.getExtensionObject" ID="Hg.getExtensionObject"></a> | |
| 849 <h4>Hg.getExtensionObject</h4> | |
| 850 <b>getExtensionObject</b>(<i>extensionName</i>) | |
| 851 | |
| 852 <p> | |
| 853 Public method to get a reference to an extension object. | |
| 854 </p> | |
| 855 <dl> | |
| 856 | |
| 857 <dt><i>extensionName</i></dt> | |
| 858 <dd> | |
| 859 name of the extension (string) | |
| 860 </dd> | |
| 861 </dl> | |
| 862 <dl> | |
| 863 <dt>Return:</dt> | |
| 864 <dd> | |
| 865 reference to the extension object (boolean) | |
| 866 </dd> | |
| 867 </dl> | |
| 868 <a NAME="Hg.getHgSubPath" ID="Hg.getHgSubPath"></a> | |
| 869 <h4>Hg.getHgSubPath</h4> | |
| 870 <b>getHgSubPath</b>(<i></i>) | |
| 871 | |
| 872 <p> | |
| 873 Public method to get the path to the .hgsub file containing the | |
| 874 definitions of sub-repositories. | |
| 875 </p> | |
| 876 <dl> | |
| 877 <dt>Return:</dt> | |
| 878 <dd> | |
| 879 full path of the .hgsub file (string) | |
| 880 </dd> | |
| 881 </dl> | |
| 882 <a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a> | |
| 883 <h4>Hg.getPlugin</h4> | |
| 884 <b>getPlugin</b>(<i></i>) | |
| 885 | |
| 886 <p> | |
| 887 Public method to get a reference to the plugin object. | |
| 888 </p> | |
| 889 <dl> | |
| 890 <dt>Return:</dt> | |
| 891 <dd> | |
| 892 reference to the plugin object (VcsMercurialPlugin) | |
| 893 </dd> | |
| 894 </dl> | |
| 895 <a NAME="Hg.hasSubrepositories" ID="Hg.hasSubrepositories"></a> | |
| 896 <h4>Hg.hasSubrepositories</h4> | |
| 897 <b>hasSubrepositories</b>(<i></i>) | |
| 898 | |
| 899 <p> | |
| 900 Public method to check, if the project might have sub-repositories. | |
| 901 </p> | |
| 902 <dl> | |
| 903 <dt>Return:</dt> | |
| 904 <dd> | |
| 905 flag indicating the existence of sub-repositories (boolean) | |
| 906 </dd> | |
| 907 </dl> | |
| 908 <a NAME="Hg.hgAbortMerge" ID="Hg.hgAbortMerge"></a> | |
| 909 <h4>Hg.hgAbortMerge</h4> | |
| 910 <b>hgAbortMerge</b>(<i></i>) | |
| 911 | |
| 912 <p> | |
| 913 Public method to abort an uncommitted merge. | |
| 914 </p> | |
| 915 <dl> | |
| 916 <dt>Return:</dt> | |
| 917 <dd> | |
| 918 flag indicating, that the abortion contained an add | |
| 919 or delete (boolean) | |
| 920 </dd> | |
| 921 </dl> | |
| 922 <a NAME="Hg.hgAddSubrepository" ID="Hg.hgAddSubrepository"></a> | |
| 923 <h4>Hg.hgAddSubrepository</h4> | |
| 924 <b>hgAddSubrepository</b>(<i></i>) | |
| 925 | |
| 926 <p> | |
| 927 Public method to add a sub-repository. | |
| 928 </p> | |
| 929 <a NAME="Hg.hgAnnotate" ID="Hg.hgAnnotate"></a> | |
| 930 <h4>Hg.hgAnnotate</h4> | |
| 931 <b>hgAnnotate</b>(<i>name</i>) | |
| 932 | |
| 933 <p> | |
| 934 Public method to show the output of the hg annotate command. | |
| 935 </p> | |
| 936 <dl> | |
| 937 | |
| 938 <dt><i>name</i></dt> | |
| 939 <dd> | |
| 940 file name to show the annotations for (string) | |
| 941 </dd> | |
| 942 </dl> | |
| 943 <a NAME="Hg.hgArchive" ID="Hg.hgArchive"></a> | |
| 944 <h4>Hg.hgArchive</h4> | |
| 945 <b>hgArchive</b>(<i></i>) | |
| 946 | |
| 947 <p> | |
| 948 Public method to create an unversioned archive from the repository. | |
| 949 </p> | |
| 950 <a NAME="Hg.hgBackout" ID="Hg.hgBackout"></a> | |
| 951 <h4>Hg.hgBackout</h4> | |
| 952 <b>hgBackout</b>(<i></i>) | |
| 953 | |
| 954 <p> | |
| 955 Public method used to backout an earlier changeset from the Mercurial | |
| 956 repository. | |
| 957 </p> | |
| 958 <a NAME="Hg.hgBisect" ID="Hg.hgBisect"></a> | |
| 959 <h4>Hg.hgBisect</h4> | |
| 960 <b>hgBisect</b>(<i>subcommand</i>) | |
| 961 | |
| 962 <p> | |
| 963 Public method to perform bisect commands. | |
| 964 </p> | |
| 965 <dl> | |
| 966 | |
| 967 <dt><i>subcommand</i> (str)</dt> | |
| 968 <dd> | |
| 969 name of the subcommand (one of 'good', 'bad', | |
| 970 'skip' or 'reset') | |
| 971 </dd> | |
| 972 </dl> | |
| 973 <dl> | |
| 974 | |
| 975 <dt>Raises <b>ValueError</b>:</dt> | |
| 976 <dd> | |
| 977 raised to indicate an invalid bisect subcommand | |
| 978 </dd> | |
| 979 </dl> | |
| 980 <a NAME="Hg.hgBookmarkDefine" ID="Hg.hgBookmarkDefine"></a> | |
| 981 <h4>Hg.hgBookmarkDefine</h4> | |
| 982 <b>hgBookmarkDefine</b>(<i>revision=None, bookmark=None</i>) | |
| 983 | |
| 984 <p> | |
| 985 Public method to define a bookmark. | |
| 986 </p> | |
| 987 <dl> | |
| 988 | |
| 989 <dt><i>revision</i></dt> | |
| 990 <dd> | |
| 991 revision to set bookmark for (string) | |
| 992 </dd> | |
| 993 <dt><i>bookmark</i></dt> | |
| 994 <dd> | |
| 995 name of the bookmark (string) | |
| 996 </dd> | |
| 997 </dl> | |
| 998 <a NAME="Hg.hgBookmarkDelete" ID="Hg.hgBookmarkDelete"></a> | |
| 999 <h4>Hg.hgBookmarkDelete</h4> | |
| 1000 <b>hgBookmarkDelete</b>(<i>bookmark=None</i>) | |
| 1001 | |
| 1002 <p> | |
| 1003 Public method to delete a bookmark. | |
| 1004 </p> | |
| 1005 <dl> | |
| 1006 | |
| 1007 <dt><i>bookmark</i></dt> | |
| 1008 <dd> | |
| 1009 name of the bookmark (string) | |
| 1010 </dd> | |
| 1011 </dl> | |
| 1012 <a NAME="Hg.hgBookmarkIncoming" ID="Hg.hgBookmarkIncoming"></a> | |
| 1013 <h4>Hg.hgBookmarkIncoming</h4> | |
| 1014 <b>hgBookmarkIncoming</b>(<i></i>) | |
| 1015 | |
| 1016 <p> | |
| 1017 Public method to show a list of incoming bookmarks. | |
| 1018 </p> | |
| 1019 <a NAME="Hg.hgBookmarkMove" ID="Hg.hgBookmarkMove"></a> | |
| 1020 <h4>Hg.hgBookmarkMove</h4> | |
| 1021 <b>hgBookmarkMove</b>(<i>revision=None, bookmark=None</i>) | |
| 1022 | |
| 1023 <p> | |
| 1024 Public method to move a bookmark. | |
| 1025 </p> | |
| 1026 <dl> | |
| 1027 | |
| 1028 <dt><i>revision</i></dt> | |
| 1029 <dd> | |
| 1030 revision to set bookmark for (string) | |
| 1031 </dd> | |
| 1032 <dt><i>bookmark</i></dt> | |
| 1033 <dd> | |
| 1034 name of the bookmark (string) | |
| 1035 </dd> | |
| 1036 </dl> | |
| 1037 <a NAME="Hg.hgBookmarkOutgoing" ID="Hg.hgBookmarkOutgoing"></a> | |
| 1038 <h4>Hg.hgBookmarkOutgoing</h4> | |
| 1039 <b>hgBookmarkOutgoing</b>(<i></i>) | |
| 1040 | |
| 1041 <p> | |
| 1042 Public method to show a list of outgoing bookmarks. | |
| 1043 </p> | |
| 1044 <a NAME="Hg.hgBookmarkPull" ID="Hg.hgBookmarkPull"></a> | |
| 1045 <h4>Hg.hgBookmarkPull</h4> | |
| 1046 <b>hgBookmarkPull</b>(<i>current=False, bookmark=None</i>) | |
| 1047 | |
| 1048 <p> | |
| 1049 Public method to pull a bookmark from a remote repository. | |
| 1050 </p> | |
| 1051 <dl> | |
| 1052 | |
| 1053 <dt><i>current</i> (bool)</dt> | |
| 1054 <dd> | |
| 1055 flag indicating to pull the current bookmark | |
| 1056 </dd> | |
| 1057 <dt><i>bookmark</i> (str)</dt> | |
| 1058 <dd> | |
| 1059 name of the bookmark | |
| 1060 </dd> | |
| 1061 </dl> | |
| 1062 <a NAME="Hg.hgBookmarkPush" ID="Hg.hgBookmarkPush"></a> | |
| 1063 <h4>Hg.hgBookmarkPush</h4> | |
| 1064 <b>hgBookmarkPush</b>(<i>current=False, bookmark=None, allBookmarks=False</i>) | |
| 1065 | |
| 1066 <p> | |
| 1067 Public method to push a bookmark to a remote repository. | |
| 1068 </p> | |
| 1069 <dl> | |
| 1070 | |
| 1071 <dt><i>current</i> (bool)</dt> | |
| 1072 <dd> | |
| 1073 flag indicating to push the current bookmark | |
| 1074 </dd> | |
| 1075 <dt><i>bookmark</i> (str)</dt> | |
| 1076 <dd> | |
| 1077 name of the bookmark | |
| 1078 </dd> | |
| 1079 <dt><i>allBookmarks</i> (bool)</dt> | |
| 1080 <dd> | |
| 1081 flag indicating to push all bookmarks | |
| 1082 </dd> | |
| 1083 </dl> | |
| 1084 <a NAME="Hg.hgBookmarkRename" ID="Hg.hgBookmarkRename"></a> | |
| 1085 <h4>Hg.hgBookmarkRename</h4> | |
| 1086 <b>hgBookmarkRename</b>(<i>renameInfo=None</i>) | |
| 1087 | |
| 1088 <p> | |
| 1089 Public method to rename a bookmark. | |
| 1090 </p> | |
| 1091 <dl> | |
| 1092 | |
| 1093 <dt><i>renameInfo</i> (tuple of str and str)</dt> | |
| 1094 <dd> | |
| 1095 old and new names of the bookmark | |
| 1096 </dd> | |
| 1097 </dl> | |
| 1098 <a NAME="Hg.hgBranch" ID="Hg.hgBranch"></a> | |
| 1099 <h4>Hg.hgBranch</h4> | |
| 1100 <b>hgBranch</b>(<i></i>) | |
| 1101 | |
| 1102 <p> | |
| 1103 Public method used to create a branch in the Mercurial repository. | |
| 1104 </p> | |
| 1105 <a NAME="Hg.hgBundle" ID="Hg.hgBundle"></a> | |
| 1106 <h4>Hg.hgBundle</h4> | |
| 1107 <b>hgBundle</b>(<i>bundleData=None</i>) | |
| 1108 | |
| 1109 <p> | |
| 1110 Public method to create a changegroup file. | |
| 1111 </p> | |
| 1112 <dl> | |
| 1113 | |
| 1114 <dt><i>bundleData</i> (dict)</dt> | |
| 1115 <dd> | |
| 1116 dictionary containing the bundle creation information | |
| 1117 </dd> | |
| 1118 </dl> | |
| 1119 <a NAME="Hg.hgConflicts" ID="Hg.hgConflicts"></a> | |
| 1120 <h4>Hg.hgConflicts</h4> | |
| 1121 <b>hgConflicts</b>(<i></i>) | |
| 1122 | |
| 1123 <p> | |
| 1124 Public method used to show a list of files containing conflicts. | |
| 1125 </p> | |
| 1126 <a NAME="Hg.hgCopy" ID="Hg.hgCopy"></a> | |
| 1127 <h4>Hg.hgCopy</h4> | |
| 1128 <b>hgCopy</b>(<i>name, project</i>) | |
| 1129 | |
| 1130 <p> | |
| 1131 Public method used to copy a file/directory. | |
| 1132 </p> | |
| 1133 <dl> | |
| 1134 | |
| 1135 <dt><i>name</i></dt> | |
| 1136 <dd> | |
| 1137 file/directory name to be copied (string) | |
| 1138 </dd> | |
| 1139 <dt><i>project</i></dt> | |
| 1140 <dd> | |
| 1141 reference to the project object | |
| 1142 </dd> | |
| 1143 </dl> | |
| 1144 <dl> | |
| 1145 <dt>Return:</dt> | |
| 1146 <dd> | |
| 1147 flag indicating successful operation (boolean) | |
| 1148 </dd> | |
| 1149 </dl> | |
| 1150 <a NAME="Hg.hgCreateIgnoreFile" ID="Hg.hgCreateIgnoreFile"></a> | |
| 1151 <h4>Hg.hgCreateIgnoreFile</h4> | |
| 1152 <b>hgCreateIgnoreFile</b>(<i>name, autoAdd=False</i>) | |
| 1153 | |
| 1154 <p> | |
| 1155 Public method to create the ignore file. | |
| 1156 </p> | |
| 1157 <dl> | |
| 1158 | |
| 1159 <dt><i>name</i></dt> | |
| 1160 <dd> | |
| 1161 directory name to create the ignore file in (string) | |
| 1162 </dd> | |
| 1163 <dt><i>autoAdd</i></dt> | |
| 1164 <dd> | |
| 1165 flag indicating to add it automatically (boolean) | |
| 1166 </dd> | |
| 1167 </dl> | |
| 1168 <dl> | |
| 1169 <dt>Return:</dt> | |
| 1170 <dd> | |
| 1171 flag indicating success | |
| 1172 </dd> | |
| 1173 </dl> | |
| 1174 <a NAME="Hg.hgDeleteBackups" ID="Hg.hgDeleteBackups"></a> | |
| 1175 <h4>Hg.hgDeleteBackups</h4> | |
| 1176 <b>hgDeleteBackups</b>(<i></i>) | |
| 1177 | |
| 1178 <p> | |
| 1179 Public method to delete all backup bundles in the backup area. | |
| 1180 </p> | |
| 1181 <a NAME="Hg.hgEditConfig" ID="Hg.hgEditConfig"></a> | |
| 1182 <h4>Hg.hgEditConfig</h4> | |
| 1183 <b>hgEditConfig</b>(<i>repoName=None, withLargefiles=True, largefilesData=None</i>) | |
| 1184 | |
| 1185 <p> | |
| 1186 Public method used to edit the repository configuration file. | |
| 1187 </p> | |
| 1188 <dl> | |
| 1189 | |
| 1190 <dt><i>repoName</i> (str)</dt> | |
| 1191 <dd> | |
| 1192 directory name containing the repository | |
| 1193 </dd> | |
| 1194 <dt><i>withLargefiles</i> (bool)</dt> | |
| 1195 <dd> | |
| 1196 flag indicating to configure the largefiles | |
| 1197 section | |
| 1198 </dd> | |
| 1199 <dt><i>largefilesData</i> (dict)</dt> | |
| 1200 <dd> | |
| 1201 dictionary with data for the largefiles | |
| 1202 section of the data dialog | |
| 1203 </dd> | |
| 1204 </dl> | |
| 1205 <a NAME="Hg.hgEditUserConfig" ID="Hg.hgEditUserConfig"></a> | |
| 1206 <h4>Hg.hgEditUserConfig</h4> | |
| 1207 <b>hgEditUserConfig</b>(<i></i>) | |
| 1208 | |
| 1209 <p> | |
| 1210 Public method used to edit the user configuration file. | |
| 1211 </p> | |
| 1212 <a NAME="Hg.hgExport" ID="Hg.hgExport"></a> | |
| 1213 <h4>Hg.hgExport</h4> | |
| 1214 <b>hgExport</b>(<i></i>) | |
| 1215 | |
| 1216 <p> | |
| 1217 Public method to export patches to files. | |
| 1218 </p> | |
| 1219 <a NAME="Hg.hgExtendedDiff" ID="Hg.hgExtendedDiff"></a> | |
| 1220 <h4>Hg.hgExtendedDiff</h4> | |
| 1221 <b>hgExtendedDiff</b>(<i>name</i>) | |
| 1222 | |
| 1223 <p> | |
| 1224 Public method used to view the difference of a file/directory to the | |
| 1225 Mercurial repository. | |
| 1226 </p> | |
| 1227 <p> | |
| 1228 If name is a directory and is the project directory, all project files | |
| 1229 are saved first. If name is a file (or list of files), which is/are | |
| 1230 being edited and has unsaved modification, they can be saved or the | |
| 1231 operation may be aborted. | |
| 1232 </p> | |
| 1233 <p> | |
| 1234 This method gives the chance to enter the revisions to be compared. | |
| 1235 </p> | |
| 1236 <dl> | |
| 1237 | |
| 1238 <dt><i>name</i></dt> | |
| 1239 <dd> | |
| 1240 file/directory name to be diffed (string) | |
| 1241 </dd> | |
| 1242 </dl> | |
| 1243 <a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a> | |
| 1244 <h4>Hg.hgGetBookmarksList</h4> | |
| 1245 <b>hgGetBookmarksList</b>(<i></i>) | |
| 1246 | |
| 1247 <p> | |
| 1248 Public method to get the list of bookmarks. | |
| 1249 </p> | |
| 1250 <dl> | |
| 1251 <dt>Return:</dt> | |
| 1252 <dd> | |
| 1253 list of bookmarks (list of string) | |
| 1254 </dd> | |
| 1255 </dl> | |
| 1256 <a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a> | |
| 1257 <h4>Hg.hgGetBranchesList</h4> | |
| 1258 <b>hgGetBranchesList</b>(<i></i>) | |
| 1259 | |
| 1260 <p> | |
| 1261 Public method to get the list of branches. | |
| 1262 </p> | |
| 1263 <dl> | |
| 1264 <dt>Return:</dt> | |
| 1265 <dd> | |
| 1266 list of branches (list of string) | |
| 1267 </dd> | |
| 1268 </dl> | |
| 1269 <a NAME="Hg.hgGetCurrentBranch" ID="Hg.hgGetCurrentBranch"></a> | |
| 1270 <h4>Hg.hgGetCurrentBranch</h4> | |
| 1271 <b>hgGetCurrentBranch</b>(<i></i>) | |
| 1272 | |
| 1273 <p> | |
| 1274 Public method to get the current branch of the working directory. | |
| 1275 </p> | |
| 1276 <dl> | |
| 1277 <dt>Return:</dt> | |
| 1278 <dd> | |
| 1279 name of the current branch | |
| 1280 </dd> | |
| 1281 </dl> | |
| 1282 <dl> | |
| 1283 <dt>Return Type:</dt> | |
| 1284 <dd> | |
| 1285 str | |
| 1286 </dd> | |
| 1287 </dl> | |
| 1288 <a NAME="Hg.hgGetTagsList" ID="Hg.hgGetTagsList"></a> | |
| 1289 <h4>Hg.hgGetTagsList</h4> | |
| 1290 <b>hgGetTagsList</b>(<i>withType=False</i>) | |
| 1291 | |
| 1292 <p> | |
| 1293 Public method to get the list of tags. | |
| 1294 </p> | |
| 1295 <dl> | |
| 1296 | |
| 1297 <dt><i>withType</i></dt> | |
| 1298 <dd> | |
| 1299 flag indicating to get the tag type as well (boolean) | |
| 1300 </dd> | |
| 1301 </dl> | |
| 1302 <dl> | |
| 1303 <dt>Return:</dt> | |
| 1304 <dd> | |
| 1305 list of tags (list of string) or list of tuples of | |
| 1306 tag name and flag indicating a local tag (list of tuple of string | |
| 1307 and boolean), if withType is True | |
| 1308 </dd> | |
| 1309 </dl> | |
| 1310 <a NAME="Hg.hgGraft" ID="Hg.hgGraft"></a> | |
| 1311 <h4>Hg.hgGraft</h4> | |
| 1312 <b>hgGraft</b>(<i>revs=None</i>) | |
| 1313 | |
| 1314 <p> | |
| 1315 Public method to copy changesets from another branch. | |
| 1316 </p> | |
| 1317 <dl> | |
| 1318 | |
| 1319 <dt><i>revs</i></dt> | |
| 1320 <dd> | |
| 1321 list of revisions to show in the revisions pane (list of | |
| 1322 strings) | |
| 1323 </dd> | |
| 1324 </dl> | |
| 1325 <dl> | |
| 1326 <dt>Return:</dt> | |
| 1327 <dd> | |
| 1328 flag indicating that the project should be reread (boolean) | |
| 1329 </dd> | |
| 1330 </dl> | |
| 1331 <a NAME="Hg.hgGraftAbort" ID="Hg.hgGraftAbort"></a> | |
| 1332 <h4>Hg.hgGraftAbort</h4> | |
| 1333 <b>hgGraftAbort</b>(<i>path</i>) | |
| 1334 | |
| 1335 <p> | |
| 1336 Public method to abort an interrupted copying session and perform | |
| 1337 a rollback. | |
| 1338 </p> | |
| 1339 <dl> | |
| 1340 | |
| 1341 <dt><i>path</i> (str)</dt> | |
| 1342 <dd> | |
| 1343 directory name of the project | |
| 1344 </dd> | |
| 1345 </dl> | |
| 1346 <dl> | |
| 1347 <dt>Return:</dt> | |
| 1348 <dd> | |
| 1349 flag indicating that the project should be reread | |
| 1350 </dd> | |
| 1351 </dl> | |
| 1352 <dl> | |
| 1353 <dt>Return Type:</dt> | |
| 1354 <dd> | |
| 1355 bool | |
| 1356 </dd> | |
| 1357 </dl> | |
| 1358 <a NAME="Hg.hgGraftContinue" ID="Hg.hgGraftContinue"></a> | |
| 1359 <h4>Hg.hgGraftContinue</h4> | |
| 1360 <b>hgGraftContinue</b>(<i>path</i>) | |
| 1361 | |
| 1362 <p> | |
| 1363 Public method to continue copying changesets from another branch. | |
| 1364 </p> | |
| 1365 <dl> | |
| 1366 | |
| 1367 <dt><i>path</i> (str)</dt> | |
| 1368 <dd> | |
| 1369 directory name of the project | |
| 1370 </dd> | |
| 1371 </dl> | |
| 1372 <dl> | |
| 1373 <dt>Return:</dt> | |
| 1374 <dd> | |
| 1375 flag indicating that the project should be reread | |
| 1376 </dd> | |
| 1377 </dl> | |
| 1378 <dl> | |
| 1379 <dt>Return Type:</dt> | |
| 1380 <dd> | |
| 1381 bool | |
| 1382 </dd> | |
| 1383 </dl> | |
| 1384 <a NAME="Hg.hgGraftStop" ID="Hg.hgGraftStop"></a> | |
| 1385 <h4>Hg.hgGraftStop</h4> | |
| 1386 <b>hgGraftStop</b>(<i>path</i>) | |
| 1387 | |
| 1388 <p> | |
| 1389 Public method to stop an interrupted copying session. | |
| 1390 </p> | |
| 1391 <dl> | |
| 1392 | |
| 1393 <dt><i>path</i> (str)</dt> | |
| 1394 <dd> | |
| 1395 directory name of the project | |
| 1396 </dd> | |
| 1397 </dl> | |
| 1398 <dl> | |
| 1399 <dt>Return:</dt> | |
| 1400 <dd> | |
| 1401 flag indicating that the project should be reread | |
| 1402 </dd> | |
| 1403 </dl> | |
| 1404 <dl> | |
| 1405 <dt>Return Type:</dt> | |
| 1406 <dd> | |
| 1407 bool | |
| 1408 </dd> | |
| 1409 </dl> | |
| 1410 <a NAME="Hg.hgIdentify" ID="Hg.hgIdentify"></a> | |
| 1411 <h4>Hg.hgIdentify</h4> | |
| 1412 <b>hgIdentify</b>(<i></i>) | |
| 1413 | |
| 1414 <p> | |
| 1415 Public method to identify the current working directory. | |
| 1416 </p> | |
| 1417 <a NAME="Hg.hgImport" ID="Hg.hgImport"></a> | |
| 1418 <h4>Hg.hgImport</h4> | |
| 1419 <b>hgImport</b>(<i></i>) | |
| 1420 | |
| 1421 <p> | |
| 1422 Public method to import a patch file. | |
| 1423 </p> | |
| 1424 <dl> | |
| 1425 <dt>Return:</dt> | |
| 1426 <dd> | |
| 1427 flag indicating, that the import contained an add, a delete | |
| 1428 or a change to the project file (boolean) | |
| 1429 </dd> | |
| 1430 </dl> | |
| 1431 <a NAME="Hg.hgIncoming" ID="Hg.hgIncoming"></a> | |
| 1432 <h4>Hg.hgIncoming</h4> | |
| 1433 <b>hgIncoming</b>(<i></i>) | |
| 1434 | |
| 1435 <p> | |
| 1436 Public method used to view the log of incoming changes from the | |
| 1437 Mercurial repository. | |
| 1438 </p> | |
| 1439 <a NAME="Hg.hgInfo" ID="Hg.hgInfo"></a> | |
| 1440 <h4>Hg.hgInfo</h4> | |
| 1441 <b>hgInfo</b>(<i>mode="heads"</i>) | |
| 1442 | |
| 1443 <p> | |
| 1444 Public method to show information about the heads of the repository. | |
| 1445 </p> | |
| 1446 <dl> | |
| 1447 | |
| 1448 <dt><i>mode</i></dt> | |
| 1449 <dd> | |
| 1450 mode of the operation (string, one of heads, parents, | |
| 1451 tip) | |
| 1452 </dd> | |
| 1453 </dl> | |
| 1454 <a NAME="Hg.hgListBookmarks" ID="Hg.hgListBookmarks"></a> | |
| 1455 <h4>Hg.hgListBookmarks</h4> | |
| 1456 <b>hgListBookmarks</b>(<i></i>) | |
| 1457 | |
| 1458 <p> | |
| 1459 Public method used to list the available bookmarks. | |
| 1460 </p> | |
| 1461 <a NAME="Hg.hgListTagBranch" ID="Hg.hgListTagBranch"></a> | |
| 1462 <h4>Hg.hgListTagBranch</h4> | |
| 1463 <b>hgListTagBranch</b>(<i>tags=True</i>) | |
| 1464 | |
| 1465 <p> | |
| 1466 Public method used to list the available tags or branches. | |
| 1467 </p> | |
| 1468 <dl> | |
| 1469 | |
| 1470 <dt><i>tags</i></dt> | |
| 1471 <dd> | |
| 1472 flag indicating listing of branches or tags | |
| 1473 (False = branches, True = tags) | |
| 1474 </dd> | |
| 1475 </dl> | |
| 1476 <a NAME="Hg.hgNormalizeURL" ID="Hg.hgNormalizeURL"></a> | |
| 1477 <h4>Hg.hgNormalizeURL</h4> | |
| 1478 <b>hgNormalizeURL</b>(<i>url</i>) | |
| 1479 | |
| 1480 <p> | |
| 1481 Public method to normalize a url for Mercurial. | |
| 1482 </p> | |
| 1483 <dl> | |
| 1484 | |
| 1485 <dt><i>url</i></dt> | |
| 1486 <dd> | |
| 1487 url string (string) | |
| 1488 </dd> | |
| 1489 </dl> | |
| 1490 <dl> | |
| 1491 <dt>Return:</dt> | |
| 1492 <dd> | |
| 1493 properly normalized url for mercurial (string) | |
| 1494 </dd> | |
| 1495 </dl> | |
| 1496 <a NAME="Hg.hgOutgoing" ID="Hg.hgOutgoing"></a> | |
| 1497 <h4>Hg.hgOutgoing</h4> | |
| 1498 <b>hgOutgoing</b>(<i></i>) | |
| 1499 | |
| 1500 <p> | |
| 1501 Public method used to view the log of outgoing changes from the | |
| 1502 Mercurial repository. | |
| 1503 </p> | |
| 1504 <a NAME="Hg.hgPhase" ID="Hg.hgPhase"></a> | |
| 1505 <h4>Hg.hgPhase</h4> | |
| 1506 <b>hgPhase</b>(<i>data=None</i>) | |
| 1507 | |
| 1508 <p> | |
| 1509 Public method to change the phase of revisions. | |
| 1510 </p> | |
| 1511 <dl> | |
| 1512 | |
| 1513 <dt><i>data</i></dt> | |
| 1514 <dd> | |
| 1515 tuple giving phase data (list of revisions, phase, flag | |
| 1516 indicating a forced operation) (list of strings, string, boolean) | |
| 1517 </dd> | |
| 1518 </dl> | |
| 1519 <dl> | |
| 1520 <dt>Return:</dt> | |
| 1521 <dd> | |
| 1522 flag indicating success (boolean) | |
| 1523 </dd> | |
| 1524 </dl> | |
| 1525 <dl> | |
| 1526 | |
| 1527 <dt>Raises <b>ValueError</b>:</dt> | |
| 1528 <dd> | |
| 1529 raised to indicate an invalid phase | |
| 1530 </dd> | |
| 1531 </dl> | |
| 1532 <a NAME="Hg.hgPreviewBundle" ID="Hg.hgPreviewBundle"></a> | |
| 1533 <h4>Hg.hgPreviewBundle</h4> | |
| 1534 <b>hgPreviewBundle</b>(<i></i>) | |
| 1535 | |
| 1536 <p> | |
| 1537 Public method used to view the log of incoming changes from a | |
| 1538 changegroup file. | |
| 1539 </p> | |
| 1540 <a NAME="Hg.hgPull" ID="Hg.hgPull"></a> | |
| 1541 <h4>Hg.hgPull</h4> | |
| 1542 <b>hgPull</b>(<i>revisions=None</i>) | |
| 1543 | |
| 1544 <p> | |
| 1545 Public method used to pull changes from a remote Mercurial repository. | |
| 1546 </p> | |
| 1547 <dl> | |
| 1548 | |
| 1549 <dt><i>revisions</i> (list of str)</dt> | |
| 1550 <dd> | |
| 1551 list of revisions to be pulled | |
| 1552 </dd> | |
| 1553 </dl> | |
| 1554 <dl> | |
| 1555 <dt>Return:</dt> | |
| 1556 <dd> | |
| 1557 flag indicating, that the update contained an add | |
| 1558 or delete | |
| 1559 </dd> | |
| 1560 </dl> | |
| 1561 <dl> | |
| 1562 <dt>Return Type:</dt> | |
| 1563 <dd> | |
| 1564 bool | |
| 1565 </dd> | |
| 1566 </dl> | |
| 1567 <a NAME="Hg.hgPush" ID="Hg.hgPush"></a> | |
| 1568 <h4>Hg.hgPush</h4> | |
| 1569 <b>hgPush</b>(<i>force=False, newBranch=False, rev=None</i>) | |
| 1570 | |
| 1571 <p> | |
| 1572 Public method used to push changes to a remote Mercurial repository. | |
| 1573 </p> | |
| 1574 <dl> | |
| 1575 | |
| 1576 <dt><i>force</i></dt> | |
| 1577 <dd> | |
| 1578 flag indicating a forced push (boolean) | |
| 1579 </dd> | |
| 1580 <dt><i>newBranch</i></dt> | |
| 1581 <dd> | |
| 1582 flag indicating to push a new branch (boolean) | |
| 1583 </dd> | |
| 1584 <dt><i>rev</i></dt> | |
| 1585 <dd> | |
| 1586 revision to be pushed (including all ancestors) (string) | |
| 1587 </dd> | |
| 1588 </dl> | |
| 1589 <a NAME="Hg.hgReMerge" ID="Hg.hgReMerge"></a> | |
| 1590 <h4>Hg.hgReMerge</h4> | |
| 1591 <b>hgReMerge</b>(<i>name</i>) | |
| 1592 | |
| 1593 <p> | |
| 1594 Public method used to merge a URL/revision into the local project. | |
| 1595 </p> | |
| 1596 <dl> | |
| 1597 | |
| 1598 <dt><i>name</i></dt> | |
| 1599 <dd> | |
| 1600 file/directory name to be merged (string) | |
| 1601 </dd> | |
| 1602 </dl> | |
| 1603 <a NAME="Hg.hgRecover" ID="Hg.hgRecover"></a> | |
| 1604 <h4>Hg.hgRecover</h4> | |
| 1605 <b>hgRecover</b>(<i></i>) | |
| 1606 | |
| 1607 <p> | |
| 1608 Public method to recover an interrupted transaction. | |
| 1609 </p> | |
| 1610 <a NAME="Hg.hgRemoveSubrepositories" ID="Hg.hgRemoveSubrepositories"></a> | |
| 1611 <h4>Hg.hgRemoveSubrepositories</h4> | |
| 1612 <b>hgRemoveSubrepositories</b>(<i></i>) | |
| 1613 | |
| 1614 <p> | |
| 1615 Public method to remove sub-repositories. | |
| 1616 </p> | |
| 1617 <a NAME="Hg.hgRollback" ID="Hg.hgRollback"></a> | |
| 1618 <h4>Hg.hgRollback</h4> | |
| 1619 <b>hgRollback</b>(<i></i>) | |
| 1620 | |
| 1621 <p> | |
| 1622 Public method used to rollback the last transaction. | |
| 1623 </p> | |
| 1624 <a NAME="Hg.hgServe" ID="Hg.hgServe"></a> | |
| 1625 <h4>Hg.hgServe</h4> | |
| 1626 <b>hgServe</b>(<i>repoPath</i>) | |
| 1627 | |
| 1628 <p> | |
| 1629 Public method used to serve the project. | |
| 1630 </p> | |
| 1631 <dl> | |
| 1632 | |
| 1633 <dt><i>repoPath</i> (str)</dt> | |
| 1634 <dd> | |
| 1635 directory containing the repository | |
| 1636 </dd> | |
| 1637 </dl> | |
| 1638 <a NAME="Hg.hgShowBranch" ID="Hg.hgShowBranch"></a> | |
| 1639 <h4>Hg.hgShowBranch</h4> | |
| 1640 <b>hgShowBranch</b>(<i></i>) | |
| 1641 | |
| 1642 <p> | |
| 1643 Public method used to show the current branch of the working directory. | |
| 1644 </p> | |
| 1645 <a NAME="Hg.hgShowConfig" ID="Hg.hgShowConfig"></a> | |
| 1646 <h4>Hg.hgShowConfig</h4> | |
| 1647 <b>hgShowConfig</b>(<i></i>) | |
| 1648 | |
| 1649 <p> | |
| 1650 Public method to show the combined configuration. | |
| 1651 </p> | |
| 1652 <a NAME="Hg.hgShowPaths" ID="Hg.hgShowPaths"></a> | |
| 1653 <h4>Hg.hgShowPaths</h4> | |
| 1654 <b>hgShowPaths</b>(<i></i>) | |
| 1655 | |
| 1656 <p> | |
| 1657 Public method to show the path aliases for remote repositories. | |
| 1658 </p> | |
| 1659 <a NAME="Hg.hgSummary" ID="Hg.hgSummary"></a> | |
| 1660 <h4>Hg.hgSummary</h4> | |
| 1661 <b>hgSummary</b>(<i>mq=False, largefiles=False</i>) | |
| 1662 | |
| 1663 <p> | |
| 1664 Public method used to show some summary information of the | |
| 1665 working directory state. | |
| 1666 </p> | |
| 1667 <dl> | |
| 1668 | |
| 1669 <dt><i>mq</i></dt> | |
| 1670 <dd> | |
| 1671 flag indicating to show the queue status as well (boolean) | |
| 1672 </dd> | |
| 1673 <dt><i>largefiles</i></dt> | |
| 1674 <dd> | |
| 1675 flag indicating to show the largefiles status as | |
| 1676 well (boolean) | |
| 1677 </dd> | |
| 1678 </dl> | |
| 1679 <a NAME="Hg.hgUnbundle" ID="Hg.hgUnbundle"></a> | |
| 1680 <h4>Hg.hgUnbundle</h4> | |
| 1681 <b>hgUnbundle</b>(<i>files=None</i>) | |
| 1682 | |
| 1683 <p> | |
| 1684 Public method to apply changegroup files. | |
| 1685 </p> | |
| 1686 <dl> | |
| 1687 | |
| 1688 <dt><i>files</i> (list of str)</dt> | |
| 1689 <dd> | |
| 1690 list of bundle files to be applied | |
| 1691 </dd> | |
| 1692 </dl> | |
| 1693 <dl> | |
| 1694 <dt>Return:</dt> | |
| 1695 <dd> | |
| 1696 flag indicating, that the update contained an add | |
| 1697 or delete | |
| 1698 </dd> | |
| 1699 </dl> | |
| 1700 <dl> | |
| 1701 <dt>Return Type:</dt> | |
| 1702 <dd> | |
| 1703 bool | |
| 1704 </dd> | |
| 1705 </dl> | |
| 1706 <a NAME="Hg.hgVerify" ID="Hg.hgVerify"></a> | |
| 1707 <h4>Hg.hgVerify</h4> | |
| 1708 <b>hgVerify</b>(<i></i>) | |
| 1709 | |
| 1710 <p> | |
| 1711 Public method to verify the integrity of the repository. | |
| 1712 </p> | |
| 1713 <a NAME="Hg.initCommand" ID="Hg.initCommand"></a> | |
| 1714 <h4>Hg.initCommand</h4> | |
| 1715 <b>initCommand</b>(<i>command</i>) | |
| 1716 | |
| 1717 <p> | |
| 1718 Public method to initialize a command arguments list. | |
| 1719 </p> | |
| 1720 <dl> | |
| 1721 | |
| 1722 <dt><i>command</i></dt> | |
| 1723 <dd> | |
| 1724 command name (string) | |
| 1725 </dd> | |
| 1726 </dl> | |
| 1727 <dl> | |
| 1728 <dt>Return:</dt> | |
| 1729 <dd> | |
| 1730 list of command options (list of string) | |
| 1731 </dd> | |
| 1732 </dl> | |
| 1733 <a NAME="Hg.isExtensionActive" ID="Hg.isExtensionActive"></a> | |
| 1734 <h4>Hg.isExtensionActive</h4> | |
| 1735 <b>isExtensionActive</b>(<i>extensionName</i>) | |
| 1736 | |
| 1737 <p> | |
| 1738 Public method to check, if an extension is active. | |
| 1739 </p> | |
| 1740 <dl> | |
| 1741 | |
| 1742 <dt><i>extensionName</i></dt> | |
| 1743 <dd> | |
| 1744 name of the extension to check for (string) | |
| 1745 </dd> | |
| 1746 </dl> | |
| 1747 <dl> | |
| 1748 <dt>Return:</dt> | |
| 1749 <dd> | |
| 1750 flag indicating an active extension (boolean) | |
| 1751 </dd> | |
| 1752 </dl> | |
| 1753 <a NAME="Hg.stopClient" ID="Hg.stopClient"></a> | |
| 1754 <h4>Hg.stopClient</h4> | |
| 1755 <b>stopClient</b>(<i></i>) | |
| 1756 | |
| 1757 <p> | |
| 1758 Public method to stop the command server client. | |
| 1759 </p> | |
| 1760 <a NAME="Hg.vcsAdd" ID="Hg.vcsAdd"></a> | |
| 1761 <h4>Hg.vcsAdd</h4> | |
| 1762 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) | |
| 1763 | |
| 1764 <p> | |
| 1765 Public method used to add a file/directory to the Mercurial repository. | |
| 1766 </p> | |
| 1767 <dl> | |
| 1768 | |
| 1769 <dt><i>name</i></dt> | |
| 1770 <dd> | |
| 1771 file/directory name to be added (string) | |
| 1772 </dd> | |
| 1773 <dt><i>isDir</i></dt> | |
| 1774 <dd> | |
| 1775 flag indicating name is a directory (boolean) | |
| 1776 </dd> | |
| 1777 <dt><i>noDialog</i></dt> | |
| 1778 <dd> | |
| 1779 flag indicating quiet operations | |
| 1780 </dd> | |
| 1781 </dl> | |
| 1782 <a NAME="Hg.vcsAddBinary" ID="Hg.vcsAddBinary"></a> | |
| 1783 <h4>Hg.vcsAddBinary</h4> | |
| 1784 <b>vcsAddBinary</b>(<i>name, isDir=False</i>) | |
| 1785 | |
| 1786 <p> | |
| 1787 Public method used to add a file/directory in binary mode to the | |
| 1788 Mercurial repository. | |
| 1789 </p> | |
| 1790 <dl> | |
| 1791 | |
| 1792 <dt><i>name</i></dt> | |
| 1793 <dd> | |
| 1794 file/directory name to be added (string) | |
| 1795 </dd> | |
| 1796 <dt><i>isDir</i></dt> | |
| 1797 <dd> | |
| 1798 flag indicating name is a directory (boolean) | |
| 1799 </dd> | |
| 1800 </dl> | |
| 1801 <a NAME="Hg.vcsAddCommitMessage" ID="Hg.vcsAddCommitMessage"></a> | |
| 1802 <h4>Hg.vcsAddCommitMessage</h4> | |
| 1803 <b>vcsAddCommitMessage</b>(<i>message</i>) | |
| 1804 | |
| 1805 <p> | |
| 1806 Public method to add a commit message to the list of saved messages. | |
| 1807 </p> | |
| 1808 <dl> | |
| 1809 | |
| 1810 <dt><i>message</i> (str)</dt> | |
| 1811 <dd> | |
| 1812 message to be added | |
| 1813 </dd> | |
| 1814 </dl> | |
| 1815 <a NAME="Hg.vcsAddTree" ID="Hg.vcsAddTree"></a> | |
| 1816 <h4>Hg.vcsAddTree</h4> | |
| 1817 <b>vcsAddTree</b>(<i>path</i>) | |
| 1818 | |
| 1819 <p> | |
| 1820 Public method to add a directory tree rooted at path to the Mercurial | |
| 1821 repository. | |
| 1822 </p> | |
| 1823 <dl> | |
| 1824 | |
| 1825 <dt><i>path</i></dt> | |
| 1826 <dd> | |
| 1827 root directory of the tree to be added (string or list of | |
| 1828 strings)) | |
| 1829 </dd> | |
| 1830 </dl> | |
| 1831 <a NAME="Hg.vcsAllRegisteredStates" ID="Hg.vcsAllRegisteredStates"></a> | |
| 1832 <h4>Hg.vcsAllRegisteredStates</h4> | |
| 1833 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) | |
| 1834 | |
| 1835 <p> | |
| 1836 Public method used to get the registered states of a number of files | |
| 1837 in the vcs. | |
| 1838 </p> | |
| 1839 <p> | |
| 1840 <b>Note:</b> If a shortcut is to be taken, the code will only check, | |
| 1841 if the named directory has been scanned already. If so, it is assumed, | |
| 1842 that the states for all files have been populated by the previous run. | |
| 1843 </p> | |
| 1844 <dl> | |
| 1845 | |
| 1846 <dt><i>names</i></dt> | |
| 1847 <dd> | |
| 1848 dictionary with all filenames to be checked as keys | |
| 1849 </dd> | |
| 1850 <dt><i>dname</i></dt> | |
| 1851 <dd> | |
| 1852 directory to check in (string) | |
| 1853 </dd> | |
| 1854 <dt><i>shortcut</i></dt> | |
| 1855 <dd> | |
| 1856 flag indicating a shortcut should be taken (boolean) | |
| 1857 </dd> | |
| 1858 </dl> | |
| 1859 <dl> | |
| 1860 <dt>Return:</dt> | |
| 1861 <dd> | |
| 1862 the received dictionary completed with a combination of | |
| 1863 canBeCommited and canBeAdded or None in order to signal an error | |
| 1864 </dd> | |
| 1865 </dl> | |
| 1866 <a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a> | |
| 1867 <h4>Hg.vcsCheckout</h4> | |
| 1868 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) | |
| 1869 | |
| 1870 <p> | |
| 1871 Public method used to check the project out of a Mercurial repository | |
| 1872 (clone). | |
| 1873 </p> | |
| 1874 <dl> | |
| 1875 | |
| 1876 <dt><i>vcsDataDict</i></dt> | |
| 1877 <dd> | |
| 1878 dictionary of data required for the checkout | |
| 1879 </dd> | |
| 1880 <dt><i>projectDir</i></dt> | |
| 1881 <dd> | |
| 1882 project directory to create (string) | |
| 1883 </dd> | |
| 1884 <dt><i>noDialog</i></dt> | |
| 1885 <dd> | |
| 1886 flag indicating quiet operations | |
| 1887 </dd> | |
| 1888 </dl> | |
| 1889 <dl> | |
| 1890 <dt>Return:</dt> | |
| 1891 <dd> | |
| 1892 flag indicating an execution without errors (boolean) | |
| 1893 </dd> | |
| 1894 </dl> | |
| 1895 <a NAME="Hg.vcsCleanup" ID="Hg.vcsCleanup"></a> | |
| 1896 <h4>Hg.vcsCleanup</h4> | |
| 1897 <b>vcsCleanup</b>(<i>name</i>) | |
| 1898 | |
| 1899 <p> | |
| 1900 Public method used to cleanup the working directory. | |
| 1901 </p> | |
| 1902 <dl> | |
| 1903 | |
| 1904 <dt><i>name</i></dt> | |
| 1905 <dd> | |
| 1906 directory name to be cleaned up (string) | |
| 1907 </dd> | |
| 1908 </dl> | |
| 1909 <a NAME="Hg.vcsClearCommitMessages" ID="Hg.vcsClearCommitMessages"></a> | |
| 1910 <h4>Hg.vcsClearCommitMessages</h4> | |
| 1911 <b>vcsClearCommitMessages</b>(<i></i>) | |
| 1912 | |
| 1913 <p> | |
| 1914 Public method to clear the list of saved messages. | |
| 1915 </p> | |
| 1916 <a NAME="Hg.vcsCommandLine" ID="Hg.vcsCommandLine"></a> | |
| 1917 <h4>Hg.vcsCommandLine</h4> | |
| 1918 <b>vcsCommandLine</b>(<i>name</i>) | |
| 1919 | |
| 1920 <p> | |
| 1921 Public method used to execute arbitrary mercurial commands. | |
| 1922 </p> | |
| 1923 <dl> | |
| 1924 | |
| 1925 <dt><i>name</i></dt> | |
| 1926 <dd> | |
| 1927 directory name of the working directory (string) | |
| 1928 </dd> | |
| 1929 </dl> | |
| 1930 <a NAME="Hg.vcsCommit" ID="Hg.vcsCommit"></a> | |
| 1931 <h4>Hg.vcsCommit</h4> | |
| 1932 <b>vcsCommit</b>(<i>name, message, noDialog=False, closeBranch=False, mq=False, merge=False</i>) | |
| 1933 | |
| 1934 <p> | |
| 1935 Public method used to make the change of a file/directory permanent | |
| 1936 in the Mercurial repository. | |
| 1937 </p> | |
| 1938 <dl> | |
| 1939 | |
| 1940 <dt><i>name</i></dt> | |
| 1941 <dd> | |
| 1942 file/directory name to be committed (string or list of | |
| 1943 strings) | |
| 1944 </dd> | |
| 1945 <dt><i>message</i></dt> | |
| 1946 <dd> | |
| 1947 message for this operation (string) | |
| 1948 </dd> | |
| 1949 <dt><i>noDialog</i></dt> | |
| 1950 <dd> | |
| 1951 flag indicating quiet operations | |
| 1952 </dd> | |
| 1953 <dt><i>closeBranch</i></dt> | |
| 1954 <dd> | |
| 1955 flag indicating a close branch commit (boolean) | |
| 1956 </dd> | |
| 1957 <dt><i>mq</i></dt> | |
| 1958 <dd> | |
| 1959 flag indicating a queue commit (boolean) | |
| 1960 </dd> | |
| 1961 <dt><i>merge</i></dt> | |
| 1962 <dd> | |
| 1963 flag indicating a merge commit (boolean) | |
| 1964 </dd> | |
| 1965 </dl> | |
| 1966 <a NAME="Hg.vcsCommitMessages" ID="Hg.vcsCommitMessages"></a> | |
| 1967 <h4>Hg.vcsCommitMessages</h4> | |
| 1968 <b>vcsCommitMessages</b>(<i></i>) | |
| 1969 | |
| 1970 <p> | |
| 1971 Public method to get the list of saved commit messages. | |
| 1972 </p> | |
| 1973 <dl> | |
| 1974 <dt>Return:</dt> | |
| 1975 <dd> | |
| 1976 list of saved commit messages | |
| 1977 </dd> | |
| 1978 </dl> | |
| 1979 <dl> | |
| 1980 <dt>Return Type:</dt> | |
| 1981 <dd> | |
| 1982 list of str | |
| 1983 </dd> | |
| 1984 </dl> | |
| 1985 <a NAME="Hg.vcsConvertProject" ID="Hg.vcsConvertProject"></a> | |
| 1986 <h4>Hg.vcsConvertProject</h4> | |
| 1987 <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>) | |
| 1988 | |
| 1989 <p> | |
| 1990 Public method to convert an uncontrolled project to a version | |
| 1991 controlled project. | |
| 1992 </p> | |
| 1993 <dl> | |
| 1994 | |
| 1995 <dt><i>vcsDataDict</i> (dict)</dt> | |
| 1996 <dd> | |
| 1997 dictionary of data required for the conversion | |
| 1998 </dd> | |
| 1999 <dt><i>project</i> (Project)</dt> | |
| 2000 <dd> | |
| 2001 reference to the project object | |
| 2002 </dd> | |
| 2003 <dt><i>addAll</i> (bool)</dt> | |
| 2004 <dd> | |
| 2005 flag indicating to add all files to the repository | |
| 2006 </dd> | |
| 2007 </dl> | |
| 2008 <a NAME="Hg.vcsDiff" ID="Hg.vcsDiff"></a> | |
| 2009 <h4>Hg.vcsDiff</h4> | |
| 2010 <b>vcsDiff</b>(<i>name</i>) | |
| 2011 | |
| 2012 <p> | |
| 2013 Public method used to view the difference of a file/directory to the | |
| 2014 Mercurial repository. | |
| 2015 </p> | |
| 2016 <p> | |
| 2017 If name is a directory and is the project directory, all project files | |
| 2018 are saved first. If name is a file (or list of files), which is/are | |
| 2019 being edited and has unsaved modification, they can be saved or the | |
| 2020 operation may be aborted. | |
| 2021 </p> | |
| 2022 <dl> | |
| 2023 | |
| 2024 <dt><i>name</i></dt> | |
| 2025 <dd> | |
| 2026 file/directory name to be diffed (string) | |
| 2027 </dd> | |
| 2028 </dl> | |
| 2029 <a NAME="Hg.vcsExists" ID="Hg.vcsExists"></a> | |
| 2030 <h4>Hg.vcsExists</h4> | |
| 2031 <b>vcsExists</b>(<i></i>) | |
| 2032 | |
| 2033 <p> | |
| 2034 Public method used to test for the presence of the hg executable. | |
| 2035 </p> | |
| 2036 <dl> | |
| 2037 <dt>Return:</dt> | |
| 2038 <dd> | |
| 2039 flag indicating the existence (boolean) and an error message | |
| 2040 (string) | |
| 2041 </dd> | |
| 2042 </dl> | |
| 2043 <a NAME="Hg.vcsExport" ID="Hg.vcsExport"></a> | |
| 2044 <h4>Hg.vcsExport</h4> | |
| 2045 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>) | |
| 2046 | |
| 2047 <p> | |
| 2048 Public method used to export a directory from the Mercurial repository. | |
| 2049 </p> | |
| 2050 <dl> | |
| 2051 | |
| 2052 <dt><i>vcsDataDict</i></dt> | |
| 2053 <dd> | |
| 2054 dictionary of data required for the checkout | |
| 2055 </dd> | |
| 2056 <dt><i>projectDir</i></dt> | |
| 2057 <dd> | |
| 2058 project directory to create (string) | |
| 2059 </dd> | |
| 2060 </dl> | |
| 2061 <dl> | |
| 2062 <dt>Return:</dt> | |
| 2063 <dd> | |
| 2064 flag indicating an execution without errors (boolean) | |
| 2065 </dd> | |
| 2066 </dl> | |
| 2067 <a NAME="Hg.vcsForget" ID="Hg.vcsForget"></a> | |
| 2068 <h4>Hg.vcsForget</h4> | |
| 2069 <b>vcsForget</b>(<i>name</i>) | |
| 2070 | |
| 2071 <p> | |
| 2072 Public method used to remove a file from the Mercurial repository. | |
| 2073 </p> | |
| 2074 <p> | |
| 2075 This will not remove the file from the project directory. | |
| 2076 </p> | |
| 2077 <dl> | |
| 2078 | |
| 2079 <dt><i>name</i> (str or list of str)</dt> | |
| 2080 <dd> | |
| 2081 file/directory name to be removed | |
| 2082 </dd> | |
| 2083 </dl> | |
| 2084 <a NAME="Hg.vcsGetProjectBrowserHelper" ID="Hg.vcsGetProjectBrowserHelper"></a> | |
| 2085 <h4>Hg.vcsGetProjectBrowserHelper</h4> | |
| 2086 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) | |
| 2087 | |
| 2088 <p> | |
| 2089 Public method to instantiate a helper object for the different | |
| 2090 project browsers. | |
| 2091 </p> | |
| 2092 <dl> | |
| 2093 | |
| 2094 <dt><i>browser</i></dt> | |
| 2095 <dd> | |
| 2096 reference to the project browser object | |
| 2097 </dd> | |
| 2098 <dt><i>project</i></dt> | |
| 2099 <dd> | |
| 2100 reference to the project object | |
| 2101 </dd> | |
| 2102 <dt><i>isTranslationsBrowser</i></dt> | |
| 2103 <dd> | |
| 2104 flag indicating, the helper is requested | |
| 2105 for the translations browser (this needs some special treatment) | |
| 2106 </dd> | |
| 2107 </dl> | |
| 2108 <dl> | |
| 2109 <dt>Return:</dt> | |
| 2110 <dd> | |
| 2111 the project browser helper object | |
| 2112 </dd> | |
| 2113 </dl> | |
| 2114 <a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a> | |
| 2115 <h4>Hg.vcsGetProjectHelper</h4> | |
| 2116 <b>vcsGetProjectHelper</b>(<i>project</i>) | |
| 2117 | |
| 2118 <p> | |
| 2119 Public method to instantiate a helper object for the project. | |
| 2120 </p> | |
| 2121 <dl> | |
| 2122 | |
| 2123 <dt><i>project</i></dt> | |
| 2124 <dd> | |
| 2125 reference to the project object | |
| 2126 </dd> | |
| 2127 </dl> | |
| 2128 <dl> | |
| 2129 <dt>Return:</dt> | |
| 2130 <dd> | |
| 2131 the project helper object | |
| 2132 </dd> | |
| 2133 </dl> | |
| 2134 <a NAME="Hg.vcsImport" ID="Hg.vcsImport"></a> | |
| 2135 <h4>Hg.vcsImport</h4> | |
| 2136 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>) | |
| 2137 | |
| 2138 <p> | |
| 2139 Public method used to import the project into the Mercurial repository. | |
| 2140 </p> | |
| 2141 <dl> | |
| 2142 | |
| 2143 <dt><i>vcsDataDict</i> (dict)</dt> | |
| 2144 <dd> | |
| 2145 dictionary of data required for the import | |
| 2146 </dd> | |
| 2147 <dt><i>projectDir</i> (str)</dt> | |
| 2148 <dd> | |
| 2149 project directory (string) | |
| 2150 </dd> | |
| 2151 <dt><i>noDialog</i> (bool)</dt> | |
| 2152 <dd> | |
| 2153 flag indicating quiet operations | |
| 2154 </dd> | |
| 2155 <dt><i>addAll</i> (bool)</dt> | |
| 2156 <dd> | |
| 2157 flag indicating to add all files to the repository | |
| 2158 </dd> | |
| 2159 </dl> | |
| 2160 <dl> | |
| 2161 <dt>Return:</dt> | |
| 2162 <dd> | |
| 2163 tuple containing a flag indicating an execution without errors | |
| 2164 and a flag indicating the version controll status | |
| 2165 </dd> | |
| 2166 </dl> | |
| 2167 <dl> | |
| 2168 <dt>Return Type:</dt> | |
| 2169 <dd> | |
| 2170 tuple of (bool, bool) | |
| 2171 </dd> | |
| 2172 </dl> | |
| 2173 <a NAME="Hg.vcsInit" ID="Hg.vcsInit"></a> | |
| 2174 <h4>Hg.vcsInit</h4> | |
| 2175 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) | |
| 2176 | |
| 2177 <p> | |
| 2178 Public method used to initialize the mercurial repository. | |
| 2179 </p> | |
| 2180 <p> | |
| 2181 The initialization is done, when a project is converted into a | |
| 2182 Mercurial controlled project. Therefore we always return TRUE without | |
| 2183 doing anything. | |
| 2184 </p> | |
| 2185 <dl> | |
| 2186 | |
| 2187 <dt><i>vcsDir</i></dt> | |
| 2188 <dd> | |
| 2189 name of the VCS directory (string) | |
| 2190 </dd> | |
| 2191 <dt><i>noDialog</i></dt> | |
| 2192 <dd> | |
| 2193 flag indicating quiet operations (boolean) | |
| 2194 </dd> | |
| 2195 </dl> | |
| 2196 <dl> | |
| 2197 <dt>Return:</dt> | |
| 2198 <dd> | |
| 2199 always TRUE | |
| 2200 </dd> | |
| 2201 </dl> | |
| 2202 <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a> | |
| 2203 <h4>Hg.vcsInitConfig</h4> | |
| 2204 <b>vcsInitConfig</b>(<i>project</i>) | |
| 2205 | |
| 2206 <p> | |
| 2207 Public method to initialize the VCS configuration. | |
| 2208 </p> | |
| 2209 <p> | |
| 2210 This method ensures, that an ignore file exists. | |
| 2211 </p> | |
| 2212 <dl> | |
| 2213 | |
| 2214 <dt><i>project</i></dt> | |
| 2215 <dd> | |
| 2216 reference to the project (Project) | |
| 2217 </dd> | |
| 2218 </dl> | |
| 2219 <a NAME="Hg.vcsLogBrowser" ID="Hg.vcsLogBrowser"></a> | |
| 2220 <h4>Hg.vcsLogBrowser</h4> | |
| 2221 <b>vcsLogBrowser</b>(<i>name=None, isFile=False</i>) | |
| 2222 | |
| 2223 <p> | |
| 2224 Public method used to browse the log of a file/directory from the | |
| 2225 Mercurial repository. | |
| 2226 </p> | |
| 2227 <dl> | |
| 2228 | |
| 2229 <dt><i>name</i></dt> | |
| 2230 <dd> | |
| 2231 file/directory name to show the log of (string) | |
| 2232 </dd> | |
| 2233 <dt><i>isFile</i></dt> | |
| 2234 <dd> | |
| 2235 flag indicating log for a file is to be shown | |
| 2236 (boolean) | |
| 2237 </dd> | |
| 2238 </dl> | |
| 2239 <a NAME="Hg.vcsMerge" ID="Hg.vcsMerge"></a> | |
| 2240 <h4>Hg.vcsMerge</h4> | |
| 2241 <b>vcsMerge</b>(<i>name, rev=""</i>) | |
| 2242 | |
| 2243 <p> | |
| 2244 Public method used to merge a URL/revision into the local project. | |
| 2245 </p> | |
| 2246 <dl> | |
| 2247 | |
| 2248 <dt><i>name</i> (str)</dt> | |
| 2249 <dd> | |
| 2250 file/directory name to be merged | |
| 2251 </dd> | |
| 2252 <dt><i>rev</i> (str)</dt> | |
| 2253 <dd> | |
| 2254 revision to merge with | |
| 2255 </dd> | |
| 2256 </dl> | |
| 2257 <a NAME="Hg.vcsMove" ID="Hg.vcsMove"></a> | |
| 2258 <h4>Hg.vcsMove</h4> | |
| 2259 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) | |
| 2260 | |
| 2261 <p> | |
| 2262 Public method used to move a file/directory. | |
| 2263 </p> | |
| 2264 <dl> | |
| 2265 | |
| 2266 <dt><i>name</i></dt> | |
| 2267 <dd> | |
| 2268 file/directory name to be moved (string) | |
| 2269 </dd> | |
| 2270 <dt><i>project</i></dt> | |
| 2271 <dd> | |
| 2272 reference to the project object | |
| 2273 </dd> | |
| 2274 <dt><i>target</i></dt> | |
| 2275 <dd> | |
| 2276 new name of the file/directory (string) | |
| 2277 </dd> | |
| 2278 <dt><i>noDialog</i></dt> | |
| 2279 <dd> | |
| 2280 flag indicating quiet operations | |
| 2281 </dd> | |
| 2282 </dl> | |
| 2283 <dl> | |
| 2284 <dt>Return:</dt> | |
| 2285 <dd> | |
| 2286 flag indicating successfull operation (boolean) | |
| 2287 </dd> | |
| 2288 </dl> | |
| 2289 <a NAME="Hg.vcsName" ID="Hg.vcsName"></a> | |
| 2290 <h4>Hg.vcsName</h4> | |
| 2291 <b>vcsName</b>(<i></i>) | |
| 2292 | |
| 2293 <p> | |
| 2294 Public method returning the name of the vcs. | |
| 2295 </p> | |
| 2296 <dl> | |
| 2297 <dt>Return:</dt> | |
| 2298 <dd> | |
| 2299 always 'Mercurial' (string) | |
| 2300 </dd> | |
| 2301 </dl> | |
| 2302 <a NAME="Hg.vcsNewProjectOptionsDialog" ID="Hg.vcsNewProjectOptionsDialog"></a> | |
| 2303 <h4>Hg.vcsNewProjectOptionsDialog</h4> | |
| 2304 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) | |
| 2305 | |
| 2306 <p> | |
| 2307 Public method to get a dialog to enter repository info for getting a | |
| 2308 new project. | |
| 2309 </p> | |
| 2310 <dl> | |
| 2311 | |
| 2312 <dt><i>parent</i></dt> | |
| 2313 <dd> | |
| 2314 parent widget (QWidget) | |
| 2315 </dd> | |
| 2316 </dl> | |
| 2317 <dl> | |
| 2318 <dt>Return:</dt> | |
| 2319 <dd> | |
| 2320 reference to the instantiated options dialog | |
| 2321 (HgNewProjectOptionsDialog) | |
| 2322 </dd> | |
| 2323 </dl> | |
| 2324 <a NAME="Hg.vcsOptionsDialog" ID="Hg.vcsOptionsDialog"></a> | |
| 2325 <h4>Hg.vcsOptionsDialog</h4> | |
| 2326 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) | |
| 2327 | |
| 2328 <p> | |
| 2329 Public method to get a dialog to enter repository info. | |
| 2330 </p> | |
| 2331 <dl> | |
| 2332 | |
| 2333 <dt><i>project</i></dt> | |
| 2334 <dd> | |
| 2335 reference to the project object | |
| 2336 </dd> | |
| 2337 <dt><i>archive</i></dt> | |
| 2338 <dd> | |
| 2339 name of the project in the repository (string) | |
| 2340 </dd> | |
| 2341 <dt><i>editable</i></dt> | |
| 2342 <dd> | |
| 2343 flag indicating that the project name is editable | |
| 2344 (boolean) | |
| 2345 </dd> | |
| 2346 <dt><i>parent</i></dt> | |
| 2347 <dd> | |
| 2348 parent widget (QWidget) | |
| 2349 </dd> | |
| 2350 </dl> | |
| 2351 <dl> | |
| 2352 <dt>Return:</dt> | |
| 2353 <dd> | |
| 2354 reference to the instantiated options dialog (HgOptionsDialog) | |
| 2355 </dd> | |
| 2356 </dl> | |
| 2357 <a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a> | |
| 2358 <h4>Hg.vcsRegisteredState</h4> | |
| 2359 <b>vcsRegisteredState</b>(<i>name</i>) | |
| 2360 | |
| 2361 <p> | |
| 2362 Public method used to get the registered state of a file in the vcs. | |
| 2363 </p> | |
| 2364 <dl> | |
| 2365 | |
| 2366 <dt><i>name</i> (str)</dt> | |
| 2367 <dd> | |
| 2368 file or directory name to check | |
| 2369 </dd> | |
| 2370 </dl> | |
| 2371 <dl> | |
| 2372 <dt>Return:</dt> | |
| 2373 <dd> | |
| 2374 a combination of canBeCommited and canBeAdded | |
| 2375 </dd> | |
| 2376 </dl> | |
| 2377 <dl> | |
| 2378 <dt>Return Type:</dt> | |
| 2379 <dd> | |
| 2380 int | |
| 2381 </dd> | |
| 2382 </dl> | |
| 2383 <a NAME="Hg.vcsRemove" ID="Hg.vcsRemove"></a> | |
| 2384 <h4>Hg.vcsRemove</h4> | |
| 2385 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) | |
| 2386 | |
| 2387 <p> | |
| 2388 Public method used to remove a file/directory from the Mercurial | |
| 2389 repository. | |
| 2390 </p> | |
| 2391 <p> | |
| 2392 The default operation is to remove the local copy as well. | |
| 2393 </p> | |
| 2394 <dl> | |
| 2395 | |
| 2396 <dt><i>name</i></dt> | |
| 2397 <dd> | |
| 2398 file/directory name to be removed (string or list of | |
| 2399 strings)) | |
| 2400 </dd> | |
| 2401 <dt><i>project</i></dt> | |
| 2402 <dd> | |
| 2403 flag indicating deletion of a project tree (boolean) | |
| 2404 (not needed) | |
| 2405 </dd> | |
| 2406 <dt><i>noDialog</i></dt> | |
| 2407 <dd> | |
| 2408 flag indicating quiet operations | |
| 2409 </dd> | |
| 2410 </dl> | |
| 2411 <dl> | |
| 2412 <dt>Return:</dt> | |
| 2413 <dd> | |
| 2414 flag indicating successfull operation (boolean) | |
| 2415 </dd> | |
| 2416 </dl> | |
| 2417 <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a> | |
| 2418 <h4>Hg.vcsRepositoryInfos</h4> | |
| 2419 <b>vcsRepositoryInfos</b>(<i>ppath</i>) | |
| 2420 | |
| 2421 <p> | |
| 2422 Public method to retrieve information about the repository. | |
| 2423 </p> | |
| 2424 <dl> | |
| 2425 | |
| 2426 <dt><i>ppath</i></dt> | |
| 2427 <dd> | |
| 2428 local path to get the repository infos (string) | |
| 2429 </dd> | |
| 2430 </dl> | |
| 2431 <dl> | |
| 2432 <dt>Return:</dt> | |
| 2433 <dd> | |
| 2434 string with ready formated info for display (string) | |
| 2435 </dd> | |
| 2436 </dl> | |
| 2437 <a NAME="Hg.vcsResolved" ID="Hg.vcsResolved"></a> | |
| 2438 <h4>Hg.vcsResolved</h4> | |
| 2439 <b>vcsResolved</b>(<i>name, unresolve=False</i>) | |
| 2440 | |
| 2441 <p> | |
| 2442 Public method used to resolve conflicts of a file/directory. | |
| 2443 </p> | |
| 2444 <dl> | |
| 2445 | |
| 2446 <dt><i>name</i></dt> | |
| 2447 <dd> | |
| 2448 file/directory name to be resolved (string) | |
| 2449 </dd> | |
| 2450 <dt><i>unresolve</i></dt> | |
| 2451 <dd> | |
| 2452 flag indicating to mark the file/directory as | |
| 2453 unresolved (boolean) | |
| 2454 </dd> | |
| 2455 </dl> | |
| 2456 <a NAME="Hg.vcsRevert" ID="Hg.vcsRevert"></a> | |
| 2457 <h4>Hg.vcsRevert</h4> | |
| 2458 <b>vcsRevert</b>(<i>name</i>) | |
| 2459 | |
| 2460 <p> | |
| 2461 Public method used to revert changes made to a file/directory. | |
| 2462 </p> | |
| 2463 <dl> | |
| 2464 | |
| 2465 <dt><i>name</i> (str)</dt> | |
| 2466 <dd> | |
| 2467 file/directory name to be reverted | |
| 2468 </dd> | |
| 2469 </dl> | |
| 2470 <dl> | |
| 2471 <dt>Return:</dt> | |
| 2472 <dd> | |
| 2473 flag indicating, that the update contained an add | |
| 2474 or delete | |
| 2475 </dd> | |
| 2476 </dl> | |
| 2477 <dl> | |
| 2478 <dt>Return Type:</dt> | |
| 2479 <dd> | |
| 2480 bool | |
| 2481 </dd> | |
| 2482 </dl> | |
| 2483 <a NAME="Hg.vcsSbsDiff" ID="Hg.vcsSbsDiff"></a> | |
| 2484 <h4>Hg.vcsSbsDiff</h4> | |
| 2485 <b>vcsSbsDiff</b>(<i>name, extended=False, revisions=None</i>) | |
| 2486 | |
| 2487 <p> | |
| 2488 Public method used to view the difference of a file to the Mercurial | |
| 2489 repository side-by-side. | |
| 2490 </p> | |
| 2491 <dl> | |
| 2492 | |
| 2493 <dt><i>name</i></dt> | |
| 2494 <dd> | |
| 2495 file name to be diffed (string) | |
| 2496 </dd> | |
| 2497 <dt><i>extended</i></dt> | |
| 2498 <dd> | |
| 2499 flag indicating the extended variant (boolean) | |
| 2500 </dd> | |
| 2501 <dt><i>revisions</i></dt> | |
| 2502 <dd> | |
| 2503 tuple of two revisions (tuple of strings) | |
| 2504 </dd> | |
| 2505 </dl> | |
| 2506 <dl> | |
| 2507 | |
| 2508 <dt>Raises <b>ValueError</b>:</dt> | |
| 2509 <dd> | |
| 2510 raised to indicate an invalid name parameter | |
| 2511 </dd> | |
| 2512 </dl> | |
| 2513 <a NAME="Hg.vcsShutdown" ID="Hg.vcsShutdown"></a> | |
| 2514 <h4>Hg.vcsShutdown</h4> | |
| 2515 <b>vcsShutdown</b>(<i></i>) | |
| 2516 | |
| 2517 <p> | |
| 2518 Public method used to shutdown the Mercurial interface. | |
| 2519 </p> | |
| 2520 <a NAME="Hg.vcsStatus" ID="Hg.vcsStatus"></a> | |
| 2521 <h4>Hg.vcsStatus</h4> | |
| 2522 <b>vcsStatus</b>(<i>name</i>) | |
| 2523 | |
| 2524 <p> | |
| 2525 Public method used to view the status of files/directories in the | |
| 2526 Mercurial repository. | |
| 2527 </p> | |
| 2528 <dl> | |
| 2529 | |
| 2530 <dt><i>name</i></dt> | |
| 2531 <dd> | |
| 2532 file/directory name(s) to show the status of | |
| 2533 (string or list of strings) | |
| 2534 </dd> | |
| 2535 </dl> | |
| 2536 <a NAME="Hg.vcsSupportCommandOptions" ID="Hg.vcsSupportCommandOptions"></a> | |
| 2537 <h4>Hg.vcsSupportCommandOptions</h4> | |
| 2538 <b>vcsSupportCommandOptions</b>(<i></i>) | |
| 2539 | |
| 2540 <p> | |
| 2541 Public method to signal the support of user settable command options. | |
| 2542 </p> | |
| 2543 <dl> | |
| 2544 <dt>Return:</dt> | |
| 2545 <dd> | |
| 2546 flag indicating the support of user settable command options | |
| 2547 (boolean) | |
| 2548 </dd> | |
| 2549 </dl> | |
| 2550 <a NAME="Hg.vcsSwitch" ID="Hg.vcsSwitch"></a> | |
| 2551 <h4>Hg.vcsSwitch</h4> | |
| 2552 <b>vcsSwitch</b>(<i>name</i>) | |
| 2553 | |
| 2554 <p> | |
| 2555 Public method used to switch a working directory to a different | |
| 2556 revision. | |
| 2557 </p> | |
| 2558 <dl> | |
| 2559 | |
| 2560 <dt><i>name</i></dt> | |
| 2561 <dd> | |
| 2562 directory name to be switched (string) | |
| 2563 </dd> | |
| 2564 </dl> | |
| 2565 <dl> | |
| 2566 <dt>Return:</dt> | |
| 2567 <dd> | |
| 2568 flag indicating, that the switch contained an add | |
| 2569 or delete (boolean) | |
| 2570 </dd> | |
| 2571 </dl> | |
| 2572 <a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a> | |
| 2573 <h4>Hg.vcsTag</h4> | |
| 2574 <b>vcsTag</b>(<i>name=None, revision=None, tagName=None</i>) | |
| 2575 | |
| 2576 <p> | |
| 2577 Public method used to set/remove a tag in the Mercurial repository. | |
| 2578 </p> | |
| 2579 <dl> | |
| 2580 | |
| 2581 <dt><i>name</i></dt> | |
| 2582 <dd> | |
| 2583 file/directory name to determine the repo root from | |
| 2584 (string) | |
| 2585 </dd> | |
| 2586 <dt><i>revision</i></dt> | |
| 2587 <dd> | |
| 2588 revision to set tag for (string) | |
| 2589 </dd> | |
| 2590 <dt><i>tagName</i></dt> | |
| 2591 <dd> | |
| 2592 name of the tag (string) | |
| 2593 </dd> | |
| 2594 </dl> | |
| 2595 <dl> | |
| 2596 <dt>Return:</dt> | |
| 2597 <dd> | |
| 2598 flag indicating a performed tag action (boolean) | |
| 2599 </dd> | |
| 2600 </dl> | |
| 2601 <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a> | |
| 2602 <h4>Hg.vcsUpdate</h4> | |
| 2603 <b>vcsUpdate</b>(<i>name=None, noDialog=False, revision=None</i>) | |
| 2604 | |
| 2605 <p> | |
| 2606 Public method used to update a file/directory with the Mercurial | |
| 2607 repository. | |
| 2608 </p> | |
| 2609 <dl> | |
| 2610 | |
| 2611 <dt><i>name</i></dt> | |
| 2612 <dd> | |
| 2613 file/directory name to be updated (not used) | |
| 2614 </dd> | |
| 2615 <dt><i>noDialog</i></dt> | |
| 2616 <dd> | |
| 2617 flag indicating quiet operations (boolean) | |
| 2618 </dd> | |
| 2619 <dt><i>revision</i></dt> | |
| 2620 <dd> | |
| 2621 revision to update to (string) | |
| 2622 </dd> | |
| 2623 </dl> | |
| 2624 <dl> | |
| 2625 <dt>Return:</dt> | |
| 2626 <dd> | |
| 2627 flag indicating, that the update contained an add | |
| 2628 or delete (boolean) | |
| 2629 </dd> | |
| 2630 </dl> | |
| 2631 <div align="right"><a href="#top">Up</a></div> | |
| 2632 <hr /> | |
| 2633 </body></html> |
