eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html

branch
eric7
changeset 8623
fced5aa98d41
parent 8596
d64760b2da50
child 8652
8cacde11f4fd
equal deleted inserted replaced
8622:149d51870ce8 8623:fced5aa98d41
255 <tr> 255 <tr>
256 <td><a href="#Hg.hgExtendedDiff">hgExtendedDiff</a></td> 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> 257 <td>Public method used to view the difference of a file/directory to the Mercurial repository.</td>
258 </tr> 258 </tr>
259 <tr> 259 <tr>
260 <td><a href="#Hg.hgForget">hgForget</a></td>
261 <td>Public method used to remove a file from the Mercurial repository.</td>
262 </tr>
263 <tr>
264 <td><a href="#Hg.hgGetBookmarksList">hgGetBookmarksList</a></td> 260 <td><a href="#Hg.hgGetBookmarksList">hgGetBookmarksList</a></td>
265 <td>Public method to get the list of bookmarks.</td> 261 <td>Public method to get the list of bookmarks.</td>
266 </tr> 262 </tr>
267 <tr> 263 <tr>
268 <td><a href="#Hg.hgGetBranchesList">hgGetBranchesList</a></td> 264 <td><a href="#Hg.hgGetBranchesList">hgGetBranchesList</a></td>
351 <tr> 347 <tr>
352 <td><a href="#Hg.hgRemoveSubrepositories">hgRemoveSubrepositories</a></td> 348 <td><a href="#Hg.hgRemoveSubrepositories">hgRemoveSubrepositories</a></td>
353 <td>Public method to remove sub-repositories.</td> 349 <td>Public method to remove sub-repositories.</td>
354 </tr> 350 </tr>
355 <tr> 351 <tr>
356 <td><a href="#Hg.hgResolved">hgResolved</a></td>
357 <td>Public method used to resolve conflicts of a file/directory.</td>
358 </tr>
359 <tr>
360 <td><a href="#Hg.hgRevert">hgRevert</a></td>
361 <td>Public method used to revert changes made to a file/directory.</td>
362 </tr>
363 <tr>
364 <td><a href="#Hg.hgRollback">hgRollback</a></td> 352 <td><a href="#Hg.hgRollback">hgRollback</a></td>
365 <td>Public method used to rollback the last transaction.</td> 353 <td>Public method used to rollback the last transaction.</td>
366 </tr> 354 </tr>
367 <tr> 355 <tr>
368 <td><a href="#Hg.hgSbsDiff">hgSbsDiff</a></td>
369 <td>Public method used to view the difference of a file to the Mercurial repository side-by-side.</td>
370 </tr>
371 <tr>
372 <td><a href="#Hg.hgServe">hgServe</a></td> 356 <td><a href="#Hg.hgServe">hgServe</a></td>
373 <td>Public method used to serve the project.</td> 357 <td>Public method used to serve the project.</td>
374 </tr> 358 </tr>
375 <tr> 359 <tr>
376 <td><a href="#Hg.hgShowBranch">hgShowBranch</a></td> 360 <td><a href="#Hg.hgShowBranch">hgShowBranch</a></td>
455 <tr> 439 <tr>
456 <td><a href="#Hg.vcsExport">vcsExport</a></td> 440 <td><a href="#Hg.vcsExport">vcsExport</a></td>
457 <td>Public method used to export a directory from the Mercurial repository.</td> 441 <td>Public method used to export a directory from the Mercurial repository.</td>
458 </tr> 442 </tr>
459 <tr> 443 <tr>
444 <td><a href="#Hg.vcsForget">vcsForget</a></td>
445 <td>Public method used to remove a file from the Mercurial repository.</td>
446 </tr>
447 <tr>
460 <td><a href="#Hg.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td> 448 <td><a href="#Hg.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
461 <td>Public method to instantiate a helper object for the different project browsers.</td> 449 <td>Public method to instantiate a helper object for the different project browsers.</td>
462 </tr> 450 </tr>
463 <tr> 451 <tr>
464 <td><a href="#Hg.vcsGetProjectHelper">vcsGetProjectHelper</a></td> 452 <td><a href="#Hg.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
509 <td>Public method used to remove a file/directory from the Mercurial repository.</td> 497 <td>Public method used to remove a file/directory from the Mercurial repository.</td>
510 </tr> 498 </tr>
511 <tr> 499 <tr>
512 <td><a href="#Hg.vcsRepositoryInfos">vcsRepositoryInfos</a></td> 500 <td><a href="#Hg.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
513 <td>Public method to retrieve information about the repository.</td> 501 <td>Public method to retrieve information about the repository.</td>
502 </tr>
503 <tr>
504 <td><a href="#Hg.vcsResolved">vcsResolved</a></td>
505 <td>Public method used to resolve conflicts of a file/directory.</td>
506 </tr>
507 <tr>
508 <td><a href="#Hg.vcsRevert">vcsRevert</a></td>
509 <td>Public method used to revert changes made to a file/directory.</td>
510 </tr>
511 <tr>
512 <td><a href="#Hg.vcsSbsDiff">vcsSbsDiff</a></td>
513 <td>Public method used to view the difference of a file to the Mercurial repository side-by-side.</td>
514 </tr> 514 </tr>
515 <tr> 515 <tr>
516 <td><a href="#Hg.vcsShutdown">vcsShutdown</a></td> 516 <td><a href="#Hg.vcsShutdown">vcsShutdown</a></td>
517 <td>Public method used to shutdown the Mercurial interface.</td> 517 <td>Public method used to shutdown the Mercurial interface.</td>
518 </tr> 518 </tr>
1226 <dt><i>name</i></dt> 1226 <dt><i>name</i></dt>
1227 <dd> 1227 <dd>
1228 file/directory name to be diffed (string) 1228 file/directory name to be diffed (string)
1229 </dd> 1229 </dd>
1230 </dl> 1230 </dl>
1231 <a NAME="Hg.hgForget" ID="Hg.hgForget"></a>
1232 <h4>Hg.hgForget</h4>
1233 <b>hgForget</b>(<i>name</i>)
1234
1235 <p>
1236 Public method used to remove a file from the Mercurial repository.
1237 </p>
1238 <p>
1239 This will not remove the file from the project directory.
1240 </p>
1241 <dl>
1242
1243 <dt><i>name</i></dt>
1244 <dd>
1245 file/directory name to be removed (string or list of
1246 strings))
1247 </dd>
1248 </dl>
1249 <a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a> 1231 <a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a>
1250 <h4>Hg.hgGetBookmarksList</h4> 1232 <h4>Hg.hgGetBookmarksList</h4>
1251 <b>hgGetBookmarksList</b>(<i></i>) 1233 <b>hgGetBookmarksList</b>(<i></i>)
1252 1234
1253 <p> 1235 <p>
1618 <b>hgRemoveSubrepositories</b>(<i></i>) 1600 <b>hgRemoveSubrepositories</b>(<i></i>)
1619 1601
1620 <p> 1602 <p>
1621 Public method to remove sub-repositories. 1603 Public method to remove sub-repositories.
1622 </p> 1604 </p>
1623 <a NAME="Hg.hgResolved" ID="Hg.hgResolved"></a>
1624 <h4>Hg.hgResolved</h4>
1625 <b>hgResolved</b>(<i>name, unresolve=False</i>)
1626
1627 <p>
1628 Public method used to resolve conflicts of a file/directory.
1629 </p>
1630 <dl>
1631
1632 <dt><i>name</i></dt>
1633 <dd>
1634 file/directory name to be resolved (string)
1635 </dd>
1636 <dt><i>unresolve</i></dt>
1637 <dd>
1638 flag indicating to mark the file/directory as
1639 unresolved (boolean)
1640 </dd>
1641 </dl>
1642 <a NAME="Hg.hgRevert" ID="Hg.hgRevert"></a>
1643 <h4>Hg.hgRevert</h4>
1644 <b>hgRevert</b>(<i>name</i>)
1645
1646 <p>
1647 Public method used to revert changes made to a file/directory.
1648 </p>
1649 <dl>
1650
1651 <dt><i>name</i></dt>
1652 <dd>
1653 file/directory name to be reverted (string)
1654 </dd>
1655 </dl>
1656 <dl>
1657 <dt>Return:</dt>
1658 <dd>
1659 flag indicating, that the update contained an add
1660 or delete (boolean)
1661 </dd>
1662 </dl>
1663 <a NAME="Hg.hgRollback" ID="Hg.hgRollback"></a> 1605 <a NAME="Hg.hgRollback" ID="Hg.hgRollback"></a>
1664 <h4>Hg.hgRollback</h4> 1606 <h4>Hg.hgRollback</h4>
1665 <b>hgRollback</b>(<i></i>) 1607 <b>hgRollback</b>(<i></i>)
1666 1608
1667 <p> 1609 <p>
1668 Public method used to rollback the last transaction. 1610 Public method used to rollback the last transaction.
1669 </p> 1611 </p>
1670 <a NAME="Hg.hgSbsDiff" ID="Hg.hgSbsDiff"></a>
1671 <h4>Hg.hgSbsDiff</h4>
1672 <b>hgSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
1673
1674 <p>
1675 Public method used to view the difference of a file to the Mercurial
1676 repository side-by-side.
1677 </p>
1678 <dl>
1679
1680 <dt><i>name</i></dt>
1681 <dd>
1682 file name to be diffed (string)
1683 </dd>
1684 <dt><i>extended</i></dt>
1685 <dd>
1686 flag indicating the extended variant (boolean)
1687 </dd>
1688 <dt><i>revisions</i></dt>
1689 <dd>
1690 tuple of two revisions (tuple of strings)
1691 </dd>
1692 </dl>
1693 <dl>
1694
1695 <dt>Raises <b>ValueError</b>:</dt>
1696 <dd>
1697 raised to indicate an invalid name parameter
1698 </dd>
1699 </dl>
1700 <a NAME="Hg.hgServe" ID="Hg.hgServe"></a> 1612 <a NAME="Hg.hgServe" ID="Hg.hgServe"></a>
1701 <h4>Hg.hgServe</h4> 1613 <h4>Hg.hgServe</h4>
1702 <b>hgServe</b>(<i>repoPath</i>) 1614 <b>hgServe</b>(<i>repoPath</i>)
1703 1615
1704 <p> 1616 <p>
2098 <dt>Return:</dt> 2010 <dt>Return:</dt>
2099 <dd> 2011 <dd>
2100 flag indicating an execution without errors (boolean) 2012 flag indicating an execution without errors (boolean)
2101 </dd> 2013 </dd>
2102 </dl> 2014 </dl>
2015 <a NAME="Hg.vcsForget" ID="Hg.vcsForget"></a>
2016 <h4>Hg.vcsForget</h4>
2017 <b>vcsForget</b>(<i>name</i>)
2018
2019 <p>
2020 Public method used to remove a file from the Mercurial repository.
2021 </p>
2022 <p>
2023 This will not remove the file from the project directory.
2024 </p>
2025 <dl>
2026
2027 <dt><i>name</i> (str or list of str)</dt>
2028 <dd>
2029 file/directory name to be removed
2030 </dd>
2031 </dl>
2103 <a NAME="Hg.vcsGetProjectBrowserHelper" ID="Hg.vcsGetProjectBrowserHelper"></a> 2032 <a NAME="Hg.vcsGetProjectBrowserHelper" ID="Hg.vcsGetProjectBrowserHelper"></a>
2104 <h4>Hg.vcsGetProjectBrowserHelper</h4> 2033 <h4>Hg.vcsGetProjectBrowserHelper</h4>
2105 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) 2034 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
2106 2035
2107 <p> 2036 <p>
2451 <dt>Return:</dt> 2380 <dt>Return:</dt>
2452 <dd> 2381 <dd>
2453 string with ready formated info for display (string) 2382 string with ready formated info for display (string)
2454 </dd> 2383 </dd>
2455 </dl> 2384 </dl>
2385 <a NAME="Hg.vcsResolved" ID="Hg.vcsResolved"></a>
2386 <h4>Hg.vcsResolved</h4>
2387 <b>vcsResolved</b>(<i>name, unresolve=False</i>)
2388
2389 <p>
2390 Public method used to resolve conflicts of a file/directory.
2391 </p>
2392 <dl>
2393
2394 <dt><i>name</i></dt>
2395 <dd>
2396 file/directory name to be resolved (string)
2397 </dd>
2398 <dt><i>unresolve</i></dt>
2399 <dd>
2400 flag indicating to mark the file/directory as
2401 unresolved (boolean)
2402 </dd>
2403 </dl>
2404 <a NAME="Hg.vcsRevert" ID="Hg.vcsRevert"></a>
2405 <h4>Hg.vcsRevert</h4>
2406 <b>vcsRevert</b>(<i>name</i>)
2407
2408 <p>
2409 Public method used to revert changes made to a file/directory.
2410 </p>
2411 <dl>
2412
2413 <dt><i>name</i> (str)</dt>
2414 <dd>
2415 file/directory name to be reverted
2416 </dd>
2417 </dl>
2418 <dl>
2419 <dt>Return:</dt>
2420 <dd>
2421 flag indicating, that the update contained an add
2422 or delete
2423 </dd>
2424 </dl>
2425 <dl>
2426 <dt>Return Type:</dt>
2427 <dd>
2428 bool
2429 </dd>
2430 </dl>
2431 <a NAME="Hg.vcsSbsDiff" ID="Hg.vcsSbsDiff"></a>
2432 <h4>Hg.vcsSbsDiff</h4>
2433 <b>vcsSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
2434
2435 <p>
2436 Public method used to view the difference of a file to the Mercurial
2437 repository side-by-side.
2438 </p>
2439 <dl>
2440
2441 <dt><i>name</i></dt>
2442 <dd>
2443 file name to be diffed (string)
2444 </dd>
2445 <dt><i>extended</i></dt>
2446 <dd>
2447 flag indicating the extended variant (boolean)
2448 </dd>
2449 <dt><i>revisions</i></dt>
2450 <dd>
2451 tuple of two revisions (tuple of strings)
2452 </dd>
2453 </dl>
2454 <dl>
2455
2456 <dt>Raises <b>ValueError</b>:</dt>
2457 <dd>
2458 raised to indicate an invalid name parameter
2459 </dd>
2460 </dl>
2456 <a NAME="Hg.vcsShutdown" ID="Hg.vcsShutdown"></a> 2461 <a NAME="Hg.vcsShutdown" ID="Hg.vcsShutdown"></a>
2457 <h4>Hg.vcsShutdown</h4> 2462 <h4>Hg.vcsShutdown</h4>
2458 <b>vcsShutdown</b>(<i></i>) 2463 <b>vcsShutdown</b>(<i></i>)
2459 2464
2460 <p> 2465 <p>

eric ide

mercurial