eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html

branch
eric7
changeset 8623
fced5aa98d41
parent 8596
d64760b2da50
child 8652
8cacde11f4fd
equal deleted inserted replaced
8622:149d51870ce8 8623:fced5aa98d41
297 <tr> 297 <tr>
298 <td><a href="#Git.gitRenameRemote">gitRenameRemote</a></td> 298 <td><a href="#Git.gitRenameRemote">gitRenameRemote</a></td>
299 <td>Public method to rename a remote repository.</td> 299 <td>Public method to rename a remote repository.</td>
300 </tr> 300 </tr>
301 <tr> 301 <tr>
302 <td><a href="#Git.gitRevert">gitRevert</a></td>
303 <td>Public method used to revert changes made to a file/directory.</td>
304 </tr>
305 <tr>
306 <td><a href="#Git.gitSbsDiff">gitSbsDiff</a></td>
307 <td>Public method used to view the difference of a file to the Git repository side-by-side.</td>
308 </tr>
309 <tr>
310 <td><a href="#Git.gitShortlog">gitShortlog</a></td> 302 <td><a href="#Git.gitShortlog">gitShortlog</a></td>
311 <td>Public method to show a short log suitable for inclusion in release announcements.</td> 303 <td>Public method to show a short log suitable for inclusion in release announcements.</td>
312 </tr> 304 </tr>
313 <tr> 305 <tr>
314 <td><a href="#Git.gitShowBranch">gitShowBranch</a></td> 306 <td><a href="#Git.gitShowBranch">gitShowBranch</a></td>
465 <tr> 457 <tr>
466 <td><a href="#Git.vcsExport">vcsExport</a></td> 458 <td><a href="#Git.vcsExport">vcsExport</a></td>
467 <td>Public method used to export a directory from the Git repository.</td> 459 <td>Public method used to export a directory from the Git repository.</td>
468 </tr> 460 </tr>
469 <tr> 461 <tr>
462 <td><a href="#Git.vcsForget">vcsForget</a></td>
463 <td>Public method used to remove a file from the Mercurial repository.</td>
464 </tr>
465 <tr>
470 <td><a href="#Git.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td> 466 <td><a href="#Git.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
471 <td>Public method to instantiate a helper object for the different project browsers.</td> 467 <td>Public method to instantiate a helper object for the different project browsers.</td>
472 </tr> 468 </tr>
473 <tr> 469 <tr>
474 <td><a href="#Git.vcsGetProjectHelper">vcsGetProjectHelper</a></td> 470 <td><a href="#Git.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
519 <td>Public method used to remove a file/directory from the Git repository.</td> 515 <td>Public method used to remove a file/directory from the Git repository.</td>
520 </tr> 516 </tr>
521 <tr> 517 <tr>
522 <td><a href="#Git.vcsRepositoryInfos">vcsRepositoryInfos</a></td> 518 <td><a href="#Git.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
523 <td>Public method to retrieve information about the repository.</td> 519 <td>Public method to retrieve information about the repository.</td>
520 </tr>
521 <tr>
522 <td><a href="#Git.vcsRevert">vcsRevert</a></td>
523 <td>Public method used to revert changes made to a file/directory.</td>
524 </tr>
525 <tr>
526 <td><a href="#Git.vcsSbsDiff">vcsSbsDiff</a></td>
527 <td>Public method used to view the difference of a file to the Git repository side-by-side.</td>
524 </tr> 528 </tr>
525 <tr> 529 <tr>
526 <td><a href="#Git.vcsShutdown">vcsShutdown</a></td> 530 <td><a href="#Git.vcsShutdown">vcsShutdown</a></td>
527 <td>Public method used to shutdown the Git interface.</td> 531 <td>Public method used to shutdown the Git interface.</td>
528 </tr> 532 </tr>
1731 <dt><i>remoteName</i></dt> 1735 <dt><i>remoteName</i></dt>
1732 <dd> 1736 <dd>
1733 name of the remote repository (string) 1737 name of the remote repository (string)
1734 </dd> 1738 </dd>
1735 </dl> 1739 </dl>
1736 <a NAME="Git.gitRevert" ID="Git.gitRevert"></a>
1737 <h4>Git.gitRevert</h4>
1738 <b>gitRevert</b>(<i>name</i>)
1739
1740 <p>
1741 Public method used to revert changes made to a file/directory.
1742 </p>
1743 <dl>
1744
1745 <dt><i>name</i></dt>
1746 <dd>
1747 file/directory name to be reverted (string)
1748 </dd>
1749 </dl>
1750 <dl>
1751 <dt>Return:</dt>
1752 <dd>
1753 flag indicating, that the update contained an add
1754 or delete (boolean)
1755 </dd>
1756 </dl>
1757 <a NAME="Git.gitSbsDiff" ID="Git.gitSbsDiff"></a>
1758 <h4>Git.gitSbsDiff</h4>
1759 <b>gitSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
1760
1761 <p>
1762 Public method used to view the difference of a file to the Git
1763 repository side-by-side.
1764 </p>
1765 <dl>
1766
1767 <dt><i>name</i></dt>
1768 <dd>
1769 file name to be diffed (string)
1770 </dd>
1771 <dt><i>extended</i></dt>
1772 <dd>
1773 flag indicating the extended variant (boolean)
1774 </dd>
1775 <dt><i>revisions</i></dt>
1776 <dd>
1777 tuple of two revisions (tuple of strings)
1778 </dd>
1779 </dl>
1780 <dl>
1781
1782 <dt>Raises <b>ValueError</b>:</dt>
1783 <dd>
1784 raised to indicate an invalid name parameter
1785 </dd>
1786 </dl>
1787 <a NAME="Git.gitShortlog" ID="Git.gitShortlog"></a> 1740 <a NAME="Git.gitShortlog" ID="Git.gitShortlog"></a>
1788 <h4>Git.gitShortlog</h4> 1741 <h4>Git.gitShortlog</h4>
1789 <b>gitShortlog</b>(<i>projectDir, commit</i>) 1742 <b>gitShortlog</b>(<i>projectDir, commit</i>)
1790 1743
1791 <p> 1744 <p>
2529 <dt>Return:</dt> 2482 <dt>Return:</dt>
2530 <dd> 2483 <dd>
2531 flag indicating an execution without errors (boolean) 2484 flag indicating an execution without errors (boolean)
2532 </dd> 2485 </dd>
2533 </dl> 2486 </dl>
2487 <a NAME="Git.vcsForget" ID="Git.vcsForget"></a>
2488 <h4>Git.vcsForget</h4>
2489 <b>vcsForget</b>(<i>name</i>)
2490
2491 <p>
2492 Public method used to remove a file from the Mercurial repository.
2493 </p>
2494 <p>
2495 This will not remove the file from the project directory.
2496 </p>
2497 <dl>
2498
2499 <dt><i>name</i> (str or list of str)</dt>
2500 <dd>
2501 file/directory name to be removed
2502 </dd>
2503 </dl>
2534 <a NAME="Git.vcsGetProjectBrowserHelper" ID="Git.vcsGetProjectBrowserHelper"></a> 2504 <a NAME="Git.vcsGetProjectBrowserHelper" ID="Git.vcsGetProjectBrowserHelper"></a>
2535 <h4>Git.vcsGetProjectBrowserHelper</h4> 2505 <h4>Git.vcsGetProjectBrowserHelper</h4>
2536 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) 2506 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
2537 2507
2538 <p> 2508 <p>
2877 <dt>Return:</dt> 2847 <dt>Return:</dt>
2878 <dd> 2848 <dd>
2879 string with ready formated info for display (string) 2849 string with ready formated info for display (string)
2880 </dd> 2850 </dd>
2881 </dl> 2851 </dl>
2852 <a NAME="Git.vcsRevert" ID="Git.vcsRevert"></a>
2853 <h4>Git.vcsRevert</h4>
2854 <b>vcsRevert</b>(<i>name</i>)
2855
2856 <p>
2857 Public method used to revert changes made to a file/directory.
2858 </p>
2859 <dl>
2860
2861 <dt><i>name</i> (str)</dt>
2862 <dd>
2863 file/directory name to be reverted
2864 </dd>
2865 </dl>
2866 <dl>
2867 <dt>Return:</dt>
2868 <dd>
2869 flag indicating, that the update contained an add
2870 or delete
2871 </dd>
2872 </dl>
2873 <dl>
2874 <dt>Return Type:</dt>
2875 <dd>
2876 bool
2877 </dd>
2878 </dl>
2879 <a NAME="Git.vcsSbsDiff" ID="Git.vcsSbsDiff"></a>
2880 <h4>Git.vcsSbsDiff</h4>
2881 <b>vcsSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
2882
2883 <p>
2884 Public method used to view the difference of a file to the Git
2885 repository side-by-side.
2886 </p>
2887 <dl>
2888
2889 <dt><i>name</i></dt>
2890 <dd>
2891 file name to be diffed (string)
2892 </dd>
2893 <dt><i>extended</i></dt>
2894 <dd>
2895 flag indicating the extended variant (boolean)
2896 </dd>
2897 <dt><i>revisions</i></dt>
2898 <dd>
2899 tuple of two revisions (tuple of strings)
2900 </dd>
2901 </dl>
2902 <dl>
2903
2904 <dt>Raises <b>ValueError</b>:</dt>
2905 <dd>
2906 raised to indicate an invalid name parameter
2907 </dd>
2908 </dl>
2882 <a NAME="Git.vcsShutdown" ID="Git.vcsShutdown"></a> 2909 <a NAME="Git.vcsShutdown" ID="Git.vcsShutdown"></a>
2883 <h4>Git.vcsShutdown</h4> 2910 <h4>Git.vcsShutdown</h4>
2884 <b>vcsShutdown</b>(<i></i>) 2911 <b>vcsShutdown</b>(<i></i>)
2885 2912
2886 <p> 2913 <p>

eric ide

mercurial