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

changeset 7989
a21d673a8f99
parent 7900
72b88fb20261
equal deleted inserted replaced
7988:c4c17121eff8 7989:a21d673a8f99
607 <dd> 607 <dd>
608 revision to retrieve (string) 608 revision to retrieve (string)
609 </dd> 609 </dd>
610 </dl> 610 </dl>
611 <dl> 611 <dl>
612 <dt>Returns:</dt> 612 <dt>Return:</dt>
613 <dd> 613 <dd>
614 contents of the file (string) and an error message (string) 614 contents of the file (string) and an error message (string)
615 </dd> 615 </dd>
616 </dl> 616 </dl>
617 <a NAME="Git.__gitGetStashesList" ID="Git.__gitGetStashesList"></a> 617 <a NAME="Git.__gitGetStashesList" ID="Git.__gitGetStashesList"></a>
627 <dd> 627 <dd>
628 name of the project directory (string) 628 name of the project directory (string)
629 </dd> 629 </dd>
630 </dl> 630 </dl>
631 <dl> 631 <dl>
632 <dt>Returns:</dt> 632 <dt>Return:</dt>
633 <dd> 633 <dd>
634 list of available stashes (list of string) 634 list of available stashes (list of string)
635 </dd> 635 </dd>
636 </dl> 636 </dl>
637 <a NAME="Git.__gitSubmodulesList" ID="Git.__gitSubmodulesList"></a> 637 <a NAME="Git.__gitSubmodulesList" ID="Git.__gitSubmodulesList"></a>
647 <dd> 647 <dd>
648 name of the directory containing the repo subdirectory 648 name of the directory containing the repo subdirectory
649 </dd> 649 </dd>
650 </dl> 650 </dl>
651 <dl> 651 <dl>
652 <dt>Returns:</dt> 652 <dt>Return:</dt>
653 <dd> 653 <dd>
654 list of dictionaries with submodule name, path, URL and branch 654 list of dictionaries with submodule name, path, URL and branch
655 </dd> 655 </dd>
656 </dl> 656 </dl>
657 <dl> 657 <dl>
673 <dd> 673 <dd>
674 name of the directory containing the repo subdirectory 674 name of the directory containing the repo subdirectory
675 </dd> 675 </dd>
676 </dl> 676 </dl>
677 <dl> 677 <dl>
678 <dt>Returns:</dt> 678 <dt>Return:</dt>
679 <dd> 679 <dd>
680 tuple of selected submodule path and flag indicating 680 tuple of selected submodule path and flag indicating
681 a cancellation 681 a cancellation
682 </dd> 682 </dd>
683 </dl> 683 </dl>
700 <dd> 700 <dd>
701 name of the directory containing the repo subdirectory 701 name of the directory containing the repo subdirectory
702 </dd> 702 </dd>
703 </dl> 703 </dl>
704 <dl> 704 <dl>
705 <dt>Returns:</dt> 705 <dt>Return:</dt>
706 <dd> 706 <dd>
707 tuple of selected submodule paths and flag indicating 707 tuple of selected submodule paths and flag indicating
708 a cancellation 708 a cancellation
709 </dd> 709 </dd>
710 </dl> 710 </dl>
740 <dd> 740 <dd>
741 reference to the project object (Project) 741 reference to the project object (Project)
742 </dd> 742 </dd>
743 </dl> 743 </dl>
744 <dl> 744 <dl>
745 <dt>Returns:</dt> 745 <dt>Return:</dt>
746 <dd> 746 <dd>
747 reference to the monitor thread (QThread) 747 reference to the monitor thread (QThread)
748 </dd> 748 </dd>
749 </dl> 749 </dl>
750 <a NAME="Git.clearStatusCache" ID="Git.clearStatusCache"></a> 750 <a NAME="Git.clearStatusCache" ID="Git.clearStatusCache"></a>
760 760
761 <p> 761 <p>
762 Public method to get a reference to the plugin object. 762 Public method to get a reference to the plugin object.
763 </p> 763 </p>
764 <dl> 764 <dl>
765 <dt>Returns:</dt> 765 <dt>Return:</dt>
766 <dd> 766 <dd>
767 reference to the plugin object (VcsGitPlugin) 767 reference to the plugin object (VcsGitPlugin)
768 </dd> 768 </dd>
769 </dl> 769 </dl>
770 <a NAME="Git.gitAddRemote" ID="Git.gitAddRemote"></a> 770 <a NAME="Git.gitAddRemote" ID="Git.gitAddRemote"></a>
849 name of the subcommand (string, one of 'start', 849 name of the subcommand (string, one of 'start',
850 'start_extended', 'good', 'bad', 'skip' or 'reset') 850 'start_extended', 'good', 'bad', 'skip' or 'reset')
851 </dd> 851 </dd>
852 </dl> 852 </dl>
853 <dl> 853 <dl>
854 <dt>Returns:</dt> 854 <dt>Return:</dt>
855 <dd> 855 <dd>
856 flag indicating, that the update contained an add 856 flag indicating, that the update contained an add
857 or delete (boolean) 857 or delete (boolean)
858 </dd> 858 </dd>
859 </dl> 859 </dl>
919 <dd> 919 <dd>
920 name of the project directory (string) 920 name of the project directory (string)
921 </dd> 921 </dd>
922 </dl> 922 </dl>
923 <dl> 923 <dl>
924 <dt>Returns:</dt> 924 <dt>Return:</dt>
925 <dd> 925 <dd>
926 flag indicating, that the update contained an add 926 flag indicating, that the update contained an add
927 or delete (boolean) 927 or delete (boolean)
928 </dd> 928 </dd>
929 </dl> 929 </dl>
967 <dd> 967 <dd>
968 desired branch operation (integer) 968 desired branch operation (integer)
969 </dd> 969 </dd>
970 </dl> 970 </dl>
971 <dl> 971 <dl>
972 <dt>Returns:</dt> 972 <dt>Return:</dt>
973 <dd> 973 <dd>
974 flag indicating a performed branch action (boolean) and 974 flag indicating a performed branch action (boolean) and
975 a flag indicating, that the branch operation contained an add 975 a flag indicating, that the branch operation contained an add
976 or delete (boolean) 976 or delete (boolean)
977 </dd> 977 </dd>
1033 <dd> 1033 <dd>
1034 name of the project directory (string) 1034 name of the project directory (string)
1035 </dd> 1035 </dd>
1036 </dl> 1036 </dl>
1037 <dl> 1037 <dl>
1038 <dt>Returns:</dt> 1038 <dt>Return:</dt>
1039 <dd> 1039 <dd>
1040 flag indicating, that the update contained an add 1040 flag indicating, that the update contained an add
1041 or delete (boolean) 1041 or delete (boolean)
1042 </dd> 1042 </dd>
1043 </dl> 1043 </dl>
1054 <dd> 1054 <dd>
1055 file/directory name (string) 1055 file/directory name (string)
1056 </dd> 1056 </dd>
1057 </dl> 1057 </dl>
1058 <dl> 1058 <dl>
1059 <dt>Returns:</dt> 1059 <dt>Return:</dt>
1060 <dd> 1060 <dd>
1061 flag indicating, that the cancellation contained an add 1061 flag indicating, that the cancellation contained an add
1062 or delete (boolean) 1062 or delete (boolean)
1063 </dd> 1063 </dd>
1064 </dl> 1064 </dl>
1124 <dd> 1124 <dd>
1125 list of commits to be applied (list of strings) 1125 list of commits to be applied (list of strings)
1126 </dd> 1126 </dd>
1127 </dl> 1127 </dl>
1128 <dl> 1128 <dl>
1129 <dt>Returns:</dt> 1129 <dt>Return:</dt>
1130 <dd> 1130 <dd>
1131 flag indicating that the project should be reread (boolean) 1131 flag indicating that the project should be reread (boolean)
1132 </dd> 1132 </dd>
1133 </dl> 1133 </dl>
1134 <a NAME="Git.gitCherryPickAbort" ID="Git.gitCherryPickAbort"></a> 1134 <a NAME="Git.gitCherryPickAbort" ID="Git.gitCherryPickAbort"></a>
1145 <dd> 1145 <dd>
1146 name of the project directory (string) 1146 name of the project directory (string)
1147 </dd> 1147 </dd>
1148 </dl> 1148 </dl>
1149 <dl> 1149 <dl>
1150 <dt>Returns:</dt> 1150 <dt>Return:</dt>
1151 <dd> 1151 <dd>
1152 flag indicating that the project should be reread (boolean) 1152 flag indicating that the project should be reread (boolean)
1153 </dd> 1153 </dd>
1154 </dl> 1154 </dl>
1155 <a NAME="Git.gitCherryPickContinue" ID="Git.gitCherryPickContinue"></a> 1155 <a NAME="Git.gitCherryPickContinue" ID="Git.gitCherryPickContinue"></a>
1166 <dd> 1166 <dd>
1167 name of the project directory (string) 1167 name of the project directory (string)
1168 </dd> 1168 </dd>
1169 </dl> 1169 </dl>
1170 <dl> 1170 <dl>
1171 <dt>Returns:</dt> 1171 <dt>Return:</dt>
1172 <dd> 1172 <dd>
1173 flag indicating that the project should be reread (boolean) 1173 flag indicating that the project should be reread (boolean)
1174 </dd> 1174 </dd>
1175 </dl> 1175 </dl>
1176 <a NAME="Git.gitCherryPickQuit" ID="Git.gitCherryPickQuit"></a> 1176 <a NAME="Git.gitCherryPickQuit" ID="Git.gitCherryPickQuit"></a>
1186 <dd> 1186 <dd>
1187 name of the project directory (string) 1187 name of the project directory (string)
1188 </dd> 1188 </dd>
1189 </dl> 1189 </dl>
1190 <dl> 1190 <dl>
1191 <dt>Returns:</dt> 1191 <dt>Return:</dt>
1192 <dd> 1192 <dd>
1193 flag indicating that the project should be reread (boolean) 1193 flag indicating that the project should be reread (boolean)
1194 </dd> 1194 </dd>
1195 </dl> 1195 </dl>
1196 <a NAME="Git.gitCommitMerge" ID="Git.gitCommitMerge"></a> 1196 <a NAME="Git.gitCommitMerge" ID="Git.gitCommitMerge"></a>
1224 <dd> 1224 <dd>
1225 reference to the project object 1225 reference to the project object
1226 </dd> 1226 </dd>
1227 </dl> 1227 </dl>
1228 <dl> 1228 <dl>
1229 <dt>Returns:</dt> 1229 <dt>Return:</dt>
1230 <dd> 1230 <dd>
1231 flag indicating successful operation (boolean) 1231 flag indicating successful operation (boolean)
1232 </dd> 1232 </dd>
1233 </dl> 1233 </dl>
1234 <a NAME="Git.gitCreateArchive" ID="Git.gitCreateArchive"></a> 1234 <a NAME="Git.gitCreateArchive" ID="Git.gitCreateArchive"></a>
1262 <dd> 1262 <dd>
1263 flag indicating to add it automatically (boolean) 1263 flag indicating to add it automatically (boolean)
1264 </dd> 1264 </dd>
1265 </dl> 1265 </dl>
1266 <dl> 1266 <dl>
1267 <dt>Returns:</dt> 1267 <dt>Return:</dt>
1268 <dd> 1268 <dd>
1269 flag indicating success 1269 flag indicating success
1270 </dd> 1270 </dd>
1271 </dl> 1271 </dl>
1272 <a NAME="Git.gitDeleteRemoteBranch" ID="Git.gitDeleteRemoteBranch"></a> 1272 <a NAME="Git.gitDeleteRemoteBranch" ID="Git.gitDeleteRemoteBranch"></a>
1374 <dd> 1374 <dd>
1375 directory name of the repository (string) 1375 directory name of the repository (string)
1376 </dd> 1376 </dd>
1377 </dl> 1377 </dl>
1378 <dl> 1378 <dl>
1379 <dt>Returns:</dt> 1379 <dt>Return:</dt>
1380 <dd> 1380 <dd>
1381 list of supported archive formats (list of strings) 1381 list of supported archive formats (list of strings)
1382 </dd> 1382 </dd>
1383 </dl> 1383 </dl>
1384 <a NAME="Git.gitGetBranchesList" ID="Git.gitGetBranchesList"></a> 1384 <a NAME="Git.gitGetBranchesList" ID="Git.gitGetBranchesList"></a>
1406 <dd> 1406 <dd>
1407 flag indicating to return remote branches only (boolean) 1407 flag indicating to return remote branches only (boolean)
1408 </dd> 1408 </dd>
1409 </dl> 1409 </dl>
1410 <dl> 1410 <dl>
1411 <dt>Returns:</dt> 1411 <dt>Return:</dt>
1412 <dd> 1412 <dd>
1413 list of branches (list of string) 1413 list of branches (list of string)
1414 </dd> 1414 </dd>
1415 </dl> 1415 </dl>
1416 <a NAME="Git.gitGetBundleHeads" ID="Git.gitGetBundleHeads"></a> 1416 <a NAME="Git.gitGetBundleHeads" ID="Git.gitGetBundleHeads"></a>
1430 <dd> 1430 <dd>
1431 file name of a git bundle file (string) 1431 file name of a git bundle file (string)
1432 </dd> 1432 </dd>
1433 </dl> 1433 </dl>
1434 <dl> 1434 <dl>
1435 <dt>Returns:</dt> 1435 <dt>Return:</dt>
1436 <dd> 1436 <dd>
1437 list of heads (list of strings) 1437 list of heads (list of strings)
1438 </dd> 1438 </dd>
1439 </dl> 1439 </dl>
1440 <a NAME="Git.gitGetCurrentBranch" ID="Git.gitGetCurrentBranch"></a> 1440 <a NAME="Git.gitGetCurrentBranch" ID="Git.gitGetCurrentBranch"></a>
1450 <dd> 1450 <dd>
1451 directory name of the repository (string) 1451 directory name of the repository (string)
1452 </dd> 1452 </dd>
1453 </dl> 1453 </dl>
1454 <dl> 1454 <dl>
1455 <dt>Returns:</dt> 1455 <dt>Return:</dt>
1456 <dd> 1456 <dd>
1457 name of the current branch (string) 1457 name of the current branch (string)
1458 </dd> 1458 </dd>
1459 </dl> 1459 </dl>
1460 <a NAME="Git.gitGetRemoteBranchesList" ID="Git.gitGetRemoteBranchesList"></a> 1460 <a NAME="Git.gitGetRemoteBranchesList" ID="Git.gitGetRemoteBranchesList"></a>
1474 <dd> 1474 <dd>
1475 remote repository name (string) 1475 remote repository name (string)
1476 </dd> 1476 </dd>
1477 </dl> 1477 </dl>
1478 <dl> 1478 <dl>
1479 <dt>Returns:</dt> 1479 <dt>Return:</dt>
1480 <dd> 1480 <dd>
1481 list of remote repository branches (list of string) 1481 list of remote repository branches (list of string)
1482 </dd> 1482 </dd>
1483 </dl> 1483 </dl>
1484 <a NAME="Git.gitGetRemoteUrl" ID="Git.gitGetRemoteUrl"></a> 1484 <a NAME="Git.gitGetRemoteUrl" ID="Git.gitGetRemoteUrl"></a>
1498 <dd> 1498 <dd>
1499 name of the remote repository 1499 name of the remote repository
1500 </dd> 1500 </dd>
1501 </dl> 1501 </dl>
1502 <dl> 1502 <dl>
1503 <dt>Returns:</dt> 1503 <dt>Return:</dt>
1504 <dd> 1504 <dd>
1505 URL of the remote repository 1505 URL of the remote repository
1506 </dd> 1506 </dd>
1507 </dl> 1507 </dl>
1508 <dl> 1508 <dl>
1528 <dd> 1528 <dd>
1529 flag indicating to get Fetch info (string) 1529 flag indicating to get Fetch info (string)
1530 </dd> 1530 </dd>
1531 </dl> 1531 </dl>
1532 <dl> 1532 <dl>
1533 <dt>Returns:</dt> 1533 <dt>Return:</dt>
1534 <dd> 1534 <dd>
1535 list of tuples of remote repo name and repo URL (list of 1535 list of tuples of remote repo name and repo URL (list of
1536 tuple of two strings) 1536 tuple of two strings)
1537 </dd> 1537 </dd>
1538 </dl> 1538 </dl>
1549 <dd> 1549 <dd>
1550 directory name of the repository (string) 1550 directory name of the repository (string)
1551 </dd> 1551 </dd>
1552 </dl> 1552 </dl>
1553 <dl> 1553 <dl>
1554 <dt>Returns:</dt> 1554 <dt>Return:</dt>
1555 <dd> 1555 <dd>
1556 list of remote repos (list of string) 1556 list of remote repos (list of string)
1557 </dd> 1557 </dd>
1558 </dl> 1558 </dl>
1559 <a NAME="Git.gitGetTagsList" ID="Git.gitGetTagsList"></a> 1559 <a NAME="Git.gitGetTagsList" ID="Git.gitGetTagsList"></a>
1573 <dd> 1573 <dd>
1574 flag indicating to get the tag type as well (boolean) 1574 flag indicating to get the tag type as well (boolean)
1575 </dd> 1575 </dd>
1576 </dl> 1576 </dl>
1577 <dl> 1577 <dl>
1578 <dt>Returns:</dt> 1578 <dt>Return:</dt>
1579 <dd> 1579 <dd>
1580 list of tags (list of string) or list of tuples of 1580 list of tags (list of string) or list of tuples of
1581 tag name and flag indicating a local tag (list of tuple of string 1581 tag name and flag indicating a local tag (list of tuple of string
1582 and boolean), if withType is True 1582 and boolean), if withType is True
1583 </dd> 1583 </dd>
1637 <dd> 1637 <dd>
1638 url string (string) 1638 url string (string)
1639 </dd> 1639 </dd>
1640 </dl> 1640 </dl>
1641 <dl> 1641 <dl>
1642 <dt>Returns:</dt> 1642 <dt>Return:</dt>
1643 <dd> 1643 <dd>
1644 properly normalized url for git (string) 1644 properly normalized url for git (string)
1645 </dd> 1645 </dd>
1646 </dl> 1646 </dl>
1647 <a NAME="Git.gitPruneRemote" ID="Git.gitPruneRemote"></a> 1647 <a NAME="Git.gitPruneRemote" ID="Git.gitPruneRemote"></a>
1675 <dd> 1675 <dd>
1676 directory name of the project to be pulled to (string) 1676 directory name of the project to be pulled to (string)
1677 </dd> 1677 </dd>
1678 </dl> 1678 </dl>
1679 <dl> 1679 <dl>
1680 <dt>Returns:</dt> 1680 <dt>Return:</dt>
1681 <dd> 1681 <dd>
1682 flag indicating, that the update contained an add 1682 flag indicating, that the update contained an add
1683 or delete (boolean) 1683 or delete (boolean)
1684 </dd> 1684 </dd>
1685 </dl> 1685 </dl>
1760 <dd> 1760 <dd>
1761 file/directory name to be reverted (string) 1761 file/directory name to be reverted (string)
1762 </dd> 1762 </dd>
1763 </dl> 1763 </dl>
1764 <dl> 1764 <dl>
1765 <dt>Returns:</dt> 1765 <dt>Return:</dt>
1766 <dd> 1766 <dd>
1767 flag indicating, that the update contained an add 1767 flag indicating, that the update contained an add
1768 or delete (boolean) 1768 or delete (boolean)
1769 </dd> 1769 </dd>
1770 </dl> 1770 </dl>
1908 <dd> 1908 <dd>
1909 name of a stash (string) 1909 name of a stash (string)
1910 </dd> 1910 </dd>
1911 </dl> 1911 </dl>
1912 <dl> 1912 <dl>
1913 <dt>Returns:</dt> 1913 <dt>Return:</dt>
1914 <dd> 1914 <dd>
1915 flag indicating, that the restore contained an add 1915 flag indicating, that the restore contained an add
1916 or delete (boolean) 1916 or delete (boolean)
1917 </dd> 1917 </dd>
1918 </dl> 1918 </dl>
1933 <dd> 1933 <dd>
1934 name of a stash (string) 1934 name of a stash (string)
1935 </dd> 1935 </dd>
1936 </dl> 1936 </dl>
1937 <dl> 1937 <dl>
1938 <dt>Returns:</dt> 1938 <dt>Return:</dt>
1939 <dd> 1939 <dd>
1940 flag indicating, that the restore contained an add 1940 flag indicating, that the restore contained an add
1941 or delete (boolean) 1941 or delete (boolean)
1942 </dd> 1942 </dd>
1943 </dl> 1943 </dl>
1968 <dd> 1968 <dd>
1969 name of the project directory (string) 1969 name of the project directory (string)
1970 </dd> 1970 </dd>
1971 </dl> 1971 </dl>
1972 <dl> 1972 <dl>
1973 <dt>Returns:</dt> 1973 <dt>Return:</dt>
1974 <dd> 1974 <dd>
1975 flag indicating a successful deletion (boolean) 1975 flag indicating a successful deletion (boolean)
1976 </dd> 1976 </dd>
1977 </dl> 1977 </dl>
1978 <a NAME="Git.gitStashDrop" ID="Git.gitStashDrop"></a> 1978 <a NAME="Git.gitStashDrop" ID="Git.gitStashDrop"></a>
1992 <dd> 1992 <dd>
1993 name of a stash (string) 1993 name of a stash (string)
1994 </dd> 1994 </dd>
1995 </dl> 1995 </dl>
1996 <dl> 1996 <dl>
1997 <dt>Returns:</dt> 1997 <dt>Return:</dt>
1998 <dd> 1998 <dd>
1999 flag indicating a successful deletion (boolean) 1999 flag indicating a successful deletion (boolean)
2000 </dd> 2000 </dd>
2001 </dl> 2001 </dl>
2002 <a NAME="Git.gitStashPop" ID="Git.gitStashPop"></a> 2002 <a NAME="Git.gitStashPop" ID="Git.gitStashPop"></a>
2016 <dd> 2016 <dd>
2017 name of a stash (string) 2017 name of a stash (string)
2018 </dd> 2018 </dd>
2019 </dl> 2019 </dl>
2020 <dl> 2020 <dl>
2021 <dt>Returns:</dt> 2021 <dt>Return:</dt>
2022 <dd> 2022 <dd>
2023 flag indicating, that the restore contained an add 2023 flag indicating, that the restore contained an add
2024 or delete (boolean) 2024 or delete (boolean)
2025 </dd> 2025 </dd>
2026 </dl> 2026 </dl>
2037 <dd> 2037 <dd>
2038 name of the project directory (string) 2038 name of the project directory (string)
2039 </dd> 2039 </dd>
2040 </dl> 2040 </dl>
2041 <dl> 2041 <dl>
2042 <dt>Returns:</dt> 2042 <dt>Return:</dt>
2043 <dd> 2043 <dd>
2044 flag indicating, that the save contained an add 2044 flag indicating, that the save contained an add
2045 or delete (boolean) 2045 or delete (boolean)
2046 </dd> 2046 </dd>
2047 </dl> 2047 </dl>
2225 <dd> 2225 <dd>
2226 file/directory name to be reverted (string) 2226 file/directory name to be reverted (string)
2227 </dd> 2227 </dd>
2228 </dl> 2228 </dl>
2229 <dl> 2229 <dl>
2230 <dt>Returns:</dt> 2230 <dt>Return:</dt>
2231 <dd> 2231 <dd>
2232 flag indicating, that the update contained an add 2232 flag indicating, that the update contained an add
2233 or delete (boolean) 2233 or delete (boolean)
2234 </dd> 2234 </dd>
2235 </dl> 2235 </dl>
2275 <dd> 2275 <dd>
2276 command name (string) 2276 command name (string)
2277 </dd> 2277 </dd>
2278 </dl> 2278 </dl>
2279 <dl> 2279 <dl>
2280 <dt>Returns:</dt> 2280 <dt>Return:</dt>
2281 <dd> 2281 <dd>
2282 list of command options (list of string) 2282 list of command options (list of string)
2283 </dd> 2283 </dd>
2284 </dl> 2284 </dl>
2285 <a NAME="Git.vcsAdd" ID="Git.vcsAdd"></a> 2285 <a NAME="Git.vcsAdd" ID="Git.vcsAdd"></a>
2366 <dd> 2366 <dd>
2367 flag indicating a shortcut should be taken (boolean) 2367 flag indicating a shortcut should be taken (boolean)
2368 </dd> 2368 </dd>
2369 </dl> 2369 </dl>
2370 <dl> 2370 <dl>
2371 <dt>Returns:</dt> 2371 <dt>Return:</dt>
2372 <dd> 2372 <dd>
2373 the received dictionary completed with a combination of 2373 the received dictionary completed with a combination of
2374 canBeCommited and canBeAdded or None in order to signal an error 2374 canBeCommited and canBeAdded or None in order to signal an error
2375 </dd> 2375 </dd>
2376 </dl> 2376 </dl>
2396 <dd> 2396 <dd>
2397 flag indicating quiet operations 2397 flag indicating quiet operations
2398 </dd> 2398 </dd>
2399 </dl> 2399 </dl>
2400 <dl> 2400 <dl>
2401 <dt>Returns:</dt> 2401 <dt>Return:</dt>
2402 <dd> 2402 <dd>
2403 flag indicating an execution without errors (boolean) 2403 flag indicating an execution without errors (boolean)
2404 </dd> 2404 </dd>
2405 </dl> 2405 </dl>
2406 <a NAME="Git.vcsCleanup" ID="Git.vcsCleanup"></a> 2406 <a NAME="Git.vcsCleanup" ID="Git.vcsCleanup"></a>
2513 2513
2514 <p> 2514 <p>
2515 Public method used to test for the presence of the git executable. 2515 Public method used to test for the presence of the git executable.
2516 </p> 2516 </p>
2517 <dl> 2517 <dl>
2518 <dt>Returns:</dt> 2518 <dt>Return:</dt>
2519 <dd> 2519 <dd>
2520 flag indicating the existance (boolean) and an error message 2520 flag indicating the existance (boolean) and an error message
2521 (string) 2521 (string)
2522 </dd> 2522 </dd>
2523 </dl> 2523 </dl>
2538 <dd> 2538 <dd>
2539 project directory to create (string) 2539 project directory to create (string)
2540 </dd> 2540 </dd>
2541 </dl> 2541 </dl>
2542 <dl> 2542 <dl>
2543 <dt>Returns:</dt> 2543 <dt>Return:</dt>
2544 <dd> 2544 <dd>
2545 flag indicating an execution without errors (boolean) 2545 flag indicating an execution without errors (boolean)
2546 </dd> 2546 </dd>
2547 </dl> 2547 </dl>
2548 <a NAME="Git.vcsGetProjectBrowserHelper" ID="Git.vcsGetProjectBrowserHelper"></a> 2548 <a NAME="Git.vcsGetProjectBrowserHelper" ID="Git.vcsGetProjectBrowserHelper"></a>
2568 flag indicating, the helper is requested 2568 flag indicating, the helper is requested
2569 for the translations browser (this needs some special treatment) 2569 for the translations browser (this needs some special treatment)
2570 </dd> 2570 </dd>
2571 </dl> 2571 </dl>
2572 <dl> 2572 <dl>
2573 <dt>Returns:</dt> 2573 <dt>Return:</dt>
2574 <dd> 2574 <dd>
2575 the project browser helper object 2575 the project browser helper object
2576 </dd> 2576 </dd>
2577 </dl> 2577 </dl>
2578 <a NAME="Git.vcsGetProjectHelper" ID="Git.vcsGetProjectHelper"></a> 2578 <a NAME="Git.vcsGetProjectHelper" ID="Git.vcsGetProjectHelper"></a>
2588 <dd> 2588 <dd>
2589 reference to the project object 2589 reference to the project object
2590 </dd> 2590 </dd>
2591 </dl> 2591 </dl>
2592 <dl> 2592 <dl>
2593 <dt>Returns:</dt> 2593 <dt>Return:</dt>
2594 <dd> 2594 <dd>
2595 the project helper object 2595 the project helper object
2596 </dd> 2596 </dd>
2597 </dl> 2597 </dl>
2598 <a NAME="Git.vcsImport" ID="Git.vcsImport"></a> 2598 <a NAME="Git.vcsImport" ID="Git.vcsImport"></a>
2620 <dd> 2620 <dd>
2621 flag indicating to add all files to the repository 2621 flag indicating to add all files to the repository
2622 </dd> 2622 </dd>
2623 </dl> 2623 </dl>
2624 <dl> 2624 <dl>
2625 <dt>Returns:</dt> 2625 <dt>Return:</dt>
2626 <dd> 2626 <dd>
2627 tuple containing a flag indicating an execution without errors 2627 tuple containing a flag indicating an execution without errors
2628 and a flag indicating the version controll status 2628 and a flag indicating the version controll status
2629 </dd> 2629 </dd>
2630 </dl> 2630 </dl>
2656 <dd> 2656 <dd>
2657 flag indicating quiet operations (boolean) 2657 flag indicating quiet operations (boolean)
2658 </dd> 2658 </dd>
2659 </dl> 2659 </dl>
2660 <dl> 2660 <dl>
2661 <dt>Returns:</dt> 2661 <dt>Return:</dt>
2662 <dd> 2662 <dd>
2663 always TRUE 2663 always TRUE
2664 </dd> 2664 </dd>
2665 </dl> 2665 </dl>
2666 <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a> 2666 <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a>
2739 <dd> 2739 <dd>
2740 flag indicating quiet operations 2740 flag indicating quiet operations
2741 </dd> 2741 </dd>
2742 </dl> 2742 </dl>
2743 <dl> 2743 <dl>
2744 <dt>Returns:</dt> 2744 <dt>Return:</dt>
2745 <dd> 2745 <dd>
2746 flag indicating successful operation (boolean) 2746 flag indicating successful operation (boolean)
2747 </dd> 2747 </dd>
2748 </dl> 2748 </dl>
2749 <a NAME="Git.vcsName" ID="Git.vcsName"></a> 2749 <a NAME="Git.vcsName" ID="Git.vcsName"></a>
2752 2752
2753 <p> 2753 <p>
2754 Public method returning the name of the vcs. 2754 Public method returning the name of the vcs.
2755 </p> 2755 </p>
2756 <dl> 2756 <dl>
2757 <dt>Returns:</dt> 2757 <dt>Return:</dt>
2758 <dd> 2758 <dd>
2759 always 'Git' (string) 2759 always 'Git' (string)
2760 </dd> 2760 </dd>
2761 </dl> 2761 </dl>
2762 <a NAME="Git.vcsNewProjectOptionsDialog" ID="Git.vcsNewProjectOptionsDialog"></a> 2762 <a NAME="Git.vcsNewProjectOptionsDialog" ID="Git.vcsNewProjectOptionsDialog"></a>
2773 <dd> 2773 <dd>
2774 parent widget (QWidget) 2774 parent widget (QWidget)
2775 </dd> 2775 </dd>
2776 </dl> 2776 </dl>
2777 <dl> 2777 <dl>
2778 <dt>Returns:</dt> 2778 <dt>Return:</dt>
2779 <dd> 2779 <dd>
2780 reference to the instantiated options dialog 2780 reference to the instantiated options dialog
2781 (GitNewProjectOptionsDialog) 2781 (GitNewProjectOptionsDialog)
2782 </dd> 2782 </dd>
2783 </dl> 2783 </dl>
2807 <dd> 2807 <dd>
2808 parent widget (QWidget) 2808 parent widget (QWidget)
2809 </dd> 2809 </dd>
2810 </dl> 2810 </dl>
2811 <dl> 2811 <dl>
2812 <dt>Returns:</dt> 2812 <dt>Return:</dt>
2813 <dd> 2813 <dd>
2814 reference to the instantiated options dialog (GitOptionsDialog) 2814 reference to the instantiated options dialog (GitOptionsDialog)
2815 </dd> 2815 </dd>
2816 </dl> 2816 </dl>
2817 <a NAME="Git.vcsRegisteredState" ID="Git.vcsRegisteredState"></a> 2817 <a NAME="Git.vcsRegisteredState" ID="Git.vcsRegisteredState"></a>
2827 <dd> 2827 <dd>
2828 filename to check (string) 2828 filename to check (string)
2829 </dd> 2829 </dd>
2830 </dl> 2830 </dl>
2831 <dl> 2831 <dl>
2832 <dt>Returns:</dt> 2832 <dt>Return:</dt>
2833 <dd> 2833 <dd>
2834 a combination of canBeCommited and canBeAdded 2834 a combination of canBeCommited and canBeAdded
2835 </dd> 2835 </dd>
2836 </dl> 2836 </dl>
2837 <a NAME="Git.vcsRemove" ID="Git.vcsRemove"></a> 2837 <a NAME="Git.vcsRemove" ID="Git.vcsRemove"></a>
2866 flag indicating to just remove the file from the 2866 flag indicating to just remove the file from the
2867 staging area (boolean) 2867 staging area (boolean)
2868 </dd> 2868 </dd>
2869 </dl> 2869 </dl>
2870 <dl> 2870 <dl>
2871 <dt>Returns:</dt> 2871 <dt>Return:</dt>
2872 <dd> 2872 <dd>
2873 flag indicating successful operation (boolean) 2873 flag indicating successful operation (boolean)
2874 </dd> 2874 </dd>
2875 </dl> 2875 </dl>
2876 <a NAME="Git.vcsRepositoryInfos" ID="Git.vcsRepositoryInfos"></a> 2876 <a NAME="Git.vcsRepositoryInfos" ID="Git.vcsRepositoryInfos"></a>
2886 <dd> 2886 <dd>
2887 local path to get the repository infos (string) 2887 local path to get the repository infos (string)
2888 </dd> 2888 </dd>
2889 </dl> 2889 </dl>
2890 <dl> 2890 <dl>
2891 <dt>Returns:</dt> 2891 <dt>Return:</dt>
2892 <dd> 2892 <dd>
2893 string with ready formated info for display (string) 2893 string with ready formated info for display (string)
2894 </dd> 2894 </dd>
2895 </dl> 2895 </dl>
2896 <a NAME="Git.vcsShutdown" ID="Git.vcsShutdown"></a> 2896 <a NAME="Git.vcsShutdown" ID="Git.vcsShutdown"></a>
2922 2922
2923 <p> 2923 <p>
2924 Public method to signal the support of user settable command options. 2924 Public method to signal the support of user settable command options.
2925 </p> 2925 </p>
2926 <dl> 2926 <dl>
2927 <dt>Returns:</dt> 2927 <dt>Return:</dt>
2928 <dd> 2928 <dd>
2929 flag indicating the support of user settable command options 2929 flag indicating the support of user settable command options
2930 (boolean) 2930 (boolean)
2931 </dd> 2931 </dd>
2932 </dl> 2932 </dl>
2944 <dd> 2944 <dd>
2945 directory name to be switched (string) 2945 directory name to be switched (string)
2946 </dd> 2946 </dd>
2947 </dl> 2947 </dl>
2948 <dl> 2948 <dl>
2949 <dt>Returns:</dt> 2949 <dt>Return:</dt>
2950 <dd> 2950 <dd>
2951 flag indicating, that the switch contained an add 2951 flag indicating, that the switch contained an add
2952 or delete (boolean) 2952 or delete (boolean)
2953 </dd> 2953 </dd>
2954 </dl> 2954 </dl>
2974 <dd> 2974 <dd>
2975 name of the tag (string) 2975 name of the tag (string)
2976 </dd> 2976 </dd>
2977 </dl> 2977 </dl>
2978 <dl> 2978 <dl>
2979 <dt>Returns:</dt> 2979 <dt>Return:</dt>
2980 <dd> 2980 <dd>
2981 flag indicating a performed tag action (boolean) 2981 flag indicating a performed tag action (boolean)
2982 </dd> 2982 </dd>
2983 </dl> 2983 </dl>
2984 <a NAME="Git.vcsUpdate" ID="Git.vcsUpdate"></a> 2984 <a NAME="Git.vcsUpdate" ID="Git.vcsUpdate"></a>
3004 <dd> 3004 <dd>
3005 revision to update to (string) 3005 revision to update to (string)
3006 </dd> 3006 </dd>
3007 </dl> 3007 </dl>
3008 <dl> 3008 <dl>
3009 <dt>Returns:</dt> 3009 <dt>Return:</dt>
3010 <dd> 3010 <dd>
3011 flag indicating, that the update contained an add 3011 flag indicating, that the update contained an add
3012 or delete (boolean) 3012 or delete (boolean)
3013 </dd> 3013 </dd>
3014 </dl> 3014 </dl>

eric ide

mercurial