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