Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html

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

branch
eric7
changeset 10070
9f5758c0fec1
parent 9421
989ee2535d59
child 10215
d476667171a1
equal deleted inserted replaced
10069:435cc5875135 10070:9f5758c0fec1
392 <td><a href="#Hg.stopClient">stopClient</a></td> 392 <td><a href="#Hg.stopClient">stopClient</a></td>
393 <td>Public method to stop the command server client.</td> 393 <td>Public method to stop the command server client.</td>
394 </tr> 394 </tr>
395 <tr> 395 <tr>
396 <td><a href="#Hg.vcsAdd">vcsAdd</a></td> 396 <td><a href="#Hg.vcsAdd">vcsAdd</a></td>
397 <td>Public method used to add a file/directory to the Mercurial repository.</td> 397 <td></td>
398 </tr> 398 </tr>
399 <tr> 399 <tr>
400 <td><a href="#Hg.vcsAddBinary">vcsAddBinary</a></td> 400 <td><a href="#Hg.vcsAddBinary">vcsAddBinary</a></td>
401 <td>Public method used to add a file/directory in binary mode to the Mercurial repository.</td> 401 <td>Public method used to add a file/directory in binary mode to the Mercurial repository.</td>
402 </tr> 402 </tr>
408 <td><a href="#Hg.vcsAddTree">vcsAddTree</a></td> 408 <td><a href="#Hg.vcsAddTree">vcsAddTree</a></td>
409 <td>Public method to add a directory tree rooted at path to the Mercurial repository.</td> 409 <td>Public method to add a directory tree rooted at path to the Mercurial repository.</td>
410 </tr> 410 </tr>
411 <tr> 411 <tr>
412 <td><a href="#Hg.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td> 412 <td><a href="#Hg.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
413 <td>Public method used to get the registered states of a number of files in the vcs.</td> 413 <td></td>
414 </tr> 414 </tr>
415 <tr> 415 <tr>
416 <td><a href="#Hg.vcsCheckout">vcsCheckout</a></td> 416 <td><a href="#Hg.vcsCheckout">vcsCheckout</a></td>
417 <td>Public method used to check the project out of a Mercurial repository (clone).</td> 417 <td>Public method used to check the project out of a Mercurial repository (clone).</td>
418 </tr> 418 </tr>
468 <td><a href="#Hg.vcsImport">vcsImport</a></td> 468 <td><a href="#Hg.vcsImport">vcsImport</a></td>
469 <td>Public method used to import the project into the Mercurial repository.</td> 469 <td>Public method used to import the project into the Mercurial repository.</td>
470 </tr> 470 </tr>
471 <tr> 471 <tr>
472 <td><a href="#Hg.vcsInit">vcsInit</a></td> 472 <td><a href="#Hg.vcsInit">vcsInit</a></td>
473 <td>Public method used to initialize the mercurial repository.</td> 473 <td></td>
474 </tr> 474 </tr>
475 <tr> 475 <tr>
476 <td><a href="#Hg.vcsInitConfig">vcsInitConfig</a></td> 476 <td><a href="#Hg.vcsInitConfig">vcsInitConfig</a></td>
477 <td>Public method to initialize the VCS configuration.</td> 477 <td>Public method to initialize the VCS configuration.</td>
478 </tr> 478 </tr>
480 <td><a href="#Hg.vcsLogBrowser">vcsLogBrowser</a></td> 480 <td><a href="#Hg.vcsLogBrowser">vcsLogBrowser</a></td>
481 <td>Public method used to browse the log of a file/directory from the Mercurial repository.</td> 481 <td>Public method used to browse the log of a file/directory from the Mercurial repository.</td>
482 </tr> 482 </tr>
483 <tr> 483 <tr>
484 <td><a href="#Hg.vcsMerge">vcsMerge</a></td> 484 <td><a href="#Hg.vcsMerge">vcsMerge</a></td>
485 <td>Public method used to merge a URL/revision into the local project.</td> 485 <td></td>
486 </tr> 486 </tr>
487 <tr> 487 <tr>
488 <td><a href="#Hg.vcsMove">vcsMove</a></td> 488 <td><a href="#Hg.vcsMove">vcsMove</a></td>
489 <td>Public method used to move a file/directory.</td> 489 <td>Public method used to move a file/directory.</td>
490 </tr> 490 </tr>
504 <td><a href="#Hg.vcsRegisteredState">vcsRegisteredState</a></td> 504 <td><a href="#Hg.vcsRegisteredState">vcsRegisteredState</a></td>
505 <td>Public method used to get the registered state of a file in the vcs.</td> 505 <td>Public method used to get the registered state of a file in the vcs.</td>
506 </tr> 506 </tr>
507 <tr> 507 <tr>
508 <td><a href="#Hg.vcsRemove">vcsRemove</a></td> 508 <td><a href="#Hg.vcsRemove">vcsRemove</a></td>
509 <td>Public method used to remove a file/directory from the Mercurial repository.</td> 509 <td></td>
510 </tr> 510 </tr>
511 <tr> 511 <tr>
512 <td><a href="#Hg.vcsRepositoryInfos">vcsRepositoryInfos</a></td> 512 <td><a href="#Hg.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
513 <td>Public method to retrieve information about the repository.</td> 513 <td></td>
514 </tr> 514 </tr>
515 <tr> 515 <tr>
516 <td><a href="#Hg.vcsResolved">vcsResolved</a></td> 516 <td><a href="#Hg.vcsResolved">vcsResolved</a></td>
517 <td>Public method used to resolve conflicts of a file/directory.</td> 517 <td>Public method used to resolve conflicts of a file/directory.</td>
518 </tr> 518 </tr>
540 <td><a href="#Hg.vcsSwitch">vcsSwitch</a></td> 540 <td><a href="#Hg.vcsSwitch">vcsSwitch</a></td>
541 <td>Public method used to switch a working directory to a different revision.</td> 541 <td>Public method used to switch a working directory to a different revision.</td>
542 </tr> 542 </tr>
543 <tr> 543 <tr>
544 <td><a href="#Hg.vcsTag">vcsTag</a></td> 544 <td><a href="#Hg.vcsTag">vcsTag</a></td>
545 <td>Public method used to set/remove a tag in the Mercurial repository.</td> 545 <td></td>
546 </tr> 546 </tr>
547 <tr> 547 <tr>
548 <td><a href="#Hg.vcsUpdate">vcsUpdate</a></td> 548 <td><a href="#Hg.vcsUpdate">vcsUpdate</a></td>
549 <td>Public method used to update a file/directory with the Mercurial repository.</td> 549 <td></td>
550 </tr> 550 </tr>
551 </table> 551 </table>
552 <h3>Static Methods</h3> 552 <h3>Static Methods</h3>
553 553
554 <table> 554 <table>
1742 </p> 1742 </p>
1743 <a NAME="Hg.vcsAdd" ID="Hg.vcsAdd"></a> 1743 <a NAME="Hg.vcsAdd" ID="Hg.vcsAdd"></a>
1744 <h4>Hg.vcsAdd</h4> 1744 <h4>Hg.vcsAdd</h4>
1745 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) 1745 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
1746 1746
1747 <p>
1748 Public method used to add a file/directory to the Mercurial repository.
1749 </p>
1750 <dl>
1751
1752 <dt><i>name</i></dt>
1753 <dd>
1754 file/directory name to be added (string)
1755 </dd>
1756 <dt><i>isDir</i></dt>
1757 <dd>
1758 flag indicating name is a directory (boolean)
1759 </dd>
1760 <dt><i>noDialog</i></dt>
1761 <dd>
1762 flag indicating quiet operations
1763 </dd>
1764 </dl>
1765 <a NAME="Hg.vcsAddBinary" ID="Hg.vcsAddBinary"></a> 1747 <a NAME="Hg.vcsAddBinary" ID="Hg.vcsAddBinary"></a>
1766 <h4>Hg.vcsAddBinary</h4> 1748 <h4>Hg.vcsAddBinary</h4>
1767 <b>vcsAddBinary</b>(<i>name, isDir=False</i>) 1749 <b>vcsAddBinary</b>(<i>name, isDir=False</i>)
1768 1750
1769 <p> 1751 <p>
1813 </dl> 1795 </dl>
1814 <a NAME="Hg.vcsAllRegisteredStates" ID="Hg.vcsAllRegisteredStates"></a> 1796 <a NAME="Hg.vcsAllRegisteredStates" ID="Hg.vcsAllRegisteredStates"></a>
1815 <h4>Hg.vcsAllRegisteredStates</h4> 1797 <h4>Hg.vcsAllRegisteredStates</h4>
1816 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) 1798 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>)
1817 1799
1818 <p>
1819 Public method used to get the registered states of a number of files
1820 in the vcs.
1821 </p>
1822 <p>
1823 <b>Note:</b> If a shortcut is to be taken, the code will only check,
1824 if the named directory has been scanned already. If so, it is assumed,
1825 that the states for all files have been populated by the previous run.
1826 </p>
1827 <dl>
1828
1829 <dt><i>names</i></dt>
1830 <dd>
1831 dictionary with all filenames to be checked as keys
1832 </dd>
1833 <dt><i>dname</i></dt>
1834 <dd>
1835 directory to check in (string)
1836 </dd>
1837 <dt><i>shortcut</i></dt>
1838 <dd>
1839 flag indicating a shortcut should be taken (boolean)
1840 </dd>
1841 </dl>
1842 <dl>
1843 <dt>Return:</dt>
1844 <dd>
1845 the received dictionary completed with a combination of
1846 canBeCommited and canBeAdded or None in order to signal an error
1847 </dd>
1848 </dl>
1849 <a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a> 1800 <a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a>
1850 <h4>Hg.vcsCheckout</h4> 1801 <h4>Hg.vcsCheckout</h4>
1851 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) 1802 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
1852 1803
1853 <p> 1804 <p>
2155 </dl> 2106 </dl>
2156 <a NAME="Hg.vcsInit" ID="Hg.vcsInit"></a> 2107 <a NAME="Hg.vcsInit" ID="Hg.vcsInit"></a>
2157 <h4>Hg.vcsInit</h4> 2108 <h4>Hg.vcsInit</h4>
2158 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) 2109 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
2159 2110
2160 <p>
2161 Public method used to initialize the mercurial repository.
2162 </p>
2163 <p>
2164 The initialization is done, when a project is converted into a
2165 Mercurial controlled project. Therefore we always return TRUE without
2166 doing anything.
2167 </p>
2168 <dl>
2169
2170 <dt><i>vcsDir</i></dt>
2171 <dd>
2172 name of the VCS directory (string)
2173 </dd>
2174 <dt><i>noDialog</i></dt>
2175 <dd>
2176 flag indicating quiet operations (boolean)
2177 </dd>
2178 </dl>
2179 <dl>
2180 <dt>Return:</dt>
2181 <dd>
2182 always TRUE
2183 </dd>
2184 </dl>
2185 <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a> 2111 <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a>
2186 <h4>Hg.vcsInitConfig</h4> 2112 <h4>Hg.vcsInitConfig</h4>
2187 <b>vcsInitConfig</b>(<i>project</i>) 2113 <b>vcsInitConfig</b>(<i>project</i>)
2188 2114
2189 <p> 2115 <p>
2221 </dl> 2147 </dl>
2222 <a NAME="Hg.vcsMerge" ID="Hg.vcsMerge"></a> 2148 <a NAME="Hg.vcsMerge" ID="Hg.vcsMerge"></a>
2223 <h4>Hg.vcsMerge</h4> 2149 <h4>Hg.vcsMerge</h4>
2224 <b>vcsMerge</b>(<i>name, rev=""</i>) 2150 <b>vcsMerge</b>(<i>name, rev=""</i>)
2225 2151
2226 <p>
2227 Public method used to merge a URL/revision into the local project.
2228 </p>
2229 <dl>
2230
2231 <dt><i>name</i> (str)</dt>
2232 <dd>
2233 file/directory name to be merged
2234 </dd>
2235 <dt><i>rev</i> (str)</dt>
2236 <dd>
2237 revision to merge with
2238 </dd>
2239 </dl>
2240 <a NAME="Hg.vcsMove" ID="Hg.vcsMove"></a> 2152 <a NAME="Hg.vcsMove" ID="Hg.vcsMove"></a>
2241 <h4>Hg.vcsMove</h4> 2153 <h4>Hg.vcsMove</h4>
2242 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) 2154 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>)
2243 2155
2244 <p> 2156 <p>
2365 </dl> 2277 </dl>
2366 <a NAME="Hg.vcsRemove" ID="Hg.vcsRemove"></a> 2278 <a NAME="Hg.vcsRemove" ID="Hg.vcsRemove"></a>
2367 <h4>Hg.vcsRemove</h4> 2279 <h4>Hg.vcsRemove</h4>
2368 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) 2280 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
2369 2281
2370 <p>
2371 Public method used to remove a file/directory from the Mercurial
2372 repository.
2373 </p>
2374 <p>
2375 The default operation is to remove the local copy as well.
2376 </p>
2377 <dl>
2378
2379 <dt><i>name</i></dt>
2380 <dd>
2381 file/directory name to be removed (string or list of
2382 strings))
2383 </dd>
2384 <dt><i>project</i></dt>
2385 <dd>
2386 flag indicating deletion of a project tree (boolean)
2387 (not needed)
2388 </dd>
2389 <dt><i>noDialog</i></dt>
2390 <dd>
2391 flag indicating quiet operations
2392 </dd>
2393 </dl>
2394 <dl>
2395 <dt>Return:</dt>
2396 <dd>
2397 flag indicating successfull operation (boolean)
2398 </dd>
2399 </dl>
2400 <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a> 2282 <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a>
2401 <h4>Hg.vcsRepositoryInfos</h4> 2283 <h4>Hg.vcsRepositoryInfos</h4>
2402 <b>vcsRepositoryInfos</b>(<i>ppath</i>) 2284 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
2403 2285
2404 <p>
2405 Public method to retrieve information about the repository.
2406 </p>
2407 <dl>
2408
2409 <dt><i>ppath</i></dt>
2410 <dd>
2411 local path to get the repository infos (string)
2412 </dd>
2413 </dl>
2414 <dl>
2415 <dt>Return:</dt>
2416 <dd>
2417 string with ready formated info for display (string)
2418 </dd>
2419 </dl>
2420 <a NAME="Hg.vcsResolved" ID="Hg.vcsResolved"></a> 2286 <a NAME="Hg.vcsResolved" ID="Hg.vcsResolved"></a>
2421 <h4>Hg.vcsResolved</h4> 2287 <h4>Hg.vcsResolved</h4>
2422 <b>vcsResolved</b>(<i>name, unresolve=False</i>) 2288 <b>vcsResolved</b>(<i>name, unresolve=False</i>)
2423 2289
2424 <p> 2290 <p>
2554 </dl> 2420 </dl>
2555 <a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a> 2421 <a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a>
2556 <h4>Hg.vcsTag</h4> 2422 <h4>Hg.vcsTag</h4>
2557 <b>vcsTag</b>(<i>name=None, revision=None, tagName=None</i>) 2423 <b>vcsTag</b>(<i>name=None, revision=None, tagName=None</i>)
2558 2424
2559 <p>
2560 Public method used to set/remove a tag in the Mercurial repository.
2561 </p>
2562 <dl>
2563
2564 <dt><i>name</i></dt>
2565 <dd>
2566 file/directory name to determine the repo root from
2567 (string)
2568 </dd>
2569 <dt><i>revision</i></dt>
2570 <dd>
2571 revision to set tag for (string)
2572 </dd>
2573 <dt><i>tagName</i></dt>
2574 <dd>
2575 name of the tag (string)
2576 </dd>
2577 </dl>
2578 <dl>
2579 <dt>Return:</dt>
2580 <dd>
2581 flag indicating a performed tag action (boolean)
2582 </dd>
2583 </dl>
2584 <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a> 2425 <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a>
2585 <h4>Hg.vcsUpdate</h4> 2426 <h4>Hg.vcsUpdate</h4>
2586 <b>vcsUpdate</b>(<i>name=None, noDialog=False, revision=None</i>) 2427 <b>vcsUpdate</b>(<i>name=None, noDialog=False, revision=None</i>)
2587 2428
2588 <p>
2589 Public method used to update a file/directory with the Mercurial
2590 repository.
2591 </p>
2592 <dl>
2593
2594 <dt><i>name</i></dt>
2595 <dd>
2596 file/directory name to be updated (not used)
2597 </dd>
2598 <dt><i>noDialog</i></dt>
2599 <dd>
2600 flag indicating quiet operations (boolean)
2601 </dd>
2602 <dt><i>revision</i></dt>
2603 <dd>
2604 revision to update to (string)
2605 </dd>
2606 </dl>
2607 <dl>
2608 <dt>Return:</dt>
2609 <dd>
2610 flag indicating, that the update contained an add
2611 or delete (boolean)
2612 </dd>
2613 </dl>
2614 <div align="right"><a href="#top">Up</a></div> 2429 <div align="right"><a href="#top">Up</a></div>
2615 <hr /> 2430 <hr />
2616 </body></html> 2431 </body></html>

Mercurial Repository: eric

eric ide

mercurial