5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.git</h1> |
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.git</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing the version control systems interface to Git. |
11 Module implementing the version control systems interface to Git. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
|
16 <table> |
15 <table> |
17 <tr><td>None</td></tr> |
16 <tr><td>None</td></tr> |
18 </table> |
17 </table> |
|
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
|
21 <table> |
20 <table> |
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#Git">Git</a></td> |
22 <td><a href="#Git">Git</a></td> |
25 <td>Class implementing the version control systems interface to Git.</td> |
23 <td>Class implementing the version control systems interface to Git.</td> |
26 </tr> |
24 </tr> |
27 </table> |
25 </table> |
|
26 |
28 <h3>Functions</h3> |
27 <h3>Functions</h3> |
29 |
|
30 <table> |
28 <table> |
31 <tr><td>None</td></tr> |
29 <tr><td>None</td></tr> |
32 </table> |
30 </table> |
|
31 |
33 <hr /> |
32 <hr /> |
34 <hr /> |
33 <hr /> |
35 <a NAME="Git" ID="Git"></a> |
34 <a NAME="Git" ID="Git"></a> |
36 <h2>Git</h2> |
35 <h2>Git</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing the version control systems interface to Git. |
37 Class implementing the version control systems interface to Git. |
40 </p> |
38 </p> |
|
39 |
41 <h3>Signals</h3> |
40 <h3>Signals</h3> |
42 <dl> |
41 <dl> |
43 |
42 |
44 <dt>committed()</dt> |
43 <dt>committed()</dt> |
45 <dd> |
44 <dd> |
737 </dd> |
735 </dd> |
738 </dl> |
736 </dl> |
739 <a NAME="Git.__vcsCommit_Step2" ID="Git.__vcsCommit_Step2"></a> |
737 <a NAME="Git.__vcsCommit_Step2" ID="Git.__vcsCommit_Step2"></a> |
740 <h4>Git.__vcsCommit_Step2</h4> |
738 <h4>Git.__vcsCommit_Step2</h4> |
741 <b>__vcsCommit_Step2</b>(<i></i>) |
739 <b>__vcsCommit_Step2</b>(<i></i>) |
742 |
|
743 <p> |
740 <p> |
744 Private slot performing the second step of the commit action. |
741 Private slot performing the second step of the commit action. |
745 </p> |
742 </p> |
|
743 |
746 <a NAME="Git._createStatusMonitorThread" ID="Git._createStatusMonitorThread"></a> |
744 <a NAME="Git._createStatusMonitorThread" ID="Git._createStatusMonitorThread"></a> |
747 <h4>Git._createStatusMonitorThread</h4> |
745 <h4>Git._createStatusMonitorThread</h4> |
748 <b>_createStatusMonitorThread</b>(<i>interval, project</i>) |
746 <b>_createStatusMonitorThread</b>(<i>interval, project</i>) |
749 |
|
750 <p> |
747 <p> |
751 Protected method to create an instance of the VCS status monitor |
748 Protected method to create an instance of the VCS status monitor |
752 thread. |
749 thread. |
753 </p> |
750 </p> |
|
751 |
754 <dl> |
752 <dl> |
755 |
753 |
756 <dt><i>interval</i> (int)</dt> |
754 <dt><i>interval</i> (int)</dt> |
757 <dd> |
755 <dd> |
758 check interval for the monitor thread in seconds |
756 check interval for the monitor thread in seconds |
827 </dd> |
825 </dd> |
828 </dl> |
826 </dl> |
829 <a NAME="Git.gitAddRemote" ID="Git.gitAddRemote"></a> |
827 <a NAME="Git.gitAddRemote" ID="Git.gitAddRemote"></a> |
830 <h4>Git.gitAddRemote</h4> |
828 <h4>Git.gitAddRemote</h4> |
831 <b>gitAddRemote</b>(<i>projectDir</i>) |
829 <b>gitAddRemote</b>(<i>projectDir</i>) |
832 |
|
833 <p> |
830 <p> |
834 Public method to add a remote repository. |
831 Public method to add a remote repository. |
835 </p> |
832 </p> |
|
833 |
836 <dl> |
834 <dl> |
837 |
835 |
838 <dt><i>projectDir</i> (str)</dt> |
836 <dt><i>projectDir</i> (str)</dt> |
839 <dd> |
837 <dd> |
840 name of the project directory |
838 name of the project directory |
841 </dd> |
839 </dd> |
842 </dl> |
840 </dl> |
843 <a NAME="Git.gitApply" ID="Git.gitApply"></a> |
841 <a NAME="Git.gitApply" ID="Git.gitApply"></a> |
844 <h4>Git.gitApply</h4> |
842 <h4>Git.gitApply</h4> |
845 <b>gitApply</b>(<i>repodir, patchFile, cached=False, reverse=False, noDialog=False</i>) |
843 <b>gitApply</b>(<i>repodir, patchFile, cached=False, reverse=False, noDialog=False</i>) |
846 |
|
847 <p> |
844 <p> |
848 Public method to apply a patch stored in a given file. |
845 Public method to apply a patch stored in a given file. |
849 </p> |
846 </p> |
|
847 |
850 <dl> |
848 <dl> |
851 |
849 |
852 <dt><i>repodir</i> (str)</dt> |
850 <dt><i>repodir</i> (str)</dt> |
853 <dd> |
851 <dd> |
854 directory name of the repository |
852 directory name of the repository |
928 </dd> |
926 </dd> |
929 </dl> |
927 </dl> |
930 <a NAME="Git.gitBisectCreateReplayFile" ID="Git.gitBisectCreateReplayFile"></a> |
928 <a NAME="Git.gitBisectCreateReplayFile" ID="Git.gitBisectCreateReplayFile"></a> |
931 <h4>Git.gitBisectCreateReplayFile</h4> |
929 <h4>Git.gitBisectCreateReplayFile</h4> |
932 <b>gitBisectCreateReplayFile</b>(<i>projectDir</i>) |
930 <b>gitBisectCreateReplayFile</b>(<i>projectDir</i>) |
933 |
|
934 <p> |
931 <p> |
935 Public method used to create a bisect replay file for the project. |
932 Public method used to create a bisect replay file for the project. |
936 </p> |
933 </p> |
|
934 |
937 <dl> |
935 <dl> |
938 |
936 |
939 <dt><i>projectDir</i> (str)</dt> |
937 <dt><i>projectDir</i> (str)</dt> |
940 <dd> |
938 <dd> |
941 name of the project directory |
939 name of the project directory |
942 </dd> |
940 </dd> |
943 </dl> |
941 </dl> |
944 <a NAME="Git.gitBisectEditReplayFile" ID="Git.gitBisectEditReplayFile"></a> |
942 <a NAME="Git.gitBisectEditReplayFile" ID="Git.gitBisectEditReplayFile"></a> |
945 <h4>Git.gitBisectEditReplayFile</h4> |
943 <h4>Git.gitBisectEditReplayFile</h4> |
946 <b>gitBisectEditReplayFile</b>(<i>projectDir</i>) |
944 <b>gitBisectEditReplayFile</b>(<i>projectDir</i>) |
947 |
|
948 <p> |
945 <p> |
949 Public method used to edit a bisect replay file. |
946 Public method used to edit a bisect replay file. |
950 </p> |
947 </p> |
|
948 |
951 <dl> |
949 <dl> |
952 |
950 |
953 <dt><i>projectDir</i> (str)</dt> |
951 <dt><i>projectDir</i> (str)</dt> |
954 <dd> |
952 <dd> |
955 name of the project directory |
953 name of the project directory |
956 </dd> |
954 </dd> |
957 </dl> |
955 </dl> |
958 <a NAME="Git.gitBisectLogBrowser" ID="Git.gitBisectLogBrowser"></a> |
956 <a NAME="Git.gitBisectLogBrowser" ID="Git.gitBisectLogBrowser"></a> |
959 <h4>Git.gitBisectLogBrowser</h4> |
957 <h4>Git.gitBisectLogBrowser</h4> |
960 <b>gitBisectLogBrowser</b>(<i>projectDir</i>) |
958 <b>gitBisectLogBrowser</b>(<i>projectDir</i>) |
961 |
|
962 <p> |
959 <p> |
963 Public method used to browse the bisect log of the project. |
960 Public method used to browse the bisect log of the project. |
964 </p> |
961 </p> |
|
962 |
965 <dl> |
963 <dl> |
966 |
964 |
967 <dt><i>projectDir</i> (str)</dt> |
965 <dt><i>projectDir</i> (str)</dt> |
968 <dd> |
966 <dd> |
969 name of the project directory |
967 name of the project directory |
970 </dd> |
968 </dd> |
971 </dl> |
969 </dl> |
972 <a NAME="Git.gitBisectReplay" ID="Git.gitBisectReplay"></a> |
970 <a NAME="Git.gitBisectReplay" ID="Git.gitBisectReplay"></a> |
973 <h4>Git.gitBisectReplay</h4> |
971 <h4>Git.gitBisectReplay</h4> |
974 <b>gitBisectReplay</b>(<i>projectDir</i>) |
972 <b>gitBisectReplay</b>(<i>projectDir</i>) |
975 |
|
976 <p> |
973 <p> |
977 Public method to replay a bisect session. |
974 Public method to replay a bisect session. |
978 </p> |
975 </p> |
|
976 |
979 <dl> |
977 <dl> |
980 |
978 |
981 <dt><i>projectDir</i> (str)</dt> |
979 <dt><i>projectDir</i> (str)</dt> |
982 <dd> |
980 <dd> |
983 name of the project directory |
981 name of the project directory |
1054 </dd> |
1052 </dd> |
1055 </dl> |
1053 </dl> |
1056 <a NAME="Git.gitBundle" ID="Git.gitBundle"></a> |
1054 <a NAME="Git.gitBundle" ID="Git.gitBundle"></a> |
1057 <h4>Git.gitBundle</h4> |
1055 <h4>Git.gitBundle</h4> |
1058 <b>gitBundle</b>(<i>projectDir</i>) |
1056 <b>gitBundle</b>(<i>projectDir</i>) |
1059 |
|
1060 <p> |
1057 <p> |
1061 Public method to create a bundle file. |
1058 Public method to create a bundle file. |
1062 </p> |
1059 </p> |
|
1060 |
1063 <dl> |
1061 <dl> |
1064 |
1062 |
1065 <dt><i>projectDir</i> (str)</dt> |
1063 <dt><i>projectDir</i> (str)</dt> |
1066 <dd> |
1064 <dd> |
1067 name of the project directory |
1065 name of the project directory |
1068 </dd> |
1066 </dd> |
1069 </dl> |
1067 </dl> |
1070 <a NAME="Git.gitBundleFetch" ID="Git.gitBundleFetch"></a> |
1068 <a NAME="Git.gitBundleFetch" ID="Git.gitBundleFetch"></a> |
1071 <h4>Git.gitBundleFetch</h4> |
1069 <h4>Git.gitBundleFetch</h4> |
1072 <b>gitBundleFetch</b>(<i>projectDir</i>) |
1070 <b>gitBundleFetch</b>(<i>projectDir</i>) |
1073 |
|
1074 <p> |
1071 <p> |
1075 Public method to fetch a head of a bundle file into the local |
1072 Public method to fetch a head of a bundle file into the local |
1076 repository. |
1073 repository. |
1077 </p> |
1074 </p> |
|
1075 |
1078 <dl> |
1076 <dl> |
1079 |
1077 |
1080 <dt><i>projectDir</i> (str)</dt> |
1078 <dt><i>projectDir</i> (str)</dt> |
1081 <dd> |
1079 <dd> |
1082 name of the project directory |
1080 name of the project directory |
1083 </dd> |
1081 </dd> |
1084 </dl> |
1082 </dl> |
1085 <a NAME="Git.gitBundleListHeads" ID="Git.gitBundleListHeads"></a> |
1083 <a NAME="Git.gitBundleListHeads" ID="Git.gitBundleListHeads"></a> |
1086 <h4>Git.gitBundleListHeads</h4> |
1084 <h4>Git.gitBundleListHeads</h4> |
1087 <b>gitBundleListHeads</b>(<i>projectDir</i>) |
1085 <b>gitBundleListHeads</b>(<i>projectDir</i>) |
1088 |
|
1089 <p> |
1086 <p> |
1090 Public method to list the heads contained in a bundle file. |
1087 Public method to list the heads contained in a bundle file. |
1091 </p> |
1088 </p> |
|
1089 |
1092 <dl> |
1090 <dl> |
1093 |
1091 |
1094 <dt><i>projectDir</i> (str)</dt> |
1092 <dt><i>projectDir</i> (str)</dt> |
1095 <dd> |
1093 <dd> |
1096 name of the project directory |
1094 name of the project directory |
1097 </dd> |
1095 </dd> |
1098 </dl> |
1096 </dl> |
1099 <a NAME="Git.gitBundlePull" ID="Git.gitBundlePull"></a> |
1097 <a NAME="Git.gitBundlePull" ID="Git.gitBundlePull"></a> |
1100 <h4>Git.gitBundlePull</h4> |
1098 <h4>Git.gitBundlePull</h4> |
1101 <b>gitBundlePull</b>(<i>projectDir</i>) |
1099 <b>gitBundlePull</b>(<i>projectDir</i>) |
1102 |
|
1103 <p> |
1100 <p> |
1104 Public method to pull a head of a bundle file into the local |
1101 Public method to pull a head of a bundle file into the local |
1105 repository and working area. |
1102 repository and working area. |
1106 </p> |
1103 </p> |
|
1104 |
1107 <dl> |
1105 <dl> |
1108 |
1106 |
1109 <dt><i>projectDir</i> (str)</dt> |
1107 <dt><i>projectDir</i> (str)</dt> |
1110 <dd> |
1108 <dd> |
1111 name of the project directory |
1109 name of the project directory |
1349 </dd> |
1347 </dd> |
1350 </dl> |
1348 </dl> |
1351 <a NAME="Git.gitCreateArchive" ID="Git.gitCreateArchive"></a> |
1349 <a NAME="Git.gitCreateArchive" ID="Git.gitCreateArchive"></a> |
1352 <h4>Git.gitCreateArchive</h4> |
1350 <h4>Git.gitCreateArchive</h4> |
1353 <b>gitCreateArchive</b>(<i>projectDir</i>) |
1351 <b>gitCreateArchive</b>(<i>projectDir</i>) |
1354 |
|
1355 <p> |
1352 <p> |
1356 Public method to show some statistics of the local repository. |
1353 Public method to show some statistics of the local repository. |
1357 </p> |
1354 </p> |
|
1355 |
1358 <dl> |
1356 <dl> |
1359 |
1357 |
1360 <dt><i>projectDir</i> (str)</dt> |
1358 <dt><i>projectDir</i> (str)</dt> |
1361 <dd> |
1359 <dd> |
1362 name of the project directory |
1360 name of the project directory |
1363 </dd> |
1361 </dd> |
1364 </dl> |
1362 </dl> |
1365 <a NAME="Git.gitCreateIgnoreFile" ID="Git.gitCreateIgnoreFile"></a> |
1363 <a NAME="Git.gitCreateIgnoreFile" ID="Git.gitCreateIgnoreFile"></a> |
1366 <h4>Git.gitCreateIgnoreFile</h4> |
1364 <h4>Git.gitCreateIgnoreFile</h4> |
1367 <b>gitCreateIgnoreFile</b>(<i>name, autoAdd=False</i>) |
1365 <b>gitCreateIgnoreFile</b>(<i>name, autoAdd=False</i>) |
1368 |
|
1369 <p> |
1366 <p> |
1370 Public method to create the ignore file. |
1367 Public method to create the ignore file. |
1371 </p> |
1368 </p> |
|
1369 |
1372 <dl> |
1370 <dl> |
1373 |
1371 |
1374 <dt><i>name</i> (str)</dt> |
1372 <dt><i>name</i> (str)</dt> |
1375 <dd> |
1373 <dd> |
1376 directory name to create the ignore file in |
1374 directory name to create the ignore file in |
1393 </dd> |
1391 </dd> |
1394 </dl> |
1392 </dl> |
1395 <a NAME="Git.gitDeleteRemoteBranch" ID="Git.gitDeleteRemoteBranch"></a> |
1393 <a NAME="Git.gitDeleteRemoteBranch" ID="Git.gitDeleteRemoteBranch"></a> |
1396 <h4>Git.gitDeleteRemoteBranch</h4> |
1394 <h4>Git.gitDeleteRemoteBranch</h4> |
1397 <b>gitDeleteRemoteBranch</b>(<i>name</i>) |
1395 <b>gitDeleteRemoteBranch</b>(<i>name</i>) |
1398 |
|
1399 <p> |
1396 <p> |
1400 Public method to delete a branch from a remote repository. |
1397 Public method to delete a branch from a remote repository. |
1401 </p> |
1398 </p> |
|
1399 |
1402 <dl> |
1400 <dl> |
1403 |
1401 |
1404 <dt><i>name</i> (str)</dt> |
1402 <dt><i>name</i> (str)</dt> |
1405 <dd> |
1403 <dd> |
1406 file/directory name |
1404 file/directory name |
1407 </dd> |
1405 </dd> |
1408 </dl> |
1406 </dl> |
1409 <a NAME="Git.gitDescribe" ID="Git.gitDescribe"></a> |
1407 <a NAME="Git.gitDescribe" ID="Git.gitDescribe"></a> |
1410 <h4>Git.gitDescribe</h4> |
1408 <h4>Git.gitDescribe</h4> |
1411 <b>gitDescribe</b>(<i>projectDir, commits</i>) |
1409 <b>gitDescribe</b>(<i>projectDir, commits</i>) |
1412 |
|
1413 <p> |
1410 <p> |
1414 Public method to find the most recent tag reachable from each commit. |
1411 Public method to find the most recent tag reachable from each commit. |
1415 </p> |
1412 </p> |
|
1413 |
1416 <dl> |
1414 <dl> |
1417 |
1415 |
1418 <dt><i>projectDir</i> (str)</dt> |
1416 <dt><i>projectDir</i> (str)</dt> |
1419 <dd> |
1417 <dd> |
1420 name of the project directory |
1418 name of the project directory |
1425 </dd> |
1423 </dd> |
1426 </dl> |
1424 </dl> |
1427 <a NAME="Git.gitEditConfig" ID="Git.gitEditConfig"></a> |
1425 <a NAME="Git.gitEditConfig" ID="Git.gitEditConfig"></a> |
1428 <h4>Git.gitEditConfig</h4> |
1426 <h4>Git.gitEditConfig</h4> |
1429 <b>gitEditConfig</b>(<i>projectDir</i>) |
1427 <b>gitEditConfig</b>(<i>projectDir</i>) |
1430 |
|
1431 <p> |
1428 <p> |
1432 Public method used to edit the repository configuration file. |
1429 Public method used to edit the repository configuration file. |
1433 </p> |
1430 </p> |
|
1431 |
1434 <dl> |
1432 <dl> |
1435 |
1433 |
1436 <dt><i>projectDir</i> (str)</dt> |
1434 <dt><i>projectDir</i> (str)</dt> |
1437 <dd> |
1435 <dd> |
1438 name of the project directory |
1436 name of the project directory |
1439 </dd> |
1437 </dd> |
1440 </dl> |
1438 </dl> |
1441 <a NAME="Git.gitEditUserConfig" ID="Git.gitEditUserConfig"></a> |
1439 <a NAME="Git.gitEditUserConfig" ID="Git.gitEditUserConfig"></a> |
1442 <h4>Git.gitEditUserConfig</h4> |
1440 <h4>Git.gitEditUserConfig</h4> |
1443 <b>gitEditUserConfig</b>(<i></i>) |
1441 <b>gitEditUserConfig</b>(<i></i>) |
1444 |
|
1445 <p> |
1442 <p> |
1446 Public method used to edit the user configuration file. |
1443 Public method used to edit the user configuration file. |
1447 </p> |
1444 </p> |
|
1445 |
1448 <a NAME="Git.gitExtendedDiff" ID="Git.gitExtendedDiff"></a> |
1446 <a NAME="Git.gitExtendedDiff" ID="Git.gitExtendedDiff"></a> |
1449 <h4>Git.gitExtendedDiff</h4> |
1447 <h4>Git.gitExtendedDiff</h4> |
1450 <b>gitExtendedDiff</b>(<i>name</i>) |
1448 <b>gitExtendedDiff</b>(<i>name</i>) |
1451 |
|
1452 <p> |
1449 <p> |
1453 Public method used to view the difference of a file/directory to the |
1450 Public method used to view the difference of a file/directory to the |
1454 Git repository. |
1451 Git repository. |
1455 </p> |
1452 </p> |
1456 <p> |
1453 <p> |
1460 operation may be aborted. |
1457 operation may be aborted. |
1461 </p> |
1458 </p> |
1462 <p> |
1459 <p> |
1463 This method gives the chance to enter the revisions to be compared. |
1460 This method gives the chance to enter the revisions to be compared. |
1464 </p> |
1461 </p> |
|
1462 |
1465 <dl> |
1463 <dl> |
1466 |
1464 |
1467 <dt><i>name</i> (str)</dt> |
1465 <dt><i>name</i> (str)</dt> |
1468 <dd> |
1466 <dd> |
1469 file/directory name to be diffed |
1467 file/directory name to be diffed |
1470 </dd> |
1468 </dd> |
1471 </dl> |
1469 </dl> |
1472 <a NAME="Git.gitFetch" ID="Git.gitFetch"></a> |
1470 <a NAME="Git.gitFetch" ID="Git.gitFetch"></a> |
1473 <h4>Git.gitFetch</h4> |
1471 <h4>Git.gitFetch</h4> |
1474 <b>gitFetch</b>(<i>name</i>) |
1472 <b>gitFetch</b>(<i>name</i>) |
1475 |
|
1476 <p> |
1473 <p> |
1477 Public method to fetch changes from a remote repository. |
1474 Public method to fetch changes from a remote repository. |
1478 </p> |
1475 </p> |
|
1476 |
1479 <dl> |
1477 <dl> |
1480 |
1478 |
1481 <dt><i>name</i> (str)</dt> |
1479 <dt><i>name</i> (str)</dt> |
1482 <dd> |
1480 <dd> |
1483 directory name |
1481 directory name |
1484 </dd> |
1482 </dd> |
1485 </dl> |
1483 </dl> |
1486 <a NAME="Git.gitGetArchiveFormats" ID="Git.gitGetArchiveFormats"></a> |
1484 <a NAME="Git.gitGetArchiveFormats" ID="Git.gitGetArchiveFormats"></a> |
1487 <h4>Git.gitGetArchiveFormats</h4> |
1485 <h4>Git.gitGetArchiveFormats</h4> |
1488 <b>gitGetArchiveFormats</b>(<i>repodir</i>) |
1486 <b>gitGetArchiveFormats</b>(<i>repodir</i>) |
1489 |
|
1490 <p> |
1487 <p> |
1491 Public method to get a list of supported archive formats. |
1488 Public method to get a list of supported archive formats. |
1492 </p> |
1489 </p> |
|
1490 |
1493 <dl> |
1491 <dl> |
1494 |
1492 |
1495 <dt><i>repodir</i> (str)</dt> |
1493 <dt><i>repodir</i> (str)</dt> |
1496 <dd> |
1494 <dd> |
1497 directory name of the repository |
1495 directory name of the repository |
1747 </dd> |
1745 </dd> |
1748 </dl> |
1746 </dl> |
1749 <a NAME="Git.gitHouseKeeping" ID="Git.gitHouseKeeping"></a> |
1747 <a NAME="Git.gitHouseKeeping" ID="Git.gitHouseKeeping"></a> |
1750 <h4>Git.gitHouseKeeping</h4> |
1748 <h4>Git.gitHouseKeeping</h4> |
1751 <b>gitHouseKeeping</b>(<i>projectDir</i>) |
1749 <b>gitHouseKeeping</b>(<i>projectDir</i>) |
1752 |
|
1753 <p> |
1750 <p> |
1754 Public method to cleanup and optimize the local repository. |
1751 Public method to cleanup and optimize the local repository. |
1755 </p> |
1752 </p> |
|
1753 |
1756 <dl> |
1754 <dl> |
1757 |
1755 |
1758 <dt><i>projectDir</i> (str)</dt> |
1756 <dt><i>projectDir</i> (str)</dt> |
1759 <dd> |
1757 <dd> |
1760 name of the project directory |
1758 name of the project directory |
1761 </dd> |
1759 </dd> |
1762 </dl> |
1760 </dl> |
1763 <a NAME="Git.gitListTagBranch" ID="Git.gitListTagBranch"></a> |
1761 <a NAME="Git.gitListTagBranch" ID="Git.gitListTagBranch"></a> |
1764 <h4>Git.gitListTagBranch</h4> |
1762 <h4>Git.gitListTagBranch</h4> |
1765 <b>gitListTagBranch</b>(<i>path, tags=True, listAll=True, merged=True</i>) |
1763 <b>gitListTagBranch</b>(<i>path, tags=True, listAll=True, merged=True</i>) |
1766 |
|
1767 <p> |
1764 <p> |
1768 Public method used to list the available tags or branches. |
1765 Public method used to list the available tags or branches. |
1769 </p> |
1766 </p> |
|
1767 |
1770 <dl> |
1768 <dl> |
1771 |
1769 |
1772 <dt><i>path</i> (str)</dt> |
1770 <dt><i>path</i> (str)</dt> |
1773 <dd> |
1771 <dd> |
1774 directory name of the project |
1772 directory name of the project |
1858 </dd> |
1856 </dd> |
1859 </dl> |
1857 </dl> |
1860 <a NAME="Git.gitPush" ID="Git.gitPush"></a> |
1858 <a NAME="Git.gitPush" ID="Git.gitPush"></a> |
1861 <h4>Git.gitPush</h4> |
1859 <h4>Git.gitPush</h4> |
1862 <b>gitPush</b>(<i>name</i>) |
1860 <b>gitPush</b>(<i>name</i>) |
1863 |
|
1864 <p> |
1861 <p> |
1865 Public method used to push changes to a remote Git repository. |
1862 Public method used to push changes to a remote Git repository. |
1866 </p> |
1863 </p> |
|
1864 |
1867 <dl> |
1865 <dl> |
1868 |
1866 |
1869 <dt><i>name</i> (str)</dt> |
1867 <dt><i>name</i> (str)</dt> |
1870 <dd> |
1868 <dd> |
1871 directory name of the project to be pushed from |
1869 directory name of the project to be pushed from |
1872 </dd> |
1870 </dd> |
1873 </dl> |
1871 </dl> |
1874 <a NAME="Git.gitReflogBrowser" ID="Git.gitReflogBrowser"></a> |
1872 <a NAME="Git.gitReflogBrowser" ID="Git.gitReflogBrowser"></a> |
1875 <h4>Git.gitReflogBrowser</h4> |
1873 <h4>Git.gitReflogBrowser</h4> |
1876 <b>gitReflogBrowser</b>(<i>projectDir</i>) |
1874 <b>gitReflogBrowser</b>(<i>projectDir</i>) |
1877 |
|
1878 <p> |
1875 <p> |
1879 Public method used to browse the reflog of the project. |
1876 Public method used to browse the reflog of the project. |
1880 </p> |
1877 </p> |
|
1878 |
1881 <dl> |
1879 <dl> |
1882 |
1880 |
1883 <dt><i>projectDir</i> (str)</dt> |
1881 <dt><i>projectDir</i> (str)</dt> |
1884 <dd> |
1882 <dd> |
1885 name of the project directory |
1883 name of the project directory |
1886 </dd> |
1884 </dd> |
1887 </dl> |
1885 </dl> |
1888 <a NAME="Git.gitRemoveRemote" ID="Git.gitRemoveRemote"></a> |
1886 <a NAME="Git.gitRemoveRemote" ID="Git.gitRemoveRemote"></a> |
1889 <h4>Git.gitRemoveRemote</h4> |
1887 <h4>Git.gitRemoveRemote</h4> |
1890 <b>gitRemoveRemote</b>(<i>projectDir, remoteName</i>) |
1888 <b>gitRemoveRemote</b>(<i>projectDir, remoteName</i>) |
1891 |
|
1892 <p> |
1889 <p> |
1893 Public method to remove a remote repository. |
1890 Public method to remove a remote repository. |
1894 </p> |
1891 </p> |
|
1892 |
1895 <dl> |
1893 <dl> |
1896 |
1894 |
1897 <dt><i>projectDir</i> (str)</dt> |
1895 <dt><i>projectDir</i> (str)</dt> |
1898 <dd> |
1896 <dd> |
1899 name of the project directory |
1897 name of the project directory |
1941 </dd> |
1939 </dd> |
1942 </dl> |
1940 </dl> |
1943 <a NAME="Git.gitShowBranch" ID="Git.gitShowBranch"></a> |
1941 <a NAME="Git.gitShowBranch" ID="Git.gitShowBranch"></a> |
1944 <h4>Git.gitShowBranch</h4> |
1942 <h4>Git.gitShowBranch</h4> |
1945 <b>gitShowBranch</b>(<i>name</i>) |
1943 <b>gitShowBranch</b>(<i>name</i>) |
1946 |
|
1947 <p> |
1944 <p> |
1948 Public method used to show the current branch of the working directory. |
1945 Public method used to show the current branch of the working directory. |
1949 </p> |
1946 </p> |
|
1947 |
1950 <dl> |
1948 <dl> |
1951 |
1949 |
1952 <dt><i>name</i> (str)</dt> |
1950 <dt><i>name</i> (str)</dt> |
1953 <dd> |
1951 <dd> |
1954 file/directory name |
1952 file/directory name |
1955 </dd> |
1953 </dd> |
1956 </dl> |
1954 </dl> |
1957 <a NAME="Git.gitShowConfig" ID="Git.gitShowConfig"></a> |
1955 <a NAME="Git.gitShowConfig" ID="Git.gitShowConfig"></a> |
1958 <h4>Git.gitShowConfig</h4> |
1956 <h4>Git.gitShowConfig</h4> |
1959 <b>gitShowConfig</b>(<i>projectDir</i>) |
1957 <b>gitShowConfig</b>(<i>projectDir</i>) |
1960 |
|
1961 <p> |
1958 <p> |
1962 Public method to show the combined configuration. |
1959 Public method to show the combined configuration. |
1963 </p> |
1960 </p> |
|
1961 |
1964 <dl> |
1962 <dl> |
1965 |
1963 |
1966 <dt><i>projectDir</i> (str)</dt> |
1964 <dt><i>projectDir</i> (str)</dt> |
1967 <dd> |
1965 <dd> |
1968 name of the project directory |
1966 name of the project directory |
1969 </dd> |
1967 </dd> |
1970 </dl> |
1968 </dl> |
1971 <a NAME="Git.gitShowPatchesStatistics" ID="Git.gitShowPatchesStatistics"></a> |
1969 <a NAME="Git.gitShowPatchesStatistics" ID="Git.gitShowPatchesStatistics"></a> |
1972 <h4>Git.gitShowPatchesStatistics</h4> |
1970 <h4>Git.gitShowPatchesStatistics</h4> |
1973 <b>gitShowPatchesStatistics</b>(<i>projectDir</i>) |
1971 <b>gitShowPatchesStatistics</b>(<i>projectDir</i>) |
1974 |
|
1975 <p> |
1972 <p> |
1976 Public method to show statistics for a set of patch files. |
1973 Public method to show statistics for a set of patch files. |
1977 </p> |
1974 </p> |
|
1975 |
1978 <dl> |
1976 <dl> |
1979 |
1977 |
1980 <dt><i>projectDir</i> (str)</dt> |
1978 <dt><i>projectDir</i> (str)</dt> |
1981 <dd> |
1979 <dd> |
1982 directory name of the project |
1980 directory name of the project |
1983 </dd> |
1981 </dd> |
1984 </dl> |
1982 </dl> |
1985 <a NAME="Git.gitShowRemote" ID="Git.gitShowRemote"></a> |
1983 <a NAME="Git.gitShowRemote" ID="Git.gitShowRemote"></a> |
1986 <h4>Git.gitShowRemote</h4> |
1984 <h4>Git.gitShowRemote</h4> |
1987 <b>gitShowRemote</b>(<i>projectDir, remoteName</i>) |
1985 <b>gitShowRemote</b>(<i>projectDir, remoteName</i>) |
1988 |
|
1989 <p> |
1986 <p> |
1990 Public method to show information about a remote repository. |
1987 Public method to show information about a remote repository. |
1991 </p> |
1988 </p> |
|
1989 |
1992 <dl> |
1990 <dl> |
1993 |
1991 |
1994 <dt><i>projectDir</i> (str)</dt> |
1992 <dt><i>projectDir</i> (str)</dt> |
1995 <dd> |
1993 <dd> |
1996 name of the project directory |
1994 name of the project directory |
2001 </dd> |
1999 </dd> |
2002 </dl> |
2000 </dl> |
2003 <a NAME="Git.gitShowRemotes" ID="Git.gitShowRemotes"></a> |
2001 <a NAME="Git.gitShowRemotes" ID="Git.gitShowRemotes"></a> |
2004 <h4>Git.gitShowRemotes</h4> |
2002 <h4>Git.gitShowRemotes</h4> |
2005 <b>gitShowRemotes</b>(<i>projectDir</i>) |
2003 <b>gitShowRemotes</b>(<i>projectDir</i>) |
2006 |
|
2007 <p> |
2004 <p> |
2008 Public method to show available remote repositories. |
2005 Public method to show available remote repositories. |
2009 </p> |
2006 </p> |
|
2007 |
2010 <dl> |
2008 <dl> |
2011 |
2009 |
2012 <dt><i>projectDir</i> (str)</dt> |
2010 <dt><i>projectDir</i> (str)</dt> |
2013 <dd> |
2011 <dd> |
2014 name of the project directory |
2012 name of the project directory |
2015 </dd> |
2013 </dd> |
2016 </dl> |
2014 </dl> |
2017 <a NAME="Git.gitStashApply" ID="Git.gitStashApply"></a> |
2015 <a NAME="Git.gitStashApply" ID="Git.gitStashApply"></a> |
2018 <h4>Git.gitStashApply</h4> |
2016 <h4>Git.gitStashApply</h4> |
2019 <b>gitStashApply</b>(<i>projectDir, stashName=""</i>) |
2017 <b>gitStashApply</b>(<i>projectDir, stashName=""</i>) |
2020 |
|
2021 <p> |
2018 <p> |
2022 Public method to apply a stash but keep it. |
2019 Public method to apply a stash but keep it. |
2023 </p> |
2020 </p> |
|
2021 |
2024 <dl> |
2022 <dl> |
2025 |
2023 |
2026 <dt><i>projectDir</i> (str)</dt> |
2024 <dt><i>projectDir</i> (str)</dt> |
2027 <dd> |
2025 <dd> |
2028 name of the project directory |
2026 name of the project directory |
2075 </dd> |
2073 </dd> |
2076 </dl> |
2074 </dl> |
2077 <a NAME="Git.gitStashBrowser" ID="Git.gitStashBrowser"></a> |
2075 <a NAME="Git.gitStashBrowser" ID="Git.gitStashBrowser"></a> |
2078 <h4>Git.gitStashBrowser</h4> |
2076 <h4>Git.gitStashBrowser</h4> |
2079 <b>gitStashBrowser</b>(<i>projectDir</i>) |
2077 <b>gitStashBrowser</b>(<i>projectDir</i>) |
2080 |
|
2081 <p> |
2078 <p> |
2082 Public method used to browse the stashed changes. |
2079 Public method used to browse the stashed changes. |
2083 </p> |
2080 </p> |
|
2081 |
2084 <dl> |
2082 <dl> |
2085 |
2083 |
2086 <dt><i>projectDir</i> (str)</dt> |
2084 <dt><i>projectDir</i> (str)</dt> |
2087 <dd> |
2085 <dd> |
2088 name of the project directory |
2086 name of the project directory |
2089 </dd> |
2087 </dd> |
2090 </dl> |
2088 </dl> |
2091 <a NAME="Git.gitStashClear" ID="Git.gitStashClear"></a> |
2089 <a NAME="Git.gitStashClear" ID="Git.gitStashClear"></a> |
2092 <h4>Git.gitStashClear</h4> |
2090 <h4>Git.gitStashClear</h4> |
2093 <b>gitStashClear</b>(<i>projectDir</i>) |
2091 <b>gitStashClear</b>(<i>projectDir</i>) |
2094 |
|
2095 <p> |
2092 <p> |
2096 Public method to delete all stashes. |
2093 Public method to delete all stashes. |
2097 </p> |
2094 </p> |
|
2095 |
2098 <dl> |
2096 <dl> |
2099 |
2097 |
2100 <dt><i>projectDir</i> (str)</dt> |
2098 <dt><i>projectDir</i> (str)</dt> |
2101 <dd> |
2099 <dd> |
2102 name of the project directory |
2100 name of the project directory |
2219 </dd> |
2217 </dd> |
2220 </dl> |
2218 </dl> |
2221 <a NAME="Git.gitStatistics" ID="Git.gitStatistics"></a> |
2219 <a NAME="Git.gitStatistics" ID="Git.gitStatistics"></a> |
2222 <h4>Git.gitStatistics</h4> |
2220 <h4>Git.gitStatistics</h4> |
2223 <b>gitStatistics</b>(<i>projectDir</i>) |
2221 <b>gitStatistics</b>(<i>projectDir</i>) |
2224 |
|
2225 <p> |
2222 <p> |
2226 Public method to show some statistics of the local repository. |
2223 Public method to show some statistics of the local repository. |
2227 </p> |
2224 </p> |
|
2225 |
2228 <dl> |
2226 <dl> |
2229 |
2227 |
2230 <dt><i>projectDir</i> (str)</dt> |
2228 <dt><i>projectDir</i> (str)</dt> |
2231 <dd> |
2229 <dd> |
2232 name of the project directory |
2230 name of the project directory |
2233 </dd> |
2231 </dd> |
2234 </dl> |
2232 </dl> |
2235 <a NAME="Git.gitSubmoduleAdd" ID="Git.gitSubmoduleAdd"></a> |
2233 <a NAME="Git.gitSubmoduleAdd" ID="Git.gitSubmoduleAdd"></a> |
2236 <h4>Git.gitSubmoduleAdd</h4> |
2234 <h4>Git.gitSubmoduleAdd</h4> |
2237 <b>gitSubmoduleAdd</b>(<i>projectDir</i>) |
2235 <b>gitSubmoduleAdd</b>(<i>projectDir</i>) |
2238 |
|
2239 <p> |
2236 <p> |
2240 Public method to add a submodule to the project. |
2237 Public method to add a submodule to the project. |
2241 </p> |
2238 </p> |
|
2239 |
2242 <dl> |
2240 <dl> |
2243 |
2241 |
2244 <dt><i>projectDir</i> (str)</dt> |
2242 <dt><i>projectDir</i> (str)</dt> |
2245 <dd> |
2243 <dd> |
2246 name of the project directory |
2244 name of the project directory |
2247 </dd> |
2245 </dd> |
2248 </dl> |
2246 </dl> |
2249 <a NAME="Git.gitSubmoduleDeinit" ID="Git.gitSubmoduleDeinit"></a> |
2247 <a NAME="Git.gitSubmoduleDeinit" ID="Git.gitSubmoduleDeinit"></a> |
2250 <h4>Git.gitSubmoduleDeinit</h4> |
2248 <h4>Git.gitSubmoduleDeinit</h4> |
2251 <b>gitSubmoduleDeinit</b>(<i>projectDir</i>) |
2249 <b>gitSubmoduleDeinit</b>(<i>projectDir</i>) |
2252 |
|
2253 <p> |
2250 <p> |
2254 Public method to unregister submodules. |
2251 Public method to unregister submodules. |
2255 </p> |
2252 </p> |
|
2253 |
2256 <dl> |
2254 <dl> |
2257 |
2255 |
2258 <dt><i>projectDir</i> (str)</dt> |
2256 <dt><i>projectDir</i> (str)</dt> |
2259 <dd> |
2257 <dd> |
2260 name of the project directory |
2258 name of the project directory |
2261 </dd> |
2259 </dd> |
2262 </dl> |
2260 </dl> |
2263 <a NAME="Git.gitSubmoduleInit" ID="Git.gitSubmoduleInit"></a> |
2261 <a NAME="Git.gitSubmoduleInit" ID="Git.gitSubmoduleInit"></a> |
2264 <h4>Git.gitSubmoduleInit</h4> |
2262 <h4>Git.gitSubmoduleInit</h4> |
2265 <b>gitSubmoduleInit</b>(<i>projectDir</i>) |
2263 <b>gitSubmoduleInit</b>(<i>projectDir</i>) |
2266 |
|
2267 <p> |
2264 <p> |
2268 Public method to initialize one or all submodules. |
2265 Public method to initialize one or all submodules. |
2269 </p> |
2266 </p> |
|
2267 |
2270 <dl> |
2268 <dl> |
2271 |
2269 |
2272 <dt><i>projectDir</i> (str)</dt> |
2270 <dt><i>projectDir</i> (str)</dt> |
2273 <dd> |
2271 <dd> |
2274 name of the project directory |
2272 name of the project directory |
2275 </dd> |
2273 </dd> |
2276 </dl> |
2274 </dl> |
2277 <a NAME="Git.gitSubmoduleList" ID="Git.gitSubmoduleList"></a> |
2275 <a NAME="Git.gitSubmoduleList" ID="Git.gitSubmoduleList"></a> |
2278 <h4>Git.gitSubmoduleList</h4> |
2276 <h4>Git.gitSubmoduleList</h4> |
2279 <b>gitSubmoduleList</b>(<i>projectDir</i>) |
2277 <b>gitSubmoduleList</b>(<i>projectDir</i>) |
2280 |
|
2281 <p> |
2278 <p> |
2282 Public method to show a list of all submodules of the project. |
2279 Public method to show a list of all submodules of the project. |
2283 </p> |
2280 </p> |
|
2281 |
2284 <dl> |
2282 <dl> |
2285 |
2283 |
2286 <dt><i>projectDir</i> (str)</dt> |
2284 <dt><i>projectDir</i> (str)</dt> |
2287 <dd> |
2285 <dd> |
2288 name of the project directory |
2286 name of the project directory |
2289 </dd> |
2287 </dd> |
2290 </dl> |
2288 </dl> |
2291 <a NAME="Git.gitSubmoduleStatus" ID="Git.gitSubmoduleStatus"></a> |
2289 <a NAME="Git.gitSubmoduleStatus" ID="Git.gitSubmoduleStatus"></a> |
2292 <h4>Git.gitSubmoduleStatus</h4> |
2290 <h4>Git.gitSubmoduleStatus</h4> |
2293 <b>gitSubmoduleStatus</b>(<i>projectDir</i>) |
2291 <b>gitSubmoduleStatus</b>(<i>projectDir</i>) |
2294 |
|
2295 <p> |
2292 <p> |
2296 Public method to show the status of the submodules. |
2293 Public method to show the status of the submodules. |
2297 </p> |
2294 </p> |
|
2295 |
2298 <dl> |
2296 <dl> |
2299 |
2297 |
2300 <dt><i>projectDir</i> (str)</dt> |
2298 <dt><i>projectDir</i> (str)</dt> |
2301 <dd> |
2299 <dd> |
2302 name of the project directory |
2300 name of the project directory |
2303 </dd> |
2301 </dd> |
2304 </dl> |
2302 </dl> |
2305 <a NAME="Git.gitSubmoduleSummary" ID="Git.gitSubmoduleSummary"></a> |
2303 <a NAME="Git.gitSubmoduleSummary" ID="Git.gitSubmoduleSummary"></a> |
2306 <h4>Git.gitSubmoduleSummary</h4> |
2304 <h4>Git.gitSubmoduleSummary</h4> |
2307 <b>gitSubmoduleSummary</b>(<i>projectDir</i>) |
2305 <b>gitSubmoduleSummary</b>(<i>projectDir</i>) |
2308 |
|
2309 <p> |
2306 <p> |
2310 Public method to show the status of the submodules. |
2307 Public method to show the status of the submodules. |
2311 </p> |
2308 </p> |
|
2309 |
2312 <dl> |
2310 <dl> |
2313 |
2311 |
2314 <dt><i>projectDir</i> (str)</dt> |
2312 <dt><i>projectDir</i> (str)</dt> |
2315 <dd> |
2313 <dd> |
2316 name of the project directory |
2314 name of the project directory |
2317 </dd> |
2315 </dd> |
2318 </dl> |
2316 </dl> |
2319 <a NAME="Git.gitSubmoduleSync" ID="Git.gitSubmoduleSync"></a> |
2317 <a NAME="Git.gitSubmoduleSync" ID="Git.gitSubmoduleSync"></a> |
2320 <h4>Git.gitSubmoduleSync</h4> |
2318 <h4>Git.gitSubmoduleSync</h4> |
2321 <b>gitSubmoduleSync</b>(<i>projectDir</i>) |
2319 <b>gitSubmoduleSync</b>(<i>projectDir</i>) |
2322 |
|
2323 <p> |
2320 <p> |
2324 Public method to synchronize submodules. |
2321 Public method to synchronize submodules. |
2325 </p> |
2322 </p> |
|
2323 |
2326 <dl> |
2324 <dl> |
2327 |
2325 |
2328 <dt><i>projectDir</i> (str)</dt> |
2326 <dt><i>projectDir</i> (str)</dt> |
2329 <dd> |
2327 <dd> |
2330 name of the project directory |
2328 name of the project directory |
2331 </dd> |
2329 </dd> |
2332 </dl> |
2330 </dl> |
2333 <a NAME="Git.gitSubmoduleUpdate" ID="Git.gitSubmoduleUpdate"></a> |
2331 <a NAME="Git.gitSubmoduleUpdate" ID="Git.gitSubmoduleUpdate"></a> |
2334 <h4>Git.gitSubmoduleUpdate</h4> |
2332 <h4>Git.gitSubmoduleUpdate</h4> |
2335 <b>gitSubmoduleUpdate</b>(<i>projectDir, initialize=False, remote=False</i>) |
2333 <b>gitSubmoduleUpdate</b>(<i>projectDir, initialize=False, remote=False</i>) |
2336 |
|
2337 <p> |
2334 <p> |
2338 Public method to update submodules. |
2335 Public method to update submodules. |
2339 </p> |
2336 </p> |
|
2337 |
2340 <dl> |
2338 <dl> |
2341 |
2339 |
2342 <dt><i>projectDir</i> (str)</dt> |
2340 <dt><i>projectDir</i> (str)</dt> |
2343 <dd> |
2341 <dd> |
2344 name of the project directory |
2342 name of the project directory |
2353 </dd> |
2351 </dd> |
2354 </dl> |
2352 </dl> |
2355 <a NAME="Git.gitSubmoduleUpdateWithOptions" ID="Git.gitSubmoduleUpdateWithOptions"></a> |
2353 <a NAME="Git.gitSubmoduleUpdateWithOptions" ID="Git.gitSubmoduleUpdateWithOptions"></a> |
2356 <h4>Git.gitSubmoduleUpdateWithOptions</h4> |
2354 <h4>Git.gitSubmoduleUpdateWithOptions</h4> |
2357 <b>gitSubmoduleUpdateWithOptions</b>(<i>projectDir</i>) |
2355 <b>gitSubmoduleUpdateWithOptions</b>(<i>projectDir</i>) |
2358 |
|
2359 <p> |
2356 <p> |
2360 Public method to update submodules offering a dialog to select the |
2357 Public method to update submodules offering a dialog to select the |
2361 update options. |
2358 update options. |
2362 </p> |
2359 </p> |
|
2360 |
2363 <dl> |
2361 <dl> |
2364 |
2362 |
2365 <dt><i>projectDir</i> (str)</dt> |
2363 <dt><i>projectDir</i> (str)</dt> |
2366 <dd> |
2364 <dd> |
2367 name of the project directory |
2365 name of the project directory |
2368 </dd> |
2366 </dd> |
2369 </dl> |
2367 </dl> |
2370 <a NAME="Git.gitUnstage" ID="Git.gitUnstage"></a> |
2368 <a NAME="Git.gitUnstage" ID="Git.gitUnstage"></a> |
2371 <h4>Git.gitUnstage</h4> |
2369 <h4>Git.gitUnstage</h4> |
2372 <b>gitUnstage</b>(<i>name</i>) |
2370 <b>gitUnstage</b>(<i>name</i>) |
2373 |
|
2374 <p> |
2371 <p> |
2375 Public method used to unstage a file/directory. |
2372 Public method used to unstage a file/directory. |
2376 </p> |
2373 </p> |
|
2374 |
2377 <dl> |
2375 <dl> |
2378 |
2376 |
2379 <dt><i>name</i> (str)</dt> |
2377 <dt><i>name</i> (str)</dt> |
2380 <dd> |
2378 <dd> |
2381 file/directory name to be reverted |
2379 file/directory name to be reverted |
2394 </dd> |
2392 </dd> |
2395 </dl> |
2393 </dl> |
2396 <a NAME="Git.gitVerify" ID="Git.gitVerify"></a> |
2394 <a NAME="Git.gitVerify" ID="Git.gitVerify"></a> |
2397 <h4>Git.gitVerify</h4> |
2395 <h4>Git.gitVerify</h4> |
2398 <b>gitVerify</b>(<i>projectDir</i>) |
2396 <b>gitVerify</b>(<i>projectDir</i>) |
2399 |
|
2400 <p> |
2397 <p> |
2401 Public method to verify the connectivity and validity of objects |
2398 Public method to verify the connectivity and validity of objects |
2402 of the database. |
2399 of the database. |
2403 </p> |
2400 </p> |
|
2401 |
2404 <dl> |
2402 <dl> |
2405 |
2403 |
2406 <dt><i>projectDir</i> (str)</dt> |
2404 <dt><i>projectDir</i> (str)</dt> |
2407 <dd> |
2405 <dd> |
2408 name of the project directory |
2406 name of the project directory |
2409 </dd> |
2407 </dd> |
2410 </dl> |
2408 </dl> |
2411 <a NAME="Git.gitVerifyBundle" ID="Git.gitVerifyBundle"></a> |
2409 <a NAME="Git.gitVerifyBundle" ID="Git.gitVerifyBundle"></a> |
2412 <h4>Git.gitVerifyBundle</h4> |
2410 <h4>Git.gitVerifyBundle</h4> |
2413 <b>gitVerifyBundle</b>(<i>projectDir</i>) |
2411 <b>gitVerifyBundle</b>(<i>projectDir</i>) |
2414 |
|
2415 <p> |
2412 <p> |
2416 Public method to verify a bundle file. |
2413 Public method to verify a bundle file. |
2417 </p> |
2414 </p> |
|
2415 |
2418 <dl> |
2416 <dl> |
2419 |
2417 |
2420 <dt><i>projectDir</i> (str)</dt> |
2418 <dt><i>projectDir</i> (str)</dt> |
2421 <dd> |
2419 <dd> |
2422 name of the project directory |
2420 name of the project directory |
2423 </dd> |
2421 </dd> |
2424 </dl> |
2422 </dl> |
2425 <a NAME="Git.gitWorktreeManagement" ID="Git.gitWorktreeManagement"></a> |
2423 <a NAME="Git.gitWorktreeManagement" ID="Git.gitWorktreeManagement"></a> |
2426 <h4>Git.gitWorktreeManagement</h4> |
2424 <h4>Git.gitWorktreeManagement</h4> |
2427 <b>gitWorktreeManagement</b>(<i>projectDir</i>) |
2425 <b>gitWorktreeManagement</b>(<i>projectDir</i>) |
2428 |
|
2429 <p> |
2426 <p> |
2430 Public method to show the worktree list/management dialog. |
2427 Public method to show the worktree list/management dialog. |
2431 </p> |
2428 </p> |
|
2429 |
2432 <dl> |
2430 <dl> |
2433 |
2431 |
2434 <dt><i>projectDir</i> (str)</dt> |
2432 <dt><i>projectDir</i> (str)</dt> |
2435 <dd> |
2433 <dd> |
2436 name of the project directory |
2434 name of the project directory |
2437 </dd> |
2435 </dd> |
2438 </dl> |
2436 </dl> |
2439 <a NAME="Git.initCommand" ID="Git.initCommand"></a> |
2437 <a NAME="Git.initCommand" ID="Git.initCommand"></a> |
2440 <h4>Git.initCommand</h4> |
2438 <h4>Git.initCommand</h4> |
2441 <b>initCommand</b>(<i>command</i>) |
2439 <b>initCommand</b>(<i>command</i>) |
2442 |
|
2443 <p> |
2440 <p> |
2444 Public method to initialize a command arguments list. |
2441 Public method to initialize a command arguments list. |
2445 </p> |
2442 </p> |
|
2443 |
2446 <dl> |
2444 <dl> |
2447 |
2445 |
2448 <dt><i>command</i> (str)</dt> |
2446 <dt><i>command</i> (str)</dt> |
2449 <dd> |
2447 <dd> |
2450 command name |
2448 command name |
2504 </dd> |
2502 </dd> |
2505 </dl> |
2503 </dl> |
2506 <a NAME="Git.vcsAddCommitMessage" ID="Git.vcsAddCommitMessage"></a> |
2504 <a NAME="Git.vcsAddCommitMessage" ID="Git.vcsAddCommitMessage"></a> |
2507 <h4>Git.vcsAddCommitMessage</h4> |
2505 <h4>Git.vcsAddCommitMessage</h4> |
2508 <b>vcsAddCommitMessage</b>(<i>message</i>) |
2506 <b>vcsAddCommitMessage</b>(<i>message</i>) |
2509 |
|
2510 <p> |
2507 <p> |
2511 Public method to add a commit message to the list of saved messages. |
2508 Public method to add a commit message to the list of saved messages. |
2512 </p> |
2509 </p> |
|
2510 |
2513 <dl> |
2511 <dl> |
2514 |
2512 |
2515 <dt><i>message</i> (str)</dt> |
2513 <dt><i>message</i> (str)</dt> |
2516 <dd> |
2514 <dd> |
2517 message to be added |
2515 message to be added |
2518 </dd> |
2516 </dd> |
2519 </dl> |
2517 </dl> |
2520 <a NAME="Git.vcsAddTree" ID="Git.vcsAddTree"></a> |
2518 <a NAME="Git.vcsAddTree" ID="Git.vcsAddTree"></a> |
2521 <h4>Git.vcsAddTree</h4> |
2519 <h4>Git.vcsAddTree</h4> |
2522 <b>vcsAddTree</b>(<i>path</i>) |
2520 <b>vcsAddTree</b>(<i>path</i>) |
2523 |
|
2524 <p> |
2521 <p> |
2525 Public method to add a directory tree rooted at path to the Git |
2522 Public method to add a directory tree rooted at path to the Git |
2526 repository. |
2523 repository. |
2527 </p> |
2524 </p> |
|
2525 |
2528 <dl> |
2526 <dl> |
2529 |
2527 |
2530 <dt><i>path</i> (str or list of str)</dt> |
2528 <dt><i>path</i> (str or list of str)</dt> |
2531 <dd> |
2529 <dd> |
2532 root directory of the tree to be added |
2530 root directory of the tree to be added |
2533 </dd> |
2531 </dd> |
2534 </dl> |
2532 </dl> |
2535 <a NAME="Git.vcsAllRegisteredStates" ID="Git.vcsAllRegisteredStates"></a> |
2533 <a NAME="Git.vcsAllRegisteredStates" ID="Git.vcsAllRegisteredStates"></a> |
2536 <h4>Git.vcsAllRegisteredStates</h4> |
2534 <h4>Git.vcsAllRegisteredStates</h4> |
2537 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) |
2535 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) |
2538 |
|
2539 <p> |
2536 <p> |
2540 Public method used to get the registered states of a number of files |
2537 Public method used to get the registered states of a number of files |
2541 in the vcs. |
2538 in the vcs. |
2542 </p> |
2539 </p> |
2543 <p> |
2540 <p> |
2544 <b>Note:</b> If a shortcut is to be taken, the code will only check, |
2541 <b>Note:</b> If a shortcut is to be taken, the code will only check, |
2545 if the named directory has been scanned already. If so, it is assumed, |
2542 if the named directory has been scanned already. If so, it is assumed, |
2546 that the states for all files have been populated by the previous run. |
2543 that the states for all files have been populated by the previous run. |
2547 </p> |
2544 </p> |
|
2545 |
2548 <dl> |
2546 <dl> |
2549 |
2547 |
2550 <dt><i>names</i> (dict)</dt> |
2548 <dt><i>names</i> (dict)</dt> |
2551 <dd> |
2549 <dd> |
2552 dictionary with all filenames to be checked as keys |
2550 dictionary with all filenames to be checked as keys |
2609 </dd> |
2607 </dd> |
2610 </dl> |
2608 </dl> |
2611 <a NAME="Git.vcsCleanup" ID="Git.vcsCleanup"></a> |
2609 <a NAME="Git.vcsCleanup" ID="Git.vcsCleanup"></a> |
2612 <h4>Git.vcsCleanup</h4> |
2610 <h4>Git.vcsCleanup</h4> |
2613 <b>vcsCleanup</b>(<i>name</i>) |
2611 <b>vcsCleanup</b>(<i>name</i>) |
2614 |
|
2615 <p> |
2612 <p> |
2616 Public method used to cleanup the working directory. |
2613 Public method used to cleanup the working directory. |
2617 </p> |
2614 </p> |
|
2615 |
2618 <dl> |
2616 <dl> |
2619 |
2617 |
2620 <dt><i>name</i> (str)</dt> |
2618 <dt><i>name</i> (str)</dt> |
2621 <dd> |
2619 <dd> |
2622 directory name to be cleaned up |
2620 directory name to be cleaned up |
2623 </dd> |
2621 </dd> |
2624 </dl> |
2622 </dl> |
2625 <a NAME="Git.vcsClearCommitMessages" ID="Git.vcsClearCommitMessages"></a> |
2623 <a NAME="Git.vcsClearCommitMessages" ID="Git.vcsClearCommitMessages"></a> |
2626 <h4>Git.vcsClearCommitMessages</h4> |
2624 <h4>Git.vcsClearCommitMessages</h4> |
2627 <b>vcsClearCommitMessages</b>(<i></i>) |
2625 <b>vcsClearCommitMessages</b>(<i></i>) |
2628 |
|
2629 <p> |
2626 <p> |
2630 Public method to clear the list of saved messages. |
2627 Public method to clear the list of saved messages. |
2631 </p> |
2628 </p> |
|
2629 |
2632 <a NAME="Git.vcsCommandLine" ID="Git.vcsCommandLine"></a> |
2630 <a NAME="Git.vcsCommandLine" ID="Git.vcsCommandLine"></a> |
2633 <h4>Git.vcsCommandLine</h4> |
2631 <h4>Git.vcsCommandLine</h4> |
2634 <b>vcsCommandLine</b>(<i>name</i>) |
2632 <b>vcsCommandLine</b>(<i>name</i>) |
2635 |
|
2636 <p> |
2633 <p> |
2637 Public method used to execute arbitrary Git commands. |
2634 Public method used to execute arbitrary Git commands. |
2638 </p> |
2635 </p> |
|
2636 |
2639 <dl> |
2637 <dl> |
2640 |
2638 |
2641 <dt><i>name</i> (str)</dt> |
2639 <dt><i>name</i> (str)</dt> |
2642 <dd> |
2640 <dd> |
2643 directory name of the working directory |
2641 directory name of the working directory |
2644 </dd> |
2642 </dd> |
2645 </dl> |
2643 </dl> |
2646 <a NAME="Git.vcsCommit" ID="Git.vcsCommit"></a> |
2644 <a NAME="Git.vcsCommit" ID="Git.vcsCommit"></a> |
2647 <h4>Git.vcsCommit</h4> |
2645 <h4>Git.vcsCommit</h4> |
2648 <b>vcsCommit</b>(<i>name, message="", noDialog=False, commitAll=True, amend=False</i>) |
2646 <b>vcsCommit</b>(<i>name, message="", noDialog=False, commitAll=True, amend=False</i>) |
2649 |
|
2650 <p> |
2647 <p> |
2651 Public method used to make the change of a file/directory permanent |
2648 Public method used to make the change of a file/directory permanent |
2652 in the Git repository. |
2649 in the Git repository. |
2653 </p> |
2650 </p> |
|
2651 |
2654 <dl> |
2652 <dl> |
2655 |
2653 |
2656 <dt><i>name</i> (str or list of str)</dt> |
2654 <dt><i>name</i> (str or list of str)</dt> |
2657 <dd> |
2655 <dd> |
2658 file/directory name to be committed |
2656 file/directory name to be committed |
2717 </dd> |
2715 </dd> |
2718 </dl> |
2716 </dl> |
2719 <a NAME="Git.vcsDiff" ID="Git.vcsDiff"></a> |
2717 <a NAME="Git.vcsDiff" ID="Git.vcsDiff"></a> |
2720 <h4>Git.vcsDiff</h4> |
2718 <h4>Git.vcsDiff</h4> |
2721 <b>vcsDiff</b>(<i>name</i>) |
2719 <b>vcsDiff</b>(<i>name</i>) |
2722 |
|
2723 <p> |
2720 <p> |
2724 Public method used to view the difference of a file/directory to the |
2721 Public method used to view the difference of a file/directory to the |
2725 Git repository. |
2722 Git repository. |
2726 </p> |
2723 </p> |
2727 <p> |
2724 <p> |
2728 If name is a directory and is the project directory, all project files |
2725 If name is a directory and is the project directory, all project files |
2729 are saved first. If name is a file (or list of files), which is/are |
2726 are saved first. If name is a file (or list of files), which is/are |
2730 being edited and has unsaved modification, they can be saved or the |
2727 being edited and has unsaved modification, they can be saved or the |
2731 operation may be aborted. |
2728 operation may be aborted. |
2732 </p> |
2729 </p> |
|
2730 |
2733 <dl> |
2731 <dl> |
2734 |
2732 |
2735 <dt><i>name</i> (str)</dt> |
2733 <dt><i>name</i> (str)</dt> |
2736 <dd> |
2734 <dd> |
2737 file/directory name to be diffed |
2735 file/directory name to be diffed |
2738 </dd> |
2736 </dd> |
2739 </dl> |
2737 </dl> |
2740 <a NAME="Git.vcsExists" ID="Git.vcsExists"></a> |
2738 <a NAME="Git.vcsExists" ID="Git.vcsExists"></a> |
2741 <h4>Git.vcsExists</h4> |
2739 <h4>Git.vcsExists</h4> |
2742 <b>vcsExists</b>(<i></i>) |
2740 <b>vcsExists</b>(<i></i>) |
2743 |
|
2744 <p> |
2741 <p> |
2745 Public method used to test for the presence of the git executable. |
2742 Public method used to test for the presence of the git executable. |
2746 </p> |
2743 </p> |
|
2744 |
2747 <dl> |
2745 <dl> |
2748 <dt>Return:</dt> |
2746 <dt>Return:</dt> |
2749 <dd> |
2747 <dd> |
2750 flag indicating the existance and an error message |
2748 flag indicating the existance and an error message |
2751 </dd> |
2749 </dd> |
2787 </dd> |
2785 </dd> |
2788 </dl> |
2786 </dl> |
2789 <a NAME="Git.vcsForget" ID="Git.vcsForget"></a> |
2787 <a NAME="Git.vcsForget" ID="Git.vcsForget"></a> |
2790 <h4>Git.vcsForget</h4> |
2788 <h4>Git.vcsForget</h4> |
2791 <b>vcsForget</b>(<i>name</i>) |
2789 <b>vcsForget</b>(<i>name</i>) |
2792 |
|
2793 <p> |
2790 <p> |
2794 Public method used to remove a file from the Mercurial repository. |
2791 Public method used to remove a file from the Mercurial repository. |
2795 </p> |
2792 </p> |
2796 <p> |
2793 <p> |
2797 This will not remove the file from the project directory. |
2794 This will not remove the file from the project directory. |
2798 </p> |
2795 </p> |
|
2796 |
2799 <dl> |
2797 <dl> |
2800 |
2798 |
2801 <dt><i>name</i> (str or list of str)</dt> |
2799 <dt><i>name</i> (str or list of str)</dt> |
2802 <dd> |
2800 <dd> |
2803 file/directory name to be removed |
2801 file/directory name to be removed |
2804 </dd> |
2802 </dd> |
2805 </dl> |
2803 </dl> |
2806 <a NAME="Git.vcsGetProjectBrowserHelper" ID="Git.vcsGetProjectBrowserHelper"></a> |
2804 <a NAME="Git.vcsGetProjectBrowserHelper" ID="Git.vcsGetProjectBrowserHelper"></a> |
2807 <h4>Git.vcsGetProjectBrowserHelper</h4> |
2805 <h4>Git.vcsGetProjectBrowserHelper</h4> |
2808 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) |
2806 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) |
2809 |
|
2810 <p> |
2807 <p> |
2811 Public method to instantiate a helper object for the different |
2808 Public method to instantiate a helper object for the different |
2812 project browsers. |
2809 project browsers. |
2813 </p> |
2810 </p> |
|
2811 |
2814 <dl> |
2812 <dl> |
2815 |
2813 |
2816 <dt><i>browser</i> (ProjectBaseBrowser)</dt> |
2814 <dt><i>browser</i> (ProjectBaseBrowser)</dt> |
2817 <dd> |
2815 <dd> |
2818 reference to the project browser object |
2816 reference to the project browser object |
2940 </dd> |
2938 </dd> |
2941 </dl> |
2939 </dl> |
2942 <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a> |
2940 <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a> |
2943 <h4>Git.vcsInitConfig</h4> |
2941 <h4>Git.vcsInitConfig</h4> |
2944 <b>vcsInitConfig</b>(<i>project</i>) |
2942 <b>vcsInitConfig</b>(<i>project</i>) |
2945 |
|
2946 <p> |
2943 <p> |
2947 Public method to initialize the VCS configuration. |
2944 Public method to initialize the VCS configuration. |
2948 </p> |
2945 </p> |
2949 <p> |
2946 <p> |
2950 This method ensures, that an ignore file exists. |
2947 This method ensures, that an ignore file exists. |
2951 </p> |
2948 </p> |
|
2949 |
2952 <dl> |
2950 <dl> |
2953 |
2951 |
2954 <dt><i>project</i> (Project)</dt> |
2952 <dt><i>project</i> (Project)</dt> |
2955 <dd> |
2953 <dd> |
2956 reference to the project |
2954 reference to the project |
2957 </dd> |
2955 </dd> |
2958 </dl> |
2956 </dl> |
2959 <a NAME="Git.vcsLogBrowser" ID="Git.vcsLogBrowser"></a> |
2957 <a NAME="Git.vcsLogBrowser" ID="Git.vcsLogBrowser"></a> |
2960 <h4>Git.vcsLogBrowser</h4> |
2958 <h4>Git.vcsLogBrowser</h4> |
2961 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) |
2959 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) |
2962 |
|
2963 <p> |
2960 <p> |
2964 Public method used to browse the log of a file/directory from the |
2961 Public method used to browse the log of a file/directory from the |
2965 Git repository. |
2962 Git repository. |
2966 </p> |
2963 </p> |
|
2964 |
2967 <dl> |
2965 <dl> |
2968 |
2966 |
2969 <dt><i>name</i> (str)</dt> |
2967 <dt><i>name</i> (str)</dt> |
2970 <dd> |
2968 <dd> |
2971 file/directory name to show the log of |
2969 file/directory name to show the log of |
2976 </dd> |
2974 </dd> |
2977 </dl> |
2975 </dl> |
2978 <a NAME="Git.vcsMerge" ID="Git.vcsMerge"></a> |
2976 <a NAME="Git.vcsMerge" ID="Git.vcsMerge"></a> |
2979 <h4>Git.vcsMerge</h4> |
2977 <h4>Git.vcsMerge</h4> |
2980 <b>vcsMerge</b>(<i>name</i>) |
2978 <b>vcsMerge</b>(<i>name</i>) |
2981 |
|
2982 <p> |
2979 <p> |
2983 Public method used to merge a URL/revision into the local project. |
2980 Public method used to merge a URL/revision into the local project. |
2984 </p> |
2981 </p> |
|
2982 |
2985 <dl> |
2983 <dl> |
2986 |
2984 |
2987 <dt><i>name</i> (str)</dt> |
2985 <dt><i>name</i> (str)</dt> |
2988 <dd> |
2986 <dd> |
2989 file/directory name to be merged |
2987 file/directory name to be merged |
2990 </dd> |
2988 </dd> |
2991 </dl> |
2989 </dl> |
2992 <a NAME="Git.vcsMove" ID="Git.vcsMove"></a> |
2990 <a NAME="Git.vcsMove" ID="Git.vcsMove"></a> |
2993 <h4>Git.vcsMove</h4> |
2991 <h4>Git.vcsMove</h4> |
2994 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) |
2992 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) |
2995 |
|
2996 <p> |
2993 <p> |
2997 Public method used to move a file/directory. |
2994 Public method used to move a file/directory. |
2998 </p> |
2995 </p> |
|
2996 |
2999 <dl> |
2997 <dl> |
3000 |
2998 |
3001 <dt><i>name</i> (str)</dt> |
2999 <dt><i>name</i> (str)</dt> |
3002 <dd> |
3000 <dd> |
3003 file/directory name to be moved |
3001 file/directory name to be moved |
3264 </dd> |
3262 </dd> |
3265 </dl> |
3263 </dl> |
3266 <a NAME="Git.vcsShutdown" ID="Git.vcsShutdown"></a> |
3264 <a NAME="Git.vcsShutdown" ID="Git.vcsShutdown"></a> |
3267 <h4>Git.vcsShutdown</h4> |
3265 <h4>Git.vcsShutdown</h4> |
3268 <b>vcsShutdown</b>(<i></i>) |
3266 <b>vcsShutdown</b>(<i></i>) |
3269 |
|
3270 <p> |
3267 <p> |
3271 Public method used to shutdown the Git interface. |
3268 Public method used to shutdown the Git interface. |
3272 </p> |
3269 </p> |
|
3270 |
3273 <a NAME="Git.vcsStatus" ID="Git.vcsStatus"></a> |
3271 <a NAME="Git.vcsStatus" ID="Git.vcsStatus"></a> |
3274 <h4>Git.vcsStatus</h4> |
3272 <h4>Git.vcsStatus</h4> |
3275 <b>vcsStatus</b>(<i>name</i>) |
3273 <b>vcsStatus</b>(<i>name</i>) |
3276 |
|
3277 <p> |
3274 <p> |
3278 Public method used to view the status of files/directories in the |
3275 Public method used to view the status of files/directories in the |
3279 Git repository. |
3276 Git repository. |
3280 </p> |
3277 </p> |
|
3278 |
3281 <dl> |
3279 <dl> |
3282 |
3280 |
3283 <dt><i>name</i> (str or list of str)</dt> |
3281 <dt><i>name</i> (str or list of str)</dt> |
3284 <dd> |
3282 <dd> |
3285 file/directory name(s) to show the status of |
3283 file/directory name(s) to show the status of |
3286 </dd> |
3284 </dd> |
3287 </dl> |
3285 </dl> |
3288 <a NAME="Git.vcsSupportCommandOptions" ID="Git.vcsSupportCommandOptions"></a> |
3286 <a NAME="Git.vcsSupportCommandOptions" ID="Git.vcsSupportCommandOptions"></a> |
3289 <h4>Git.vcsSupportCommandOptions</h4> |
3287 <h4>Git.vcsSupportCommandOptions</h4> |
3290 <b>vcsSupportCommandOptions</b>(<i></i>) |
3288 <b>vcsSupportCommandOptions</b>(<i></i>) |
3291 |
|
3292 <p> |
3289 <p> |
3293 Public method to signal the support of user settable command options. |
3290 Public method to signal the support of user settable command options. |
3294 </p> |
3291 </p> |
|
3292 |
3295 <dl> |
3293 <dl> |
3296 <dt>Return:</dt> |
3294 <dt>Return:</dt> |
3297 <dd> |
3295 <dd> |
3298 flag indicating the support of user settable command options |
3296 flag indicating the support of user settable command options |
3299 </dd> |
3297 </dd> |