Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.VCS.VersionControl.html
eric7/Documentation/Source/eric7.VCS.VersionControl.html
- branch
- eric7
- changeset 8652
- 8cacde11f4fd
- parent 8623
- fced5aa98d41
equal
deleted
inserted
replaced
| 8651:ce4c3c401482 | 8652:8cacde11f4fd |
|---|---|
| 79 <h3>Derived from</h3> | 79 <h3>Derived from</h3> |
| 80 QObject | 80 QObject |
| 81 <h3>Class Attributes</h3> | 81 <h3>Class Attributes</h3> |
| 82 | 82 |
| 83 <table> | 83 <table> |
| 84 <tr><td>canBeAdded</td></tr><tr><td>canBeCommitted</td></tr> | 84 <tr><td>canBeAdded</td></tr><tr><td>canBeCommitted</td></tr><tr><td>commitHistoryData</td></tr><tr><td>commitHistoryLock</td></tr> |
| 85 </table> | 85 </table> |
| 86 <h3>Class Methods</h3> | 86 <h3>Class Methods</h3> |
| 87 | 87 |
| 88 <table> | 88 <table> |
| 89 <tr><td>None</td></tr> | 89 <tr><td>None</td></tr> |
| 115 <tr> | 115 <tr> |
| 116 <td><a href="#VersionControl._createStatusMonitorThread">_createStatusMonitorThread</a></td> | 116 <td><a href="#VersionControl._createStatusMonitorThread">_createStatusMonitorThread</a></td> |
| 117 <td>Protected method to create an instance of the VCS status monitor thread.</td> | 117 <td>Protected method to create an instance of the VCS status monitor thread.</td> |
| 118 </tr> | 118 </tr> |
| 119 <tr> | 119 <tr> |
| 120 <td><a href="#VersionControl._vcsAddProjectCommitMessage">_vcsAddProjectCommitMessage</a></td> | |
| 121 <td>Protected method to add a commit message to the list of project specific saved messages.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#VersionControl._vcsClearProjectCommitMessages">_vcsClearProjectCommitMessages</a></td> | |
| 125 <td>Protected method to clear the list of project specific saved messages.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 128 <td><a href="#VersionControl._vcsProjectCommitMessages">_vcsProjectCommitMessages</a></td> | |
| 129 <td>Protected method to get the list of saved commit messages.</td> | |
| 130 </tr> | |
| 131 <tr> | |
| 120 <td><a href="#VersionControl.addArguments">addArguments</a></td> | 132 <td><a href="#VersionControl.addArguments">addArguments</a></td> |
| 121 <td>Public method to add an argument list to the already present arguments.</td> | 133 <td>Public method to add an argument list to the already present arguments.</td> |
| 122 </tr> | 134 </tr> |
| 123 <tr> | 135 <tr> |
| 124 <td><a href="#VersionControl.checkVCSStatus">checkVCSStatus</a></td> | 136 <td><a href="#VersionControl.checkVCSStatus">checkVCSStatus</a></td> |
| 175 <tr> | 187 <tr> |
| 176 <td><a href="#VersionControl.vcsAddBinary">vcsAddBinary</a></td> | 188 <td><a href="#VersionControl.vcsAddBinary">vcsAddBinary</a></td> |
| 177 <td>Public method used to add a file/directory in binary mode in the vcs.</td> | 189 <td>Public method used to add a file/directory in binary mode in the vcs.</td> |
| 178 </tr> | 190 </tr> |
| 179 <tr> | 191 <tr> |
| 192 <td><a href="#VersionControl.vcsAddCommitMessage">vcsAddCommitMessage</a></td> | |
| 193 <td>Public method to add a commit message to the list of saved messages.</td> | |
| 194 </tr> | |
| 195 <tr> | |
| 180 <td><a href="#VersionControl.vcsAddTree">vcsAddTree</a></td> | 196 <td><a href="#VersionControl.vcsAddTree">vcsAddTree</a></td> |
| 181 <td>Public method to add a directory tree rooted at path in the vcs.</td> | 197 <td>Public method to add a directory tree rooted at path in the vcs.</td> |
| 182 </tr> | 198 </tr> |
| 183 <tr> | 199 <tr> |
| 184 <td><a href="#VersionControl.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td> | 200 <td><a href="#VersionControl.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td> |
| 191 <tr> | 207 <tr> |
| 192 <td><a href="#VersionControl.vcsCleanup">vcsCleanup</a></td> | 208 <td><a href="#VersionControl.vcsCleanup">vcsCleanup</a></td> |
| 193 <td>Public method used to cleanup the local copy.</td> | 209 <td>Public method used to cleanup the local copy.</td> |
| 194 </tr> | 210 </tr> |
| 195 <tr> | 211 <tr> |
| 212 <td><a href="#VersionControl.vcsClearCommitMessages">vcsClearCommitMessages</a></td> | |
| 213 <td>Public method to clear the list of saved messages.</td> | |
| 214 </tr> | |
| 215 <tr> | |
| 196 <td><a href="#VersionControl.vcsCommandLine">vcsCommandLine</a></td> | 216 <td><a href="#VersionControl.vcsCommandLine">vcsCommandLine</a></td> |
| 197 <td>Public method used to execute arbitrary vcs commands.</td> | 217 <td>Public method used to execute arbitrary vcs commands.</td> |
| 198 </tr> | 218 </tr> |
| 199 <tr> | 219 <tr> |
| 200 <td><a href="#VersionControl.vcsCommit">vcsCommit</a></td> | 220 <td><a href="#VersionControl.vcsCommit">vcsCommit</a></td> |
| 201 <td>Public method used to make the change of a file/directory permanent in the vcs.</td> | 221 <td>Public method used to make the change of a file/directory permanent in the vcs.</td> |
| 222 </tr> | |
| 223 <tr> | |
| 224 <td><a href="#VersionControl.vcsCommitMessages">vcsCommitMessages</a></td> | |
| 225 <td>Public method to get the list of saved commit messages.</td> | |
| 202 </tr> | 226 </tr> |
| 203 <tr> | 227 <tr> |
| 204 <td><a href="#VersionControl.vcsConvertProject">vcsConvertProject</a></td> | 228 <td><a href="#VersionControl.vcsConvertProject">vcsConvertProject</a></td> |
| 205 <td>Public method to convert an uncontrolled project to a version controlled project.</td> | 229 <td>Public method to convert an uncontrolled project to a version controlled project.</td> |
| 206 </tr> | 230 </tr> |
| 461 <dt>Return:</dt> | 485 <dt>Return:</dt> |
| 462 <dd> | 486 <dd> |
| 463 reference to the monitor thread (QThread) | 487 reference to the monitor thread (QThread) |
| 464 </dd> | 488 </dd> |
| 465 </dl> | 489 </dl> |
| 490 <a NAME="VersionControl._vcsAddProjectCommitMessage" ID="VersionControl._vcsAddProjectCommitMessage"></a> | |
| 491 <h4>VersionControl._vcsAddProjectCommitMessage</h4> | |
| 492 <b>_vcsAddProjectCommitMessage</b>(<i>message</i>) | |
| 493 | |
| 494 <p> | |
| 495 Protected method to add a commit message to the list of project | |
| 496 specific saved messages. | |
| 497 </p> | |
| 498 <dl> | |
| 499 | |
| 500 <dt><i>message</i> (str)</dt> | |
| 501 <dd> | |
| 502 message to be added | |
| 503 </dd> | |
| 504 </dl> | |
| 505 <dl> | |
| 506 <dt>Return:</dt> | |
| 507 <dd> | |
| 508 flag indicating success | |
| 509 </dd> | |
| 510 </dl> | |
| 511 <dl> | |
| 512 <dt>Return Type:</dt> | |
| 513 <dd> | |
| 514 bool | |
| 515 </dd> | |
| 516 </dl> | |
| 517 <a NAME="VersionControl._vcsClearProjectCommitMessages" ID="VersionControl._vcsClearProjectCommitMessages"></a> | |
| 518 <h4>VersionControl._vcsClearProjectCommitMessages</h4> | |
| 519 <b>_vcsClearProjectCommitMessages</b>(<i></i>) | |
| 520 | |
| 521 <p> | |
| 522 Protected method to clear the list of project specific saved messages. | |
| 523 </p> | |
| 524 <dl> | |
| 525 <dt>Return:</dt> | |
| 526 <dd> | |
| 527 flag indicating success | |
| 528 </dd> | |
| 529 </dl> | |
| 530 <dl> | |
| 531 <dt>Return Type:</dt> | |
| 532 <dd> | |
| 533 bool | |
| 534 </dd> | |
| 535 </dl> | |
| 536 <a NAME="VersionControl._vcsProjectCommitMessages" ID="VersionControl._vcsProjectCommitMessages"></a> | |
| 537 <h4>VersionControl._vcsProjectCommitMessages</h4> | |
| 538 <b>_vcsProjectCommitMessages</b>(<i></i>) | |
| 539 | |
| 540 <p> | |
| 541 Protected method to get the list of saved commit messages. | |
| 542 </p> | |
| 543 <dl> | |
| 544 <dt>Return:</dt> | |
| 545 <dd> | |
| 546 list of saved commit messages | |
| 547 </dd> | |
| 548 </dl> | |
| 549 <dl> | |
| 550 <dt>Return Type:</dt> | |
| 551 <dd> | |
| 552 list of str | |
| 553 </dd> | |
| 554 </dl> | |
| 466 <a NAME="VersionControl.addArguments" ID="VersionControl.addArguments"></a> | 555 <a NAME="VersionControl.addArguments" ID="VersionControl.addArguments"></a> |
| 467 <h4>VersionControl.addArguments</h4> | 556 <h4>VersionControl.addArguments</h4> |
| 468 <b>addArguments</b>(<i>args, argslist</i>) | 557 <b>addArguments</b>(<i>args, argslist</i>) |
| 469 | 558 |
| 470 <p> | 559 <p> |
| 726 <dd> | 815 <dd> |
| 727 to indicate that this method must be | 816 to indicate that this method must be |
| 728 implemented by a subclass | 817 implemented by a subclass |
| 729 </dd> | 818 </dd> |
| 730 </dl> | 819 </dl> |
| 820 <a NAME="VersionControl.vcsAddCommitMessage" ID="VersionControl.vcsAddCommitMessage"></a> | |
| 821 <h4>VersionControl.vcsAddCommitMessage</h4> | |
| 822 <b>vcsAddCommitMessage</b>(<i>message</i>) | |
| 823 | |
| 824 <p> | |
| 825 Public method to add a commit message to the list of saved messages. | |
| 826 </p> | |
| 827 <dl> | |
| 828 | |
| 829 <dt><i>message</i> (str)</dt> | |
| 830 <dd> | |
| 831 message to be added | |
| 832 </dd> | |
| 833 </dl> | |
| 834 <dl> | |
| 835 | |
| 836 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 837 <dd> | |
| 838 to indicate that this method must be | |
| 839 implemented by a subclass | |
| 840 </dd> | |
| 841 </dl> | |
| 731 <a NAME="VersionControl.vcsAddTree" ID="VersionControl.vcsAddTree"></a> | 842 <a NAME="VersionControl.vcsAddTree" ID="VersionControl.vcsAddTree"></a> |
| 732 <h4>VersionControl.vcsAddTree</h4> | 843 <h4>VersionControl.vcsAddTree</h4> |
| 733 <b>vcsAddTree</b>(<i>path</i>) | 844 <b>vcsAddTree</b>(<i>path</i>) |
| 734 | 845 |
| 735 <p> | 846 <p> |
| 840 <dd> | 951 <dd> |
| 841 to indicate that this method must be | 952 to indicate that this method must be |
| 842 implemented by a subclass | 953 implemented by a subclass |
| 843 </dd> | 954 </dd> |
| 844 </dl> | 955 </dl> |
| 956 <a NAME="VersionControl.vcsClearCommitMessages" ID="VersionControl.vcsClearCommitMessages"></a> | |
| 957 <h4>VersionControl.vcsClearCommitMessages</h4> | |
| 958 <b>vcsClearCommitMessages</b>(<i></i>) | |
| 959 | |
| 960 <p> | |
| 961 Public method to clear the list of saved messages. | |
| 962 </p> | |
| 963 <dl> | |
| 964 | |
| 965 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 966 <dd> | |
| 967 to indicate that this method must be | |
| 968 implemented by a subclass | |
| 969 </dd> | |
| 970 </dl> | |
| 845 <a NAME="VersionControl.vcsCommandLine" ID="VersionControl.vcsCommandLine"></a> | 971 <a NAME="VersionControl.vcsCommandLine" ID="VersionControl.vcsCommandLine"></a> |
| 846 <h4>VersionControl.vcsCommandLine</h4> | 972 <h4>VersionControl.vcsCommandLine</h4> |
| 847 <b>vcsCommandLine</b>(<i>name</i>) | 973 <b>vcsCommandLine</b>(<i>name</i>) |
| 848 | 974 |
| 849 <p> | 975 <p> |
| 899 <dd> | 1025 <dd> |
| 900 to indicate that this method must be | 1026 to indicate that this method must be |
| 901 implemented by a subclass | 1027 implemented by a subclass |
| 902 </dd> | 1028 </dd> |
| 903 </dl> | 1029 </dl> |
| 1030 <a NAME="VersionControl.vcsCommitMessages" ID="VersionControl.vcsCommitMessages"></a> | |
| 1031 <h4>VersionControl.vcsCommitMessages</h4> | |
| 1032 <b>vcsCommitMessages</b>(<i></i>) | |
| 1033 | |
| 1034 <p> | |
| 1035 Public method to get the list of saved commit messages. | |
| 1036 </p> | |
| 1037 <dl> | |
| 1038 <dt>Return:</dt> | |
| 1039 <dd> | |
| 1040 list of saved commit messages | |
| 1041 </dd> | |
| 1042 </dl> | |
| 1043 <dl> | |
| 1044 <dt>Return Type:</dt> | |
| 1045 <dd> | |
| 1046 list of str | |
| 1047 </dd> | |
| 1048 </dl> | |
| 1049 <dl> | |
| 1050 | |
| 1051 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 1052 <dd> | |
| 1053 to indicate that this method must be | |
| 1054 implemented by a subclass | |
| 1055 </dd> | |
| 1056 </dl> | |
| 904 <a NAME="VersionControl.vcsConvertProject" ID="VersionControl.vcsConvertProject"></a> | 1057 <a NAME="VersionControl.vcsConvertProject" ID="VersionControl.vcsConvertProject"></a> |
| 905 <h4>VersionControl.vcsConvertProject</h4> | 1058 <h4>VersionControl.vcsConvertProject</h4> |
| 906 <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>) | 1059 <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>) |
| 907 | 1060 |
| 908 <p> | 1061 <p> |
