Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.VCS.VersionControl.html
eric6/Documentation/Source/eric6.VCS.VersionControl.html
- changeset 7989
- a21d673a8f99
- parent 7900
- 72b88fb20261
equal
deleted
inserted
replaced
| 7988:c4c17121eff8 | 7989:a21d673a8f99 |
|---|---|
| 428 <dd> | 428 <dd> |
| 429 reference to the project object | 429 reference to the project object |
| 430 </dd> | 430 </dd> |
| 431 </dl> | 431 </dl> |
| 432 <dl> | 432 <dl> |
| 433 <dt>Returns:</dt> | 433 <dt>Return:</dt> |
| 434 <dd> | 434 <dd> |
| 435 reference to the monitor thread (QThread) | 435 reference to the monitor thread (QThread) |
| 436 </dd> | 436 </dd> |
| 437 </dl> | 437 </dl> |
| 438 <a NAME="VersionControl.addArguments" ID="VersionControl.addArguments"></a> | 438 <a NAME="VersionControl.addArguments" ID="VersionControl.addArguments"></a> |
| 488 | 488 |
| 489 <p> | 489 <p> |
| 490 Public method to retrieve the status of the auto update function. | 490 Public method to retrieve the status of the auto update function. |
| 491 </p> | 491 </p> |
| 492 <dl> | 492 <dl> |
| 493 <dt>Returns:</dt> | 493 <dt>Return:</dt> |
| 494 <dd> | 494 <dd> |
| 495 status of the auto update function (boolean) | 495 status of the auto update function (boolean) |
| 496 </dd> | 496 </dd> |
| 497 </dl> | 497 </dl> |
| 498 <a NAME="VersionControl.getStatusMonitorInterval" ID="VersionControl.getStatusMonitorInterval"></a> | 498 <a NAME="VersionControl.getStatusMonitorInterval" ID="VersionControl.getStatusMonitorInterval"></a> |
| 501 | 501 |
| 502 <p> | 502 <p> |
| 503 Public method to get the monitor interval. | 503 Public method to get the monitor interval. |
| 504 </p> | 504 </p> |
| 505 <dl> | 505 <dl> |
| 506 <dt>Returns:</dt> | 506 <dt>Return:</dt> |
| 507 <dd> | 507 <dd> |
| 508 interval in seconds (integer) | 508 interval in seconds (integer) |
| 509 </dd> | 509 </dd> |
| 510 </dl> | 510 </dl> |
| 511 <a NAME="VersionControl.setStatusMonitorAutoUpdate" ID="VersionControl.setStatusMonitorAutoUpdate"></a> | 511 <a NAME="VersionControl.setStatusMonitorAutoUpdate" ID="VersionControl.setStatusMonitorAutoUpdate"></a> |
| 553 <dd> | 553 <dd> |
| 554 path name (string) | 554 path name (string) |
| 555 </dd> | 555 </dd> |
| 556 </dl> | 556 </dl> |
| 557 <dl> | 557 <dl> |
| 558 <dt>Returns:</dt> | 558 <dt>Return:</dt> |
| 559 <dd> | 559 <dd> |
| 560 a tuple of 2 strings (dirname, filename). | 560 a tuple of 2 strings (dirname, filename). |
| 561 </dd> | 561 </dd> |
| 562 </dl> | 562 </dl> |
| 563 <a NAME="VersionControl.splitPathList" ID="VersionControl.splitPathList"></a> | 563 <a NAME="VersionControl.splitPathList" ID="VersionControl.splitPathList"></a> |
| 574 <dd> | 574 <dd> |
| 575 list of paths (list of strings) | 575 list of paths (list of strings) |
| 576 </dd> | 576 </dd> |
| 577 </dl> | 577 </dl> |
| 578 <dl> | 578 <dl> |
| 579 <dt>Returns:</dt> | 579 <dt>Return:</dt> |
| 580 <dd> | 580 <dd> |
| 581 a tuple of string and list of strings (dirname, filenamelist) | 581 a tuple of string and list of strings (dirname, filenamelist) |
| 582 </dd> | 582 </dd> |
| 583 </dl> | 583 </dl> |
| 584 <a NAME="VersionControl.startStatusMonitor" ID="VersionControl.startStatusMonitor"></a> | 584 <a NAME="VersionControl.startStatusMonitor" ID="VersionControl.startStatusMonitor"></a> |
| 594 <dd> | 594 <dd> |
| 595 reference to the project object | 595 reference to the project object |
| 596 </dd> | 596 </dd> |
| 597 </dl> | 597 </dl> |
| 598 <dl> | 598 <dl> |
| 599 <dt>Returns:</dt> | 599 <dt>Return:</dt> |
| 600 <dd> | 600 <dd> |
| 601 reference to the monitor thread (QThread) | 601 reference to the monitor thread (QThread) |
| 602 </dd> | 602 </dd> |
| 603 </dl> | 603 </dl> |
| 604 <a NAME="VersionControl.startSynchronizedProcess" ID="VersionControl.startSynchronizedProcess"></a> | 604 <a NAME="VersionControl.startSynchronizedProcess" ID="VersionControl.startSynchronizedProcess"></a> |
| 630 <dd> | 630 <dd> |
| 631 working directory for the process (string) | 631 working directory for the process (string) |
| 632 </dd> | 632 </dd> |
| 633 </dl> | 633 </dl> |
| 634 <dl> | 634 <dl> |
| 635 <dt>Returns:</dt> | 635 <dt>Return:</dt> |
| 636 <dd> | 636 <dd> |
| 637 flag indicating normal exit (boolean) | 637 flag indicating normal exit (boolean) |
| 638 </dd> | 638 </dd> |
| 639 </dl> | 639 </dl> |
| 640 <a NAME="VersionControl.stopStatusMonitor" ID="VersionControl.stopStatusMonitor"></a> | 640 <a NAME="VersionControl.stopStatusMonitor" ID="VersionControl.stopStatusMonitor"></a> |
| 740 <dd> | 740 <dd> |
| 741 directory to check in (string) | 741 directory to check in (string) |
| 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 the received dictionary completed with a combination of | 747 the received dictionary completed with a combination of |
| 748 canBeCommited and canBeAdded or None in order to signal an error | 748 canBeCommited and canBeAdded or None in order to signal an error |
| 749 </dd> | 749 </dd> |
| 750 </dl> | 750 </dl> |
| 777 <dd> | 777 <dd> |
| 778 flag indicating quiet operations | 778 flag indicating quiet operations |
| 779 </dd> | 779 </dd> |
| 780 </dl> | 780 </dl> |
| 781 <dl> | 781 <dl> |
| 782 <dt>Returns:</dt> | 782 <dt>Return:</dt> |
| 783 <dd> | 783 <dd> |
| 784 flag indicating an execution without errors (boolean) | 784 flag indicating an execution without errors (boolean) |
| 785 </dd> | 785 </dd> |
| 786 </dl> | 786 </dl> |
| 787 <dl> | 787 <dl> |
| 858 <dd> | 858 <dd> |
| 859 flag indicating quiet operations (boolean) | 859 flag indicating quiet operations (boolean) |
| 860 </dd> | 860 </dd> |
| 861 </dl> | 861 </dl> |
| 862 <dl> | 862 <dl> |
| 863 <dt>Returns:</dt> | 863 <dt>Return:</dt> |
| 864 <dd> | 864 <dd> |
| 865 flag indicating success (boolean) | 865 flag indicating success (boolean) |
| 866 </dd> | 866 </dd> |
| 867 </dl> | 867 </dl> |
| 868 <dl> | 868 <dl> |
| 932 | 932 |
| 933 <p> | 933 <p> |
| 934 Public method used to test for the presence of the vcs. | 934 Public method used to test for the presence of the vcs. |
| 935 </p> | 935 </p> |
| 936 <dl> | 936 <dl> |
| 937 <dt>Returns:</dt> | 937 <dt>Return:</dt> |
| 938 <dd> | 938 <dd> |
| 939 tuple of flag indicating the existence and a string | 939 tuple of flag indicating the existence and a string |
| 940 giving an error message in case of failure | 940 giving an error message in case of failure |
| 941 </dd> | 941 </dd> |
| 942 </dl> | 942 </dl> |
| 965 <dd> | 965 <dd> |
| 966 project directory to create (string) | 966 project directory to create (string) |
| 967 </dd> | 967 </dd> |
| 968 </dl> | 968 </dl> |
| 969 <dl> | 969 <dl> |
| 970 <dt>Returns:</dt> | 970 <dt>Return:</dt> |
| 971 <dd> | 971 <dd> |
| 972 flag indicating an execution without errors (boolean) | 972 flag indicating an execution without errors (boolean) |
| 973 </dd> | 973 </dd> |
| 974 </dl> | 974 </dl> |
| 975 <dl> | 975 <dl> |
| 986 | 986 |
| 987 <p> | 987 <p> |
| 988 Public method used to retrieve the options of the vcs. | 988 Public method used to retrieve the options of the vcs. |
| 989 </p> | 989 </p> |
| 990 <dl> | 990 <dl> |
| 991 <dt>Returns:</dt> | 991 <dt>Return:</dt> |
| 992 <dd> | 992 <dd> |
| 993 a dictionary of option strings that can be passed to | 993 a dictionary of option strings that can be passed to |
| 994 vcsSetOptions. | 994 vcsSetOptions. |
| 995 </dd> | 995 </dd> |
| 996 </dl> | 996 </dl> |
| 1000 | 1000 |
| 1001 <p> | 1001 <p> |
| 1002 Public method used to retrieve vcs specific data. | 1002 Public method used to retrieve vcs specific data. |
| 1003 </p> | 1003 </p> |
| 1004 <dl> | 1004 <dl> |
| 1005 <dt>Returns:</dt> | 1005 <dt>Return:</dt> |
| 1006 <dd> | 1006 <dd> |
| 1007 a dictionary of vcs specific data | 1007 a dictionary of vcs specific data |
| 1008 </dd> | 1008 </dd> |
| 1009 </dl> | 1009 </dl> |
| 1010 <a NAME="VersionControl.vcsGetProjectBrowserHelper" ID="VersionControl.vcsGetProjectBrowserHelper"></a> | 1010 <a NAME="VersionControl.vcsGetProjectBrowserHelper" ID="VersionControl.vcsGetProjectBrowserHelper"></a> |
| 1030 flag indicating, the helper is requested | 1030 flag indicating, the helper is requested |
| 1031 for the translations browser (this needs some special treatment) | 1031 for the translations browser (this needs some special treatment) |
| 1032 </dd> | 1032 </dd> |
| 1033 </dl> | 1033 </dl> |
| 1034 <dl> | 1034 <dl> |
| 1035 <dt>Returns:</dt> | 1035 <dt>Return:</dt> |
| 1036 <dd> | 1036 <dd> |
| 1037 the project browser helper object | 1037 the project browser helper object |
| 1038 </dd> | 1038 </dd> |
| 1039 </dl> | 1039 </dl> |
| 1040 <dl> | 1040 <dl> |
| 1058 <dd> | 1058 <dd> |
| 1059 reference to the project object | 1059 reference to the project object |
| 1060 </dd> | 1060 </dd> |
| 1061 </dl> | 1061 </dl> |
| 1062 <dl> | 1062 <dl> |
| 1063 <dt>Returns:</dt> | 1063 <dt>Return:</dt> |
| 1064 <dd> | 1064 <dd> |
| 1065 the project helper object | 1065 the project helper object |
| 1066 </dd> | 1066 </dd> |
| 1067 </dl> | 1067 </dl> |
| 1068 <dl> | 1068 <dl> |
| 1098 <dd> | 1098 <dd> |
| 1099 flag indicating to add all files to the repository | 1099 flag indicating to add all files to the repository |
| 1100 </dd> | 1100 </dd> |
| 1101 </dl> | 1101 </dl> |
| 1102 <dl> | 1102 <dl> |
| 1103 <dt>Returns:</dt> | 1103 <dt>Return:</dt> |
| 1104 <dd> | 1104 <dd> |
| 1105 tuple containing a flag indicating an execution without errors | 1105 tuple containing a flag indicating an execution without errors |
| 1106 and a flag indicating the version control status | 1106 and a flag indicating the version control status |
| 1107 </dd> | 1107 </dd> |
| 1108 </dl> | 1108 </dl> |
| 1137 <dd> | 1137 <dd> |
| 1138 flag indicating quiet operations (boolean) | 1138 flag indicating quiet operations (boolean) |
| 1139 </dd> | 1139 </dd> |
| 1140 </dl> | 1140 </dl> |
| 1141 <dl> | 1141 <dl> |
| 1142 <dt>Returns:</dt> | 1142 <dt>Return:</dt> |
| 1143 <dd> | 1143 <dd> |
| 1144 flag indicating success (boolean) | 1144 flag indicating success (boolean) |
| 1145 </dd> | 1145 </dd> |
| 1146 </dl> | 1146 </dl> |
| 1147 <dl> | 1147 <dl> |
| 1245 <dd> | 1245 <dd> |
| 1246 flag indicating quiet operations | 1246 flag indicating quiet operations |
| 1247 </dd> | 1247 </dd> |
| 1248 </dl> | 1248 </dl> |
| 1249 <dl> | 1249 <dl> |
| 1250 <dt>Returns:</dt> | 1250 <dt>Return:</dt> |
| 1251 <dd> | 1251 <dd> |
| 1252 flag indicating successfull operation (boolean) | 1252 flag indicating successfull operation (boolean) |
| 1253 </dd> | 1253 </dd> |
| 1254 </dl> | 1254 </dl> |
| 1255 <dl> | 1255 <dl> |
| 1266 | 1266 |
| 1267 <p> | 1267 <p> |
| 1268 Public method returning the name of the vcs. | 1268 Public method returning the name of the vcs. |
| 1269 </p> | 1269 </p> |
| 1270 <dl> | 1270 <dl> |
| 1271 <dt>Returns:</dt> | 1271 <dt>Return:</dt> |
| 1272 <dd> | 1272 <dd> |
| 1273 name of the vcs (string) | 1273 name of the vcs (string) |
| 1274 </dd> | 1274 </dd> |
| 1275 </dl> | 1275 </dl> |
| 1276 <dl> | 1276 <dl> |
| 1352 <dd> | 1352 <dd> |
| 1353 filename to check (string) | 1353 filename to check (string) |
| 1354 </dd> | 1354 </dd> |
| 1355 </dl> | 1355 </dl> |
| 1356 <dl> | 1356 <dl> |
| 1357 <dt>Returns:</dt> | 1357 <dt>Return:</dt> |
| 1358 <dd> | 1358 <dd> |
| 1359 a combination of canBeCommited and canBeAdded or | 1359 a combination of canBeCommited and canBeAdded or |
| 1360 0 in order to signal an error | 1360 0 in order to signal an error |
| 1361 </dd> | 1361 </dd> |
| 1362 </dl> | 1362 </dl> |
| 1389 <dd> | 1389 <dd> |
| 1390 flag indicating quiet operations | 1390 flag indicating quiet operations |
| 1391 </dd> | 1391 </dd> |
| 1392 </dl> | 1392 </dl> |
| 1393 <dl> | 1393 <dl> |
| 1394 <dt>Returns:</dt> | 1394 <dt>Return:</dt> |
| 1395 <dd> | 1395 <dd> |
| 1396 flag indicating success (boolean) | 1396 flag indicating success (boolean) |
| 1397 </dd> | 1397 </dd> |
| 1398 </dl> | 1398 </dl> |
| 1399 <dl> | 1399 <dl> |
| 1417 <dd> | 1417 <dd> |
| 1418 local path to get the repository infos (string) | 1418 local path to get the repository infos (string) |
| 1419 </dd> | 1419 </dd> |
| 1420 </dl> | 1420 </dl> |
| 1421 <dl> | 1421 <dl> |
| 1422 <dt>Returns:</dt> | 1422 <dt>Return:</dt> |
| 1423 <dd> | 1423 <dd> |
| 1424 string with ready formated info for display (string) | 1424 string with ready formated info for display (string) |
| 1425 </dd> | 1425 </dd> |
| 1426 </dl> | 1426 </dl> |
| 1427 <dl> | 1427 <dl> |
| 1558 | 1558 |
| 1559 <p> | 1559 <p> |
| 1560 Public method to signal the support of user settable command options. | 1560 Public method to signal the support of user settable command options. |
| 1561 </p> | 1561 </p> |
| 1562 <dl> | 1562 <dl> |
| 1563 <dt>Returns:</dt> | 1563 <dt>Return:</dt> |
| 1564 <dd> | 1564 <dd> |
| 1565 flag indicating the support of user settable command options | 1565 flag indicating the support of user settable command options |
| 1566 (boolean) | 1566 (boolean) |
| 1567 </dd> | 1567 </dd> |
| 1568 </dl> | 1568 </dl> |
| 1579 <dd> | 1579 <dd> |
| 1580 directory name to be switched (string) | 1580 directory name to be switched (string) |
| 1581 </dd> | 1581 </dd> |
| 1582 </dl> | 1582 </dl> |
| 1583 <dl> | 1583 <dl> |
| 1584 <dt>Returns:</dt> | 1584 <dt>Return:</dt> |
| 1585 <dd> | 1585 <dd> |
| 1586 flag indicating, that the switch contained an add | 1586 flag indicating, that the switch contained an add |
| 1587 or delete (boolean) | 1587 or delete (boolean) |
| 1588 </dd> | 1588 </dd> |
| 1589 </dl> | 1589 </dl> |
| 1634 <dd> | 1634 <dd> |
| 1635 flag indicating quiet operations (boolean) | 1635 flag indicating quiet operations (boolean) |
| 1636 </dd> | 1636 </dd> |
| 1637 </dl> | 1637 </dl> |
| 1638 <dl> | 1638 <dl> |
| 1639 <dt>Returns:</dt> | 1639 <dt>Return:</dt> |
| 1640 <dd> | 1640 <dd> |
| 1641 flag indicating, that the update contained an add | 1641 flag indicating, that the update contained an add |
| 1642 or delete (boolean) | 1642 or delete (boolean) |
| 1643 </dd> | 1643 </dd> |
| 1644 </dl> | 1644 </dl> |
