Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html

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

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 10259
b51dfacef37f
child 10479
856476537696
equal deleted inserted replaced
10437:2f70ca07f0af 10438:4cd7e5a8b3cf
584 <p> 584 <p>
585 Constructor 585 Constructor
586 </p> 586 </p>
587 <dl> 587 <dl>
588 588
589 <dt><i>plugin</i></dt> 589 <dt><i>plugin</i> (VcsGitPlugin)</dt>
590 <dd> 590 <dd>
591 reference to the plugin object 591 reference to the plugin object
592 </dd> 592 </dd>
593 <dt><i>parent</i></dt> 593 <dt><i>parent</i> (QWidget)</dt>
594 <dd> 594 <dd>
595 parent widget (QWidget) 595 parent widget
596 </dd> 596 </dd>
597 <dt><i>name</i></dt> 597 <dt><i>name</i> (str)</dt>
598 <dd> 598 <dd>
599 name of this object (string) 599 name of this object
600 </dd> 600 </dd>
601 </dl> 601 </dl>
602 <a NAME="Git.__gitGetFileForRevision" ID="Git.__gitGetFileForRevision"></a> 602 <a NAME="Git.__gitGetFileForRevision" ID="Git.__gitGetFileForRevision"></a>
603 <h4>Git.__gitGetFileForRevision</h4> 603 <h4>Git.__gitGetFileForRevision</h4>
604 <b>__gitGetFileForRevision</b>(<i>name, rev=""</i>) 604 <b>__gitGetFileForRevision</b>(<i>name, rev=""</i>)
607 Private method to get a file for a specific revision from the 607 Private method to get a file for a specific revision from the
608 repository. 608 repository.
609 </p> 609 </p>
610 <dl> 610 <dl>
611 611
612 <dt><i>name</i></dt> 612 <dt><i>name</i> (str)</dt>
613 <dd> 613 <dd>
614 file name to get from the repository (string) 614 file name to get from the repository
615 </dd> 615 </dd>
616 <dt><i>rev</i></dt> 616 <dt><i>rev</i> (str)</dt>
617 <dd> 617 <dd>
618 revision to retrieve (string) 618 revision to retrieve
619 </dd> 619 </dd>
620 </dl> 620 </dl>
621 <dl> 621 <dl>
622 <dt>Return:</dt> 622 <dt>Return:</dt>
623 <dd> 623 <dd>
624 contents of the file (string) and an error message (string) 624 contents of the file (string) and an error message
625 </dd>
626 </dl>
627 <dl>
628 <dt>Return Type:</dt>
629 <dd>
630 str
625 </dd> 631 </dd>
626 </dl> 632 </dl>
627 <a NAME="Git.__gitGetStashesList" ID="Git.__gitGetStashesList"></a> 633 <a NAME="Git.__gitGetStashesList" ID="Git.__gitGetStashesList"></a>
628 <h4>Git.__gitGetStashesList</h4> 634 <h4>Git.__gitGetStashesList</h4>
629 <b>__gitGetStashesList</b>(<i>projectDir</i>) 635 <b>__gitGetStashesList</b>(<i>projectDir</i>)
631 <p> 637 <p>
632 Private method to get a list of stash names. 638 Private method to get a list of stash names.
633 </p> 639 </p>
634 <dl> 640 <dl>
635 641
636 <dt><i>projectDir</i></dt> 642 <dt><i>projectDir</i> (str)</dt>
637 <dd> 643 <dd>
638 name of the project directory (string) 644 name of the project directory
639 </dd> 645 </dd>
640 </dl> 646 </dl>
641 <dl> 647 <dl>
642 <dt>Return:</dt> 648 <dt>Return:</dt>
643 <dd> 649 <dd>
644 list of available stashes (list of string) 650 list of available stashes
651 </dd>
652 </dl>
653 <dl>
654 <dt>Return Type:</dt>
655 <dd>
656 list of str
645 </dd> 657 </dd>
646 </dl> 658 </dl>
647 <a NAME="Git.__gitSubmodulesList" ID="Git.__gitSubmodulesList"></a> 659 <a NAME="Git.__gitSubmodulesList" ID="Git.__gitSubmodulesList"></a>
648 <h4>Git.__gitSubmodulesList</h4> 660 <h4>Git.__gitSubmodulesList</h4>
649 <b>__gitSubmodulesList</b>(<i>repodir</i>) 661 <b>__gitSubmodulesList</b>(<i>repodir</i>)
739 Protected method to create an instance of the VCS status monitor 751 Protected method to create an instance of the VCS status monitor
740 thread. 752 thread.
741 </p> 753 </p>
742 <dl> 754 <dl>
743 755
744 <dt><i>interval</i></dt> 756 <dt><i>interval</i> (int)</dt>
745 <dd> 757 <dd>
746 check interval for the monitor thread in seconds 758 check interval for the monitor thread in seconds
747 (integer) 759 </dd>
748 </dd> 760 <dt><i>project</i> (Project)</dt>
749 <dt><i>project</i></dt> 761 <dd>
750 <dd> 762 reference to the project object
751 reference to the project object (Project) 763 </dd>
752 </dd> 764 </dl>
753 </dl> 765 <dl>
754 <dl> 766 <dt>Return:</dt>
755 <dt>Return:</dt> 767 <dd>
756 <dd> 768 reference to the monitor thread
757 reference to the monitor thread (QThread) 769 </dd>
770 </dl>
771 <dl>
772 <dt>Return Type:</dt>
773 <dd>
774 GitStatusMonitorThread
758 </dd> 775 </dd>
759 </dl> 776 </dl>
760 <a NAME="Git.clearStatusCache" ID="Git.clearStatusCache"></a> 777 <a NAME="Git.clearStatusCache" ID="Git.clearStatusCache"></a>
761 <h4>Git.clearStatusCache</h4> 778 <h4>Git.clearStatusCache</h4>
762 <b>clearStatusCache</b>(<i></i>) 779 <b>clearStatusCache</b>(<i></i>)
798 Public method to get a reference to the plugin object. 815 Public method to get a reference to the plugin object.
799 </p> 816 </p>
800 <dl> 817 <dl>
801 <dt>Return:</dt> 818 <dt>Return:</dt>
802 <dd> 819 <dd>
803 reference to the plugin object (VcsGitPlugin) 820 reference to the plugin object
821 </dd>
822 </dl>
823 <dl>
824 <dt>Return Type:</dt>
825 <dd>
826 VcsGitPlugin
804 </dd> 827 </dd>
805 </dl> 828 </dl>
806 <a NAME="Git.gitAddRemote" ID="Git.gitAddRemote"></a> 829 <a NAME="Git.gitAddRemote" ID="Git.gitAddRemote"></a>
807 <h4>Git.gitAddRemote</h4> 830 <h4>Git.gitAddRemote</h4>
808 <b>gitAddRemote</b>(<i>projectDir</i>) 831 <b>gitAddRemote</b>(<i>projectDir</i>)
810 <p> 833 <p>
811 Public method to add a remote repository. 834 Public method to add a remote repository.
812 </p> 835 </p>
813 <dl> 836 <dl>
814 837
815 <dt><i>projectDir</i></dt> 838 <dt><i>projectDir</i> (str)</dt>
816 <dd> 839 <dd>
817 name of the project directory (string) 840 name of the project directory
818 </dd> 841 </dd>
819 </dl> 842 </dl>
820 <a NAME="Git.gitApply" ID="Git.gitApply"></a> 843 <a NAME="Git.gitApply" ID="Git.gitApply"></a>
821 <h4>Git.gitApply</h4> 844 <h4>Git.gitApply</h4>
822 <b>gitApply</b>(<i>repodir, patchFile, cached=False, reverse=False, noDialog=False</i>) 845 <b>gitApply</b>(<i>repodir, patchFile, cached=False, reverse=False, noDialog=False</i>)
824 <p> 847 <p>
825 Public method to apply a patch stored in a given file. 848 Public method to apply a patch stored in a given file.
826 </p> 849 </p>
827 <dl> 850 <dl>
828 851
829 <dt><i>repodir</i></dt> 852 <dt><i>repodir</i> (str)</dt>
830 <dd> 853 <dd>
831 directory name of the repository (string) 854 directory name of the repository
832 </dd> 855 </dd>
833 <dt><i>patchFile</i></dt> 856 <dt><i>patchFile</i> (str)</dt>
834 <dd> 857 <dd>
835 name of the patch file (string) 858 name of the patch file
836 </dd> 859 </dd>
837 <dt><i>cached</i></dt> 860 <dt><i>cached</i> (bool)</dt>
838 <dd> 861 <dd>
839 flag indicating to apply the patch to the staging area 862 flag indicating to apply the patch to the staging area
840 (boolean) 863 </dd>
841 </dd> 864 <dt><i>reverse</i> (bool)</dt>
842 <dt><i>reverse</i></dt> 865 <dd>
843 <dd> 866 flag indicating to apply the patch in reverse
844 flag indicating to apply the patch in reverse (boolean) 867 </dd>
845 </dd> 868 <dt><i>noDialog</i> (bool)</dt>
846 <dt><i>noDialog</i></dt> 869 <dd>
847 <dd> 870 flag indicating quiet operations
848 flag indicating quiet operations (boolean)
849 </dd> 871 </dd>
850 </dl> 872 </dl>
851 <a NAME="Git.gitApplyCheckPatches" ID="Git.gitApplyCheckPatches"></a> 873 <a NAME="Git.gitApplyCheckPatches" ID="Git.gitApplyCheckPatches"></a>
852 <h4>Git.gitApplyCheckPatches</h4> 874 <h4>Git.gitApplyCheckPatches</h4>
853 <b>gitApplyCheckPatches</b>(<i>projectDir, check=False</i>) 875 <b>gitApplyCheckPatches</b>(<i>projectDir, check=False</i>)
856 Public method to apply a list of patch files or check, if they would 878 Public method to apply a list of patch files or check, if they would
857 apply cleanly. 879 apply cleanly.
858 </p> 880 </p>
859 <dl> 881 <dl>
860 882
861 <dt><i>projectDir</i></dt> 883 <dt><i>projectDir</i> (str)</dt>
862 <dd> 884 <dd>
863 directory name of the project (string) 885 directory name of the project
864 </dd> 886 </dd>
865 <dt><i>check</i></dt> 887 <dt><i>check</i> (bool)</dt>
866 <dd> 888 <dd>
867 flag indicating to perform a check operation (boolean) 889 flag indicating to perform a check operation
868 </dd> 890 </dd>
869 </dl> 891 </dl>
870 <a NAME="Git.gitBisect" ID="Git.gitBisect"></a> 892 <a NAME="Git.gitBisect" ID="Git.gitBisect"></a>
871 <h4>Git.gitBisect</h4> 893 <h4>Git.gitBisect</h4>
872 <b>gitBisect</b>(<i>projectDir, subcommand</i>) 894 <b>gitBisect</b>(<i>projectDir, subcommand</i>)
874 <p> 896 <p>
875 Public method to perform bisect commands. 897 Public method to perform bisect commands.
876 </p> 898 </p>
877 <dl> 899 <dl>
878 900
879 <dt><i>projectDir</i></dt> 901 <dt><i>projectDir</i> (str)</dt>
880 <dd> 902 <dd>
881 name of the project directory (string) 903 name of the project directory
882 </dd> 904 </dd>
883 <dt><i>subcommand</i></dt> 905 <dt><i>subcommand</i> (str)</dt>
884 <dd> 906 <dd>
885 name of the subcommand (string, one of 'start', 907 name of the subcommand (one of 'start',
886 'start_extended', 'good', 'bad', 'skip' or 'reset') 908 'start_extended', 'good', 'bad', 'skip' or 'reset')
887 </dd> 909 </dd>
888 </dl> 910 </dl>
889 <dl> 911 <dl>
890 <dt>Return:</dt> 912 <dt>Return:</dt>
891 <dd> 913 <dd>
892 flag indicating, that the update contained an add 914 flag indicating, that the update contained an add or delete
893 or delete (boolean) 915 </dd>
916 </dl>
917 <dl>
918 <dt>Return Type:</dt>
919 <dd>
920 bool
894 </dd> 921 </dd>
895 </dl> 922 </dl>
896 <dl> 923 <dl>
897 924
898 <dt>Raises <b>ValueError</b>:</dt> 925 <dt>Raises <b>ValueError</b>:</dt>
907 <p> 934 <p>
908 Public method used to create a bisect replay file for the project. 935 Public method used to create a bisect replay file for the project.
909 </p> 936 </p>
910 <dl> 937 <dl>
911 938
912 <dt><i>projectDir</i></dt> 939 <dt><i>projectDir</i> (str)</dt>
913 <dd> 940 <dd>
914 name of the project directory (string) 941 name of the project directory
915 </dd> 942 </dd>
916 </dl> 943 </dl>
917 <a NAME="Git.gitBisectEditReplayFile" ID="Git.gitBisectEditReplayFile"></a> 944 <a NAME="Git.gitBisectEditReplayFile" ID="Git.gitBisectEditReplayFile"></a>
918 <h4>Git.gitBisectEditReplayFile</h4> 945 <h4>Git.gitBisectEditReplayFile</h4>
919 <b>gitBisectEditReplayFile</b>(<i>projectDir</i>) 946 <b>gitBisectEditReplayFile</b>(<i>projectDir</i>)
921 <p> 948 <p>
922 Public method used to edit a bisect replay file. 949 Public method used to edit a bisect replay file.
923 </p> 950 </p>
924 <dl> 951 <dl>
925 952
926 <dt><i>projectDir</i></dt> 953 <dt><i>projectDir</i> (str)</dt>
927 <dd> 954 <dd>
928 name of the project directory (string) 955 name of the project directory
929 </dd> 956 </dd>
930 </dl> 957 </dl>
931 <a NAME="Git.gitBisectLogBrowser" ID="Git.gitBisectLogBrowser"></a> 958 <a NAME="Git.gitBisectLogBrowser" ID="Git.gitBisectLogBrowser"></a>
932 <h4>Git.gitBisectLogBrowser</h4> 959 <h4>Git.gitBisectLogBrowser</h4>
933 <b>gitBisectLogBrowser</b>(<i>projectDir</i>) 960 <b>gitBisectLogBrowser</b>(<i>projectDir</i>)
935 <p> 962 <p>
936 Public method used to browse the bisect log of the project. 963 Public method used to browse the bisect log of the project.
937 </p> 964 </p>
938 <dl> 965 <dl>
939 966
940 <dt><i>projectDir</i></dt> 967 <dt><i>projectDir</i> (str)</dt>
941 <dd> 968 <dd>
942 name of the project directory (string) 969 name of the project directory
943 </dd> 970 </dd>
944 </dl> 971 </dl>
945 <a NAME="Git.gitBisectReplay" ID="Git.gitBisectReplay"></a> 972 <a NAME="Git.gitBisectReplay" ID="Git.gitBisectReplay"></a>
946 <h4>Git.gitBisectReplay</h4> 973 <h4>Git.gitBisectReplay</h4>
947 <b>gitBisectReplay</b>(<i>projectDir</i>) 974 <b>gitBisectReplay</b>(<i>projectDir</i>)
949 <p> 976 <p>
950 Public method to replay a bisect session. 977 Public method to replay a bisect session.
951 </p> 978 </p>
952 <dl> 979 <dl>
953 980
954 <dt><i>projectDir</i></dt> 981 <dt><i>projectDir</i> (str)</dt>
955 <dd> 982 <dd>
956 name of the project directory (string) 983 name of the project directory
957 </dd> 984 </dd>
958 </dl> 985 </dl>
959 <dl> 986 <dl>
960 <dt>Return:</dt> 987 <dt>Return:</dt>
961 <dd> 988 <dd>
962 flag indicating, that the update contained an add 989 flag indicating, that the update contained an add or delete
963 or delete (boolean) 990 </dd>
991 </dl>
992 <dl>
993 <dt>Return Type:</dt>
994 <dd>
995 bool
964 </dd> 996 </dd>
965 </dl> 997 </dl>
966 <a NAME="Git.gitBlame" ID="Git.gitBlame"></a> 998 <a NAME="Git.gitBlame" ID="Git.gitBlame"></a>
967 <h4>Git.gitBlame</h4> 999 <h4>Git.gitBlame</h4>
968 <b>gitBlame</b>(<i>name, skiplist=""</i>) 1000 <b>gitBlame</b>(<i>name, skiplist=""</i>)
989 Public method used to create, delete or move a branch in the Git 1021 Public method used to create, delete or move a branch in the Git
990 repository. 1022 repository.
991 </p> 1023 </p>
992 <dl> 1024 <dl>
993 1025
994 <dt><i>name</i></dt> 1026 <dt><i>name</i> (str)</dt>
995 <dd> 1027 <dd>
996 file/directory name to be branched (string) 1028 file/directory name to be branched
997 </dd> 1029 </dd>
998 <dt><i>revision</i></dt> 1030 <dt><i>revision</i> (str)</dt>
999 <dd> 1031 <dd>
1000 revision to set tag for (string) 1032 revision to set tag for
1001 </dd> 1033 </dd>
1002 <dt><i>branchName</i></dt> 1034 <dt><i>branchName</i> (str)</dt>
1003 <dd> 1035 <dd>
1004 name of the branch (string) 1036 name of the branch
1005 </dd> 1037 </dd>
1006 <dt><i>branchOp</i></dt> 1038 <dt><i>branchOp</i> (int)</dt>
1007 <dd> 1039 <dd>
1008 desired branch operation (integer) 1040 desired branch operation
1009 </dd> 1041 </dd>
1010 </dl> 1042 </dl>
1011 <dl> 1043 <dl>
1012 <dt>Return:</dt> 1044 <dt>Return:</dt>
1013 <dd> 1045 <dd>
1014 flag indicating a performed branch action (boolean) and 1046 flag indicating a performed branch action and a flag indicating,
1015 a flag indicating, that the branch operation contained an add 1047 that the branch operation contained an add or delete
1016 or delete (boolean) 1048 </dd>
1049 </dl>
1050 <dl>
1051 <dt>Return Type:</dt>
1052 <dd>
1053 tuple of (bool, bool)
1017 </dd> 1054 </dd>
1018 </dl> 1055 </dl>
1019 <a NAME="Git.gitBundle" ID="Git.gitBundle"></a> 1056 <a NAME="Git.gitBundle" ID="Git.gitBundle"></a>
1020 <h4>Git.gitBundle</h4> 1057 <h4>Git.gitBundle</h4>
1021 <b>gitBundle</b>(<i>projectDir</i>) 1058 <b>gitBundle</b>(<i>projectDir</i>)
1023 <p> 1060 <p>
1024 Public method to create a bundle file. 1061 Public method to create a bundle file.
1025 </p> 1062 </p>
1026 <dl> 1063 <dl>
1027 1064
1028 <dt><i>projectDir</i></dt> 1065 <dt><i>projectDir</i> (str)</dt>
1029 <dd> 1066 <dd>
1030 name of the project directory (string) 1067 name of the project directory
1031 </dd> 1068 </dd>
1032 </dl> 1069 </dl>
1033 <a NAME="Git.gitBundleFetch" ID="Git.gitBundleFetch"></a> 1070 <a NAME="Git.gitBundleFetch" ID="Git.gitBundleFetch"></a>
1034 <h4>Git.gitBundleFetch</h4> 1071 <h4>Git.gitBundleFetch</h4>
1035 <b>gitBundleFetch</b>(<i>projectDir</i>) 1072 <b>gitBundleFetch</b>(<i>projectDir</i>)
1038 Public method to fetch a head of a bundle file into the local 1075 Public method to fetch a head of a bundle file into the local
1039 repository. 1076 repository.
1040 </p> 1077 </p>
1041 <dl> 1078 <dl>
1042 1079
1043 <dt><i>projectDir</i></dt> 1080 <dt><i>projectDir</i> (str)</dt>
1044 <dd> 1081 <dd>
1045 name of the project directory (string) 1082 name of the project directory
1046 </dd> 1083 </dd>
1047 </dl> 1084 </dl>
1048 <a NAME="Git.gitBundleListHeads" ID="Git.gitBundleListHeads"></a> 1085 <a NAME="Git.gitBundleListHeads" ID="Git.gitBundleListHeads"></a>
1049 <h4>Git.gitBundleListHeads</h4> 1086 <h4>Git.gitBundleListHeads</h4>
1050 <b>gitBundleListHeads</b>(<i>projectDir</i>) 1087 <b>gitBundleListHeads</b>(<i>projectDir</i>)
1052 <p> 1089 <p>
1053 Public method to list the heads contained in a bundle file. 1090 Public method to list the heads contained in a bundle file.
1054 </p> 1091 </p>
1055 <dl> 1092 <dl>
1056 1093
1057 <dt><i>projectDir</i></dt> 1094 <dt><i>projectDir</i> (str)</dt>
1058 <dd> 1095 <dd>
1059 name of the project directory (string) 1096 name of the project directory
1060 </dd> 1097 </dd>
1061 </dl> 1098 </dl>
1062 <a NAME="Git.gitBundlePull" ID="Git.gitBundlePull"></a> 1099 <a NAME="Git.gitBundlePull" ID="Git.gitBundlePull"></a>
1063 <h4>Git.gitBundlePull</h4> 1100 <h4>Git.gitBundlePull</h4>
1064 <b>gitBundlePull</b>(<i>projectDir</i>) 1101 <b>gitBundlePull</b>(<i>projectDir</i>)
1067 Public method to pull a head of a bundle file into the local 1104 Public method to pull a head of a bundle file into the local
1068 repository and working area. 1105 repository and working area.
1069 </p> 1106 </p>
1070 <dl> 1107 <dl>
1071 1108
1072 <dt><i>projectDir</i></dt> 1109 <dt><i>projectDir</i> (str)</dt>
1073 <dd> 1110 <dd>
1074 name of the project directory (string) 1111 name of the project directory
1075 </dd> 1112 </dd>
1076 </dl> 1113 </dl>
1077 <dl> 1114 <dl>
1078 <dt>Return:</dt> 1115 <dt>Return:</dt>
1079 <dd> 1116 <dd>
1080 flag indicating, that the update contained an add 1117 flag indicating, that the update contained an add or delete
1081 or delete (boolean) 1118 </dd>
1119 </dl>
1120 <dl>
1121 <dt>Return Type:</dt>
1122 <dd>
1123 bool
1082 </dd> 1124 </dd>
1083 </dl> 1125 </dl>
1084 <a NAME="Git.gitCancelMerge" ID="Git.gitCancelMerge"></a> 1126 <a NAME="Git.gitCancelMerge" ID="Git.gitCancelMerge"></a>
1085 <h4>Git.gitCancelMerge</h4> 1127 <h4>Git.gitCancelMerge</h4>
1086 <b>gitCancelMerge</b>(<i>name</i>) 1128 <b>gitCancelMerge</b>(<i>name</i>)
1088 <p> 1130 <p>
1089 Public method to cancel an uncommitted or failed merge. 1131 Public method to cancel an uncommitted or failed merge.
1090 </p> 1132 </p>
1091 <dl> 1133 <dl>
1092 1134
1093 <dt><i>name</i></dt> 1135 <dt><i>name</i> (str)</dt>
1094 <dd> 1136 <dd>
1095 file/directory name (string) 1137 file/directory name
1096 </dd> 1138 </dd>
1097 </dl> 1139 </dl>
1098 <dl> 1140 <dl>
1099 <dt>Return:</dt> 1141 <dt>Return:</dt>
1100 <dd> 1142 <dd>
1101 flag indicating, that the cancellation contained an add 1143 flag indicating, that the cancellation contained an add or delete
1102 or delete (boolean) 1144 </dd>
1145 </dl>
1146 <dl>
1147 <dt>Return Type:</dt>
1148 <dd>
1149 bool
1103 </dd> 1150 </dd>
1104 </dl> 1151 </dl>
1105 <a NAME="Git.gitChangeRemoteCredentials" ID="Git.gitChangeRemoteCredentials"></a> 1152 <a NAME="Git.gitChangeRemoteCredentials" ID="Git.gitChangeRemoteCredentials"></a>
1106 <h4>Git.gitChangeRemoteCredentials</h4> 1153 <h4>Git.gitChangeRemoteCredentials</h4>
1107 <b>gitChangeRemoteCredentials</b>(<i>projectDir, remoteName, remoteUrl=""</i>) 1154 <b>gitChangeRemoteCredentials</b>(<i>projectDir, remoteName, remoteUrl=""</i>)
1154 Public method to cherry pick commits and apply them to the current 1201 Public method to cherry pick commits and apply them to the current
1155 branch. 1202 branch.
1156 </p> 1203 </p>
1157 <dl> 1204 <dl>
1158 1205
1159 <dt><i>projectDir</i></dt> 1206 <dt><i>projectDir</i> (str)</dt>
1160 <dd> 1207 <dd>
1161 name of the project directory (string) 1208 name of the project directory
1162 </dd> 1209 </dd>
1163 <dt><i>commits</i></dt> 1210 <dt><i>commits</i> (list of str)</dt>
1164 <dd> 1211 <dd>
1165 list of commits to be applied (list of strings) 1212 list of commits to be applied
1166 </dd> 1213 </dd>
1167 </dl> 1214 </dl>
1168 <dl> 1215 <dl>
1169 <dt>Return:</dt> 1216 <dt>Return:</dt>
1170 <dd> 1217 <dd>
1171 flag indicating that the project should be reread (boolean) 1218 flag indicating that the project should be reread
1219 </dd>
1220 </dl>
1221 <dl>
1222 <dt>Return Type:</dt>
1223 <dd>
1224 bool
1172 </dd> 1225 </dd>
1173 </dl> 1226 </dl>
1174 <a NAME="Git.gitCherryPickAbort" ID="Git.gitCherryPickAbort"></a> 1227 <a NAME="Git.gitCherryPickAbort" ID="Git.gitCherryPickAbort"></a>
1175 <h4>Git.gitCherryPickAbort</h4> 1228 <h4>Git.gitCherryPickAbort</h4>
1176 <b>gitCherryPickAbort</b>(<i>projectDir</i>) 1229 <b>gitCherryPickAbort</b>(<i>projectDir</i>)
1179 Public method to cancel the last copying session and return to 1232 Public method to cancel the last copying session and return to
1180 the previous state. 1233 the previous state.
1181 </p> 1234 </p>
1182 <dl> 1235 <dl>
1183 1236
1184 <dt><i>projectDir</i></dt> 1237 <dt><i>projectDir</i> (str)</dt>
1185 <dd> 1238 <dd>
1186 name of the project directory (string) 1239 name of the project directory
1187 </dd> 1240 </dd>
1188 </dl> 1241 </dl>
1189 <dl> 1242 <dl>
1190 <dt>Return:</dt> 1243 <dt>Return:</dt>
1191 <dd> 1244 <dd>
1192 flag indicating that the project should be reread (boolean) 1245 flag indicating that the project should be reread
1246 </dd>
1247 </dl>
1248 <dl>
1249 <dt>Return Type:</dt>
1250 <dd>
1251 bool
1193 </dd> 1252 </dd>
1194 </dl> 1253 </dl>
1195 <a NAME="Git.gitCherryPickContinue" ID="Git.gitCherryPickContinue"></a> 1254 <a NAME="Git.gitCherryPickContinue" ID="Git.gitCherryPickContinue"></a>
1196 <h4>Git.gitCherryPickContinue</h4> 1255 <h4>Git.gitCherryPickContinue</h4>
1197 <b>gitCherryPickContinue</b>(<i>projectDir</i>) 1256 <b>gitCherryPickContinue</b>(<i>projectDir</i>)
1200 Public method to continue the last copying session after conflicts 1259 Public method to continue the last copying session after conflicts
1201 were resolved. 1260 were resolved.
1202 </p> 1261 </p>
1203 <dl> 1262 <dl>
1204 1263
1205 <dt><i>projectDir</i></dt> 1264 <dt><i>projectDir</i> (str)</dt>
1206 <dd> 1265 <dd>
1207 name of the project directory (string) 1266 name of the project directory
1208 </dd> 1267 </dd>
1209 </dl> 1268 </dl>
1210 <dl> 1269 <dl>
1211 <dt>Return:</dt> 1270 <dt>Return:</dt>
1212 <dd> 1271 <dd>
1213 flag indicating that the project should be reread (boolean) 1272 flag indicating that the project should be reread
1273 </dd>
1274 </dl>
1275 <dl>
1276 <dt>Return Type:</dt>
1277 <dd>
1278 bool
1214 </dd> 1279 </dd>
1215 </dl> 1280 </dl>
1216 <a NAME="Git.gitCherryPickQuit" ID="Git.gitCherryPickQuit"></a> 1281 <a NAME="Git.gitCherryPickQuit" ID="Git.gitCherryPickQuit"></a>
1217 <h4>Git.gitCherryPickQuit</h4> 1282 <h4>Git.gitCherryPickQuit</h4>
1218 <b>gitCherryPickQuit</b>(<i>projectDir</i>) 1283 <b>gitCherryPickQuit</b>(<i>projectDir</i>)
1220 <p> 1285 <p>
1221 Public method to quit the current copying operation. 1286 Public method to quit the current copying operation.
1222 </p> 1287 </p>
1223 <dl> 1288 <dl>
1224 1289
1225 <dt><i>projectDir</i></dt> 1290 <dt><i>projectDir</i> (str)</dt>
1226 <dd> 1291 <dd>
1227 name of the project directory (string) 1292 name of the project directory
1228 </dd> 1293 </dd>
1229 </dl> 1294 </dl>
1230 <dl> 1295 <dl>
1231 <dt>Return:</dt> 1296 <dt>Return:</dt>
1232 <dd> 1297 <dd>
1233 flag indicating that the project should be reread (boolean) 1298 flag indicating that the project should be reread
1299 </dd>
1300 </dl>
1301 <dl>
1302 <dt>Return Type:</dt>
1303 <dd>
1304 bool
1234 </dd> 1305 </dd>
1235 </dl> 1306 </dl>
1236 <a NAME="Git.gitCommitMerge" ID="Git.gitCommitMerge"></a> 1307 <a NAME="Git.gitCommitMerge" ID="Git.gitCommitMerge"></a>
1237 <h4>Git.gitCommitMerge</h4> 1308 <h4>Git.gitCommitMerge</h4>
1238 <b>gitCommitMerge</b>(<i>name</i>) 1309 <b>gitCommitMerge</b>(<i>name</i>)
1240 <p> 1311 <p>
1241 Public method to commit a failed merge. 1312 Public method to commit a failed merge.
1242 </p> 1313 </p>
1243 <dl> 1314 <dl>
1244 1315
1245 <dt><i>name</i></dt> 1316 <dt><i>name</i> (str)</dt>
1246 <dd> 1317 <dd>
1247 file/directory name (string) 1318 file/directory name
1248 </dd> 1319 </dd>
1249 </dl> 1320 </dl>
1250 <a NAME="Git.gitCopy" ID="Git.gitCopy"></a> 1321 <a NAME="Git.gitCopy" ID="Git.gitCopy"></a>
1251 <h4>Git.gitCopy</h4> 1322 <h4>Git.gitCopy</h4>
1252 <b>gitCopy</b>(<i>name, project</i>) 1323 <b>gitCopy</b>(<i>name, project</i>)
1254 <p> 1325 <p>
1255 Public method used to copy a file/directory. 1326 Public method used to copy a file/directory.
1256 </p> 1327 </p>
1257 <dl> 1328 <dl>
1258 1329
1259 <dt><i>name</i></dt> 1330 <dt><i>name</i> (str)</dt>
1260 <dd> 1331 <dd>
1261 file/directory name to be copied (string) 1332 file/directory name to be copied
1262 </dd> 1333 </dd>
1263 <dt><i>project</i></dt> 1334 <dt><i>project</i> (Project)</dt>
1264 <dd> 1335 <dd>
1265 reference to the project object 1336 reference to the project object
1266 </dd> 1337 </dd>
1267 </dl> 1338 </dl>
1268 <dl> 1339 <dl>
1269 <dt>Return:</dt> 1340 <dt>Return:</dt>
1270 <dd> 1341 <dd>
1271 flag indicating successful operation (boolean) 1342 flag indicating successful operation
1343 </dd>
1344 </dl>
1345 <dl>
1346 <dt>Return Type:</dt>
1347 <dd>
1348 bool
1272 </dd> 1349 </dd>
1273 </dl> 1350 </dl>
1274 <a NAME="Git.gitCreateArchive" ID="Git.gitCreateArchive"></a> 1351 <a NAME="Git.gitCreateArchive" ID="Git.gitCreateArchive"></a>
1275 <h4>Git.gitCreateArchive</h4> 1352 <h4>Git.gitCreateArchive</h4>
1276 <b>gitCreateArchive</b>(<i>projectDir</i>) 1353 <b>gitCreateArchive</b>(<i>projectDir</i>)
1278 <p> 1355 <p>
1279 Public method to show some statistics of the local repository. 1356 Public method to show some statistics of the local repository.
1280 </p> 1357 </p>
1281 <dl> 1358 <dl>
1282 1359
1283 <dt><i>projectDir</i></dt> 1360 <dt><i>projectDir</i> (str)</dt>
1284 <dd> 1361 <dd>
1285 name of the project directory (string) 1362 name of the project directory
1286 </dd> 1363 </dd>
1287 </dl> 1364 </dl>
1288 <a NAME="Git.gitCreateIgnoreFile" ID="Git.gitCreateIgnoreFile"></a> 1365 <a NAME="Git.gitCreateIgnoreFile" ID="Git.gitCreateIgnoreFile"></a>
1289 <h4>Git.gitCreateIgnoreFile</h4> 1366 <h4>Git.gitCreateIgnoreFile</h4>
1290 <b>gitCreateIgnoreFile</b>(<i>name, autoAdd=False</i>) 1367 <b>gitCreateIgnoreFile</b>(<i>name, autoAdd=False</i>)
1292 <p> 1369 <p>
1293 Public method to create the ignore file. 1370 Public method to create the ignore file.
1294 </p> 1371 </p>
1295 <dl> 1372 <dl>
1296 1373
1297 <dt><i>name</i></dt> 1374 <dt><i>name</i> (str)</dt>
1298 <dd> 1375 <dd>
1299 directory name to create the ignore file in (string) 1376 directory name to create the ignore file in
1300 </dd> 1377 </dd>
1301 <dt><i>autoAdd</i></dt> 1378 <dt><i>autoAdd</i> (bool)</dt>
1302 <dd> 1379 <dd>
1303 flag indicating to add it automatically (boolean) 1380 flag indicating to add it automatically
1304 </dd> 1381 </dd>
1305 </dl> 1382 </dl>
1306 <dl> 1383 <dl>
1307 <dt>Return:</dt> 1384 <dt>Return:</dt>
1308 <dd> 1385 <dd>
1309 flag indicating success 1386 flag indicating success
1387 </dd>
1388 </dl>
1389 <dl>
1390 <dt>Return Type:</dt>
1391 <dd>
1392 bool
1310 </dd> 1393 </dd>
1311 </dl> 1394 </dl>
1312 <a NAME="Git.gitDeleteRemoteBranch" ID="Git.gitDeleteRemoteBranch"></a> 1395 <a NAME="Git.gitDeleteRemoteBranch" ID="Git.gitDeleteRemoteBranch"></a>
1313 <h4>Git.gitDeleteRemoteBranch</h4> 1396 <h4>Git.gitDeleteRemoteBranch</h4>
1314 <b>gitDeleteRemoteBranch</b>(<i>name</i>) 1397 <b>gitDeleteRemoteBranch</b>(<i>name</i>)
1316 <p> 1399 <p>
1317 Public method to delete a branch from a remote repository. 1400 Public method to delete a branch from a remote repository.
1318 </p> 1401 </p>
1319 <dl> 1402 <dl>
1320 1403
1321 <dt><i>name</i></dt> 1404 <dt><i>name</i> (str)</dt>
1322 <dd> 1405 <dd>
1323 file/directory name (string) 1406 file/directory name
1324 </dd> 1407 </dd>
1325 </dl> 1408 </dl>
1326 <a NAME="Git.gitDescribe" ID="Git.gitDescribe"></a> 1409 <a NAME="Git.gitDescribe" ID="Git.gitDescribe"></a>
1327 <h4>Git.gitDescribe</h4> 1410 <h4>Git.gitDescribe</h4>
1328 <b>gitDescribe</b>(<i>projectDir, commits</i>) 1411 <b>gitDescribe</b>(<i>projectDir, commits</i>)
1330 <p> 1413 <p>
1331 Public method to find the most recent tag reachable from each commit. 1414 Public method to find the most recent tag reachable from each commit.
1332 </p> 1415 </p>
1333 <dl> 1416 <dl>
1334 1417
1335 <dt><i>projectDir</i></dt> 1418 <dt><i>projectDir</i> (str)</dt>
1336 <dd> 1419 <dd>
1337 name of the project directory (string) 1420 name of the project directory
1338 </dd> 1421 </dd>
1339 <dt><i>commits</i></dt> 1422 <dt><i>commits</i> (list of str)</dt>
1340 <dd> 1423 <dd>
1341 list of commits to start the search from 1424 list of commits to start the search from
1342 (list of strings)
1343 </dd> 1425 </dd>
1344 </dl> 1426 </dl>
1345 <a NAME="Git.gitEditConfig" ID="Git.gitEditConfig"></a> 1427 <a NAME="Git.gitEditConfig" ID="Git.gitEditConfig"></a>
1346 <h4>Git.gitEditConfig</h4> 1428 <h4>Git.gitEditConfig</h4>
1347 <b>gitEditConfig</b>(<i>projectDir</i>) 1429 <b>gitEditConfig</b>(<i>projectDir</i>)
1349 <p> 1431 <p>
1350 Public method used to edit the repository configuration file. 1432 Public method used to edit the repository configuration file.
1351 </p> 1433 </p>
1352 <dl> 1434 <dl>
1353 1435
1354 <dt><i>projectDir</i></dt> 1436 <dt><i>projectDir</i> (str)</dt>
1355 <dd> 1437 <dd>
1356 name of the project directory (string) 1438 name of the project directory
1357 </dd> 1439 </dd>
1358 </dl> 1440 </dl>
1359 <a NAME="Git.gitEditUserConfig" ID="Git.gitEditUserConfig"></a> 1441 <a NAME="Git.gitEditUserConfig" ID="Git.gitEditUserConfig"></a>
1360 <h4>Git.gitEditUserConfig</h4> 1442 <h4>Git.gitEditUserConfig</h4>
1361 <b>gitEditUserConfig</b>(<i></i>) 1443 <b>gitEditUserConfig</b>(<i></i>)
1380 <p> 1462 <p>
1381 This method gives the chance to enter the revisions to be compared. 1463 This method gives the chance to enter the revisions to be compared.
1382 </p> 1464 </p>
1383 <dl> 1465 <dl>
1384 1466
1385 <dt><i>name</i></dt> 1467 <dt><i>name</i> (str)</dt>
1386 <dd> 1468 <dd>
1387 file/directory name to be diffed (string) 1469 file/directory name to be diffed
1388 </dd> 1470 </dd>
1389 </dl> 1471 </dl>
1390 <a NAME="Git.gitFetch" ID="Git.gitFetch"></a> 1472 <a NAME="Git.gitFetch" ID="Git.gitFetch"></a>
1391 <h4>Git.gitFetch</h4> 1473 <h4>Git.gitFetch</h4>
1392 <b>gitFetch</b>(<i>name</i>) 1474 <b>gitFetch</b>(<i>name</i>)
1394 <p> 1476 <p>
1395 Public method to fetch changes from a remote repository. 1477 Public method to fetch changes from a remote repository.
1396 </p> 1478 </p>
1397 <dl> 1479 <dl>
1398 1480
1399 <dt><i>name</i></dt> 1481 <dt><i>name</i> (str)</dt>
1400 <dd> 1482 <dd>
1401 directory name (string) 1483 directory name
1402 </dd> 1484 </dd>
1403 </dl> 1485 </dl>
1404 <a NAME="Git.gitGetArchiveFormats" ID="Git.gitGetArchiveFormats"></a> 1486 <a NAME="Git.gitGetArchiveFormats" ID="Git.gitGetArchiveFormats"></a>
1405 <h4>Git.gitGetArchiveFormats</h4> 1487 <h4>Git.gitGetArchiveFormats</h4>
1406 <b>gitGetArchiveFormats</b>(<i>repodir</i>) 1488 <b>gitGetArchiveFormats</b>(<i>repodir</i>)
1408 <p> 1490 <p>
1409 Public method to get a list of supported archive formats. 1491 Public method to get a list of supported archive formats.
1410 </p> 1492 </p>
1411 <dl> 1493 <dl>
1412 1494
1413 <dt><i>repodir</i></dt> 1495 <dt><i>repodir</i> (str)</dt>
1414 <dd> 1496 <dd>
1415 directory name of the repository (string) 1497 directory name of the repository
1416 </dd> 1498 </dd>
1417 </dl> 1499 </dl>
1418 <dl> 1500 <dl>
1419 <dt>Return:</dt> 1501 <dt>Return:</dt>
1420 <dd> 1502 <dd>
1421 list of supported archive formats (list of strings) 1503 list of supported archive formats
1504 </dd>
1505 </dl>
1506 <dl>
1507 <dt>Return Type:</dt>
1508 <dd>
1509 list of str
1422 </dd> 1510 </dd>
1423 </dl> 1511 </dl>
1424 <a NAME="Git.gitGetBranchesList" ID="Git.gitGetBranchesList"></a> 1512 <a NAME="Git.gitGetBranchesList" ID="Git.gitGetBranchesList"></a>
1425 <h4>Git.gitGetBranchesList</h4> 1513 <h4>Git.gitGetBranchesList</h4>
1426 <b>gitGetBranchesList</b>(<i>repodir, withMain=False, allBranches=False, remotes=False</i>) 1514 <b>gitGetBranchesList</b>(<i>repodir, withMain=False, allBranches=False, remotes=False</i>)
1428 <p> 1516 <p>
1429 Public method to get the list of branches. 1517 Public method to get the list of branches.
1430 </p> 1518 </p>
1431 <dl> 1519 <dl>
1432 1520
1433 <dt><i>repodir</i></dt> 1521 <dt><i>repodir</i> (str)</dt>
1434 <dd> 1522 <dd>
1435 directory name of the repository (string) 1523 directory name of the repository
1436 </dd> 1524 </dd>
1437 <dt><i>withMain</i></dt> 1525 <dt><i>withMain</i> (bool)</dt>
1438 <dd> 1526 <dd>
1439 flag indicating to get 'main' as well (boolean) 1527 flag indicating to get 'main' as well
1440 </dd> 1528 </dd>
1441 <dt><i>allBranches</i></dt> 1529 <dt><i>allBranches</i> (bool)</dt>
1442 <dd> 1530 <dd>
1443 flag indicating to return all branches (boolean) 1531 flag indicating to return all branches
1444 </dd> 1532 </dd>
1445 <dt><i>remotes</i></dt> 1533 <dt><i>remotes</i> (bool)</dt>
1446 <dd> 1534 <dd>
1447 flag indicating to return remote branches only (boolean) 1535 flag indicating to return remote branches only
1448 </dd> 1536 </dd>
1449 </dl> 1537 </dl>
1450 <dl> 1538 <dl>
1451 <dt>Return:</dt> 1539 <dt>Return:</dt>
1452 <dd> 1540 <dd>
1453 list of branches (list of string) 1541 list of branches
1542 </dd>
1543 </dl>
1544 <dl>
1545 <dt>Return Type:</dt>
1546 <dd>
1547 list of str
1454 </dd> 1548 </dd>
1455 </dl> 1549 </dl>
1456 <a NAME="Git.gitGetBundleHeads" ID="Git.gitGetBundleHeads"></a> 1550 <a NAME="Git.gitGetBundleHeads" ID="Git.gitGetBundleHeads"></a>
1457 <h4>Git.gitGetBundleHeads</h4> 1551 <h4>Git.gitGetBundleHeads</h4>
1458 <b>gitGetBundleHeads</b>(<i>repodir, bundleFile</i>) 1552 <b>gitGetBundleHeads</b>(<i>repodir, bundleFile</i>)
1460 <p> 1554 <p>
1461 Public method to get a list of heads contained in a bundle file. 1555 Public method to get a list of heads contained in a bundle file.
1462 </p> 1556 </p>
1463 <dl> 1557 <dl>
1464 1558
1465 <dt><i>repodir</i></dt> 1559 <dt><i>repodir</i> (str)</dt>
1466 <dd> 1560 <dd>
1467 directory name of the repository (string) 1561 directory name of the repository
1468 </dd> 1562 </dd>
1469 <dt><i>bundleFile</i></dt> 1563 <dt><i>bundleFile</i> (str)</dt>
1470 <dd> 1564 <dd>
1471 file name of a git bundle file (string) 1565 file name of a git bundle file
1472 </dd> 1566 </dd>
1473 </dl> 1567 </dl>
1474 <dl> 1568 <dl>
1475 <dt>Return:</dt> 1569 <dt>Return:</dt>
1476 <dd> 1570 <dd>
1477 list of heads (list of strings) 1571 list of heads
1572 </dd>
1573 </dl>
1574 <dl>
1575 <dt>Return Type:</dt>
1576 <dd>
1577 list of str
1478 </dd> 1578 </dd>
1479 </dl> 1579 </dl>
1480 <a NAME="Git.gitGetCurrentBranch" ID="Git.gitGetCurrentBranch"></a> 1580 <a NAME="Git.gitGetCurrentBranch" ID="Git.gitGetCurrentBranch"></a>
1481 <h4>Git.gitGetCurrentBranch</h4> 1581 <h4>Git.gitGetCurrentBranch</h4>
1482 <b>gitGetCurrentBranch</b>(<i>repodir</i>) 1582 <b>gitGetCurrentBranch</b>(<i>repodir</i>)
1484 <p> 1584 <p>
1485 Public method used to show the current branch of the working directory. 1585 Public method used to show the current branch of the working directory.
1486 </p> 1586 </p>
1487 <dl> 1587 <dl>
1488 1588
1489 <dt><i>repodir</i></dt> 1589 <dt><i>repodir</i> (str)</dt>
1490 <dd> 1590 <dd>
1491 directory name of the repository (string) 1591 directory name of the repository
1492 </dd> 1592 </dd>
1493 </dl> 1593 </dl>
1494 <dl> 1594 <dl>
1495 <dt>Return:</dt> 1595 <dt>Return:</dt>
1496 <dd> 1596 <dd>
1497 name of the current branch (string) 1597 name of the current branch
1598 </dd>
1599 </dl>
1600 <dl>
1601 <dt>Return Type:</dt>
1602 <dd>
1603 str
1498 </dd> 1604 </dd>
1499 </dl> 1605 </dl>
1500 <a NAME="Git.gitGetRemoteBranchesList" ID="Git.gitGetRemoteBranchesList"></a> 1606 <a NAME="Git.gitGetRemoteBranchesList" ID="Git.gitGetRemoteBranchesList"></a>
1501 <h4>Git.gitGetRemoteBranchesList</h4> 1607 <h4>Git.gitGetRemoteBranchesList</h4>
1502 <b>gitGetRemoteBranchesList</b>(<i>repodir, remote</i>) 1608 <b>gitGetRemoteBranchesList</b>(<i>repodir, remote</i>)
1504 <p> 1610 <p>
1505 Public method to get the list of a remote repository branches. 1611 Public method to get the list of a remote repository branches.
1506 </p> 1612 </p>
1507 <dl> 1613 <dl>
1508 1614
1509 <dt><i>repodir</i></dt> 1615 <dt><i>repodir</i> (str)</dt>
1510 <dd> 1616 <dd>
1511 directory name of the repository (string) 1617 directory name of the repository
1512 </dd> 1618 </dd>
1513 <dt><i>remote</i></dt> 1619 <dt><i>remote</i> (str)</dt>
1514 <dd> 1620 <dd>
1515 remote repository name (string) 1621 remote repository name
1516 </dd> 1622 </dd>
1517 </dl> 1623 </dl>
1518 <dl> 1624 <dl>
1519 <dt>Return:</dt> 1625 <dt>Return:</dt>
1520 <dd> 1626 <dd>
1521 list of remote repository branches (list of string) 1627 list of remote repository branches
1628 </dd>
1629 </dl>
1630 <dl>
1631 <dt>Return Type:</dt>
1632 <dd>
1633 list of str
1522 </dd> 1634 </dd>
1523 </dl> 1635 </dl>
1524 <a NAME="Git.gitGetRemoteUrl" ID="Git.gitGetRemoteUrl"></a> 1636 <a NAME="Git.gitGetRemoteUrl" ID="Git.gitGetRemoteUrl"></a>
1525 <h4>Git.gitGetRemoteUrl</h4> 1637 <h4>Git.gitGetRemoteUrl</h4>
1526 <b>gitGetRemoteUrl</b>(<i>repodir, remoteName</i>) 1638 <b>gitGetRemoteUrl</b>(<i>repodir, remoteName</i>)
1558 <p> 1670 <p>
1559 Public method to get the list of remote repos and their URLs. 1671 Public method to get the list of remote repos and their URLs.
1560 </p> 1672 </p>
1561 <dl> 1673 <dl>
1562 1674
1563 <dt><i>repodir</i></dt> 1675 <dt><i>repodir</i> (str)</dt>
1564 <dd> 1676 <dd>
1565 directory name of the repository (string) 1677 directory name of the repository
1566 </dd> 1678 </dd>
1567 <dt><i>forFetch</i></dt> 1679 <dt><i>forFetch</i> (str)</dt>
1568 <dd> 1680 <dd>
1569 flag indicating to get Fetch info (string) 1681 flag indicating to get Fetch info
1570 </dd> 1682 </dd>
1571 </dl> 1683 </dl>
1572 <dl> 1684 <dl>
1573 <dt>Return:</dt> 1685 <dt>Return:</dt>
1574 <dd> 1686 <dd>
1575 list of tuples of remote repo name and repo URL (list of 1687 list of tuples of remote repo name and repo URL
1576 tuple of two strings) 1688 </dd>
1689 </dl>
1690 <dl>
1691 <dt>Return Type:</dt>
1692 <dd>
1693 list of [(str, str)]
1577 </dd> 1694 </dd>
1578 </dl> 1695 </dl>
1579 <a NAME="Git.gitGetRemotesList" ID="Git.gitGetRemotesList"></a> 1696 <a NAME="Git.gitGetRemotesList" ID="Git.gitGetRemotesList"></a>
1580 <h4>Git.gitGetRemotesList</h4> 1697 <h4>Git.gitGetRemotesList</h4>
1581 <b>gitGetRemotesList</b>(<i>repodir</i>) 1698 <b>gitGetRemotesList</b>(<i>repodir</i>)
1583 <p> 1700 <p>
1584 Public method to get the list of remote repos. 1701 Public method to get the list of remote repos.
1585 </p> 1702 </p>
1586 <dl> 1703 <dl>
1587 1704
1588 <dt><i>repodir</i></dt> 1705 <dt><i>repodir</i> (str)</dt>
1589 <dd> 1706 <dd>
1590 directory name of the repository (string) 1707 directory name of the repository
1591 </dd> 1708 </dd>
1592 </dl> 1709 </dl>
1593 <dl> 1710 <dl>
1594 <dt>Return:</dt> 1711 <dt>Return:</dt>
1595 <dd> 1712 <dd>
1596 list of remote repos (list of string) 1713 list of remote repos
1714 </dd>
1715 </dl>
1716 <dl>
1717 <dt>Return Type:</dt>
1718 <dd>
1719 list of str
1597 </dd> 1720 </dd>
1598 </dl> 1721 </dl>
1599 <a NAME="Git.gitGetTagsList" ID="Git.gitGetTagsList"></a> 1722 <a NAME="Git.gitGetTagsList" ID="Git.gitGetTagsList"></a>
1600 <h4>Git.gitGetTagsList</h4> 1723 <h4>Git.gitGetTagsList</h4>
1601 <b>gitGetTagsList</b>(<i>repodir</i>) 1724 <b>gitGetTagsList</b>(<i>repodir</i>)
1603 <p> 1726 <p>
1604 Public method to get the list of tags. 1727 Public method to get the list of tags.
1605 </p> 1728 </p>
1606 <dl> 1729 <dl>
1607 1730
1608 <dt><i>repodir</i></dt> 1731 <dt><i>repodir</i> (str)</dt>
1609 <dd> 1732 <dd>
1610 directory name of the repository (string) 1733 directory name of the repository
1611 </dd> 1734 </dd>
1612 </dl> 1735 </dl>
1613 <dl> 1736 <dl>
1614 <dt>Return:</dt> 1737 <dt>Return:</dt>
1615 <dd> 1738 <dd>
1616 list of tags (list of string) or list of tuples of 1739 list of tags or list of tuples of tag name and flag indicating
1617 tag name and flag indicating a local tag (list of tuple of string 1740 a local tag, if withType is True
1618 and boolean), if withType is True 1741 </dd>
1742 </dl>
1743 <dl>
1744 <dt>Return Type:</dt>
1745 <dd>
1746 list of str or list of tuple of (str, bool)
1619 </dd> 1747 </dd>
1620 </dl> 1748 </dl>
1621 <a NAME="Git.gitHouseKeeping" ID="Git.gitHouseKeeping"></a> 1749 <a NAME="Git.gitHouseKeeping" ID="Git.gitHouseKeeping"></a>
1622 <h4>Git.gitHouseKeeping</h4> 1750 <h4>Git.gitHouseKeeping</h4>
1623 <b>gitHouseKeeping</b>(<i>projectDir</i>) 1751 <b>gitHouseKeeping</b>(<i>projectDir</i>)
1625 <p> 1753 <p>
1626 Public method to cleanup and optimize the local repository. 1754 Public method to cleanup and optimize the local repository.
1627 </p> 1755 </p>
1628 <dl> 1756 <dl>
1629 1757
1630 <dt><i>projectDir</i></dt> 1758 <dt><i>projectDir</i> (str)</dt>
1631 <dd> 1759 <dd>
1632 name of the project directory (string) 1760 name of the project directory
1633 </dd> 1761 </dd>
1634 </dl> 1762 </dl>
1635 <a NAME="Git.gitListTagBranch" ID="Git.gitListTagBranch"></a> 1763 <a NAME="Git.gitListTagBranch" ID="Git.gitListTagBranch"></a>
1636 <h4>Git.gitListTagBranch</h4> 1764 <h4>Git.gitListTagBranch</h4>
1637 <b>gitListTagBranch</b>(<i>path, tags=True, listAll=True, merged=True</i>) 1765 <b>gitListTagBranch</b>(<i>path, tags=True, listAll=True, merged=True</i>)
1639 <p> 1767 <p>
1640 Public method used to list the available tags or branches. 1768 Public method used to list the available tags or branches.
1641 </p> 1769 </p>
1642 <dl> 1770 <dl>
1643 1771
1644 <dt><i>path</i></dt> 1772 <dt><i>path</i> (str)</dt>
1645 <dd> 1773 <dd>
1646 directory name of the project (string) 1774 directory name of the project
1647 </dd> 1775 </dd>
1648 <dt><i>tags</i></dt> 1776 <dt><i>tags</i> (bool)</dt>
1649 <dd> 1777 <dd>
1650 flag indicating listing of branches or tags 1778 flag indicating listing of branches or tags
1651 (False = branches, True = tags) 1779 (False = branches, True = tags)
1652 </dd> 1780 </dd>
1653 <dt><i>listAll</i></dt> 1781 <dt><i>listAll</i> (bool)</dt>
1654 <dd> 1782 <dd>
1655 flag indicating to show all tags or branches (boolean) 1783 flag indicating to show all tags or branches
1656 </dd> 1784 </dd>
1657 <dt><i>merged</i></dt> 1785 <dt><i>merged</i> (bool)</dt>
1658 <dd> 1786 <dd>
1659 flag indicating to show only merged or non-merged 1787 flag indicating to show only merged or non-merged branches
1660 branches (boolean)
1661 </dd> 1788 </dd>
1662 </dl> 1789 </dl>
1663 <a NAME="Git.gitNormalizeURL" ID="Git.gitNormalizeURL"></a> 1790 <a NAME="Git.gitNormalizeURL" ID="Git.gitNormalizeURL"></a>
1664 <h4>Git.gitNormalizeURL</h4> 1791 <h4>Git.gitNormalizeURL</h4>
1665 <b>gitNormalizeURL</b>(<i>url</i>) 1792 <b>gitNormalizeURL</b>(<i>url</i>)
1667 <p> 1794 <p>
1668 Public method to normalize a url for Git. 1795 Public method to normalize a url for Git.
1669 </p> 1796 </p>
1670 <dl> 1797 <dl>
1671 1798
1672 <dt><i>url</i></dt> 1799 <dt><i>url</i> (str)</dt>
1673 <dd> 1800 <dd>
1674 url string (string) 1801 url string
1675 </dd> 1802 </dd>
1676 </dl> 1803 </dl>
1677 <dl> 1804 <dl>
1678 <dt>Return:</dt> 1805 <dt>Return:</dt>
1679 <dd> 1806 <dd>
1680 properly normalized url for git (string) 1807 properly normalized url for git
1808 </dd>
1809 </dl>
1810 <dl>
1811 <dt>Return Type:</dt>
1812 <dd>
1813 str
1681 </dd> 1814 </dd>
1682 </dl> 1815 </dl>
1683 <a NAME="Git.gitPruneRemote" ID="Git.gitPruneRemote"></a> 1816 <a NAME="Git.gitPruneRemote" ID="Git.gitPruneRemote"></a>
1684 <h4>Git.gitPruneRemote</h4> 1817 <h4>Git.gitPruneRemote</h4>
1685 <b>gitPruneRemote</b>(<i>projectDir, remoteName</i>) 1818 <b>gitPruneRemote</b>(<i>projectDir, remoteName</i>)
1687 <p> 1820 <p>
1688 Public method to prune stale remote-tracking branches. 1821 Public method to prune stale remote-tracking branches.
1689 </p> 1822 </p>
1690 <dl> 1823 <dl>
1691 1824
1692 <dt><i>projectDir</i></dt> 1825 <dt><i>projectDir</i> (str)</dt>
1693 <dd> 1826 <dd>
1694 name of the project directory (string) 1827 name of the project directory
1695 </dd> 1828 </dd>
1696 <dt><i>remoteName</i></dt> 1829 <dt><i>remoteName</i> (str)</dt>
1697 <dd> 1830 <dd>
1698 name of the remote repository (string) 1831 name of the remote repository
1699 </dd> 1832 </dd>
1700 </dl> 1833 </dl>
1701 <a NAME="Git.gitPull" ID="Git.gitPull"></a> 1834 <a NAME="Git.gitPull" ID="Git.gitPull"></a>
1702 <h4>Git.gitPull</h4> 1835 <h4>Git.gitPull</h4>
1703 <b>gitPull</b>(<i>name</i>) 1836 <b>gitPull</b>(<i>name</i>)
1705 <p> 1838 <p>
1706 Public method used to pull changes from a remote Git repository. 1839 Public method used to pull changes from a remote Git repository.
1707 </p> 1840 </p>
1708 <dl> 1841 <dl>
1709 1842
1710 <dt><i>name</i></dt> 1843 <dt><i>name</i> (str)</dt>
1711 <dd> 1844 <dd>
1712 directory name of the project to be pulled to (string) 1845 directory name of the project to be pulled to
1713 </dd> 1846 </dd>
1714 </dl> 1847 </dl>
1715 <dl> 1848 <dl>
1716 <dt>Return:</dt> 1849 <dt>Return:</dt>
1717 <dd> 1850 <dd>
1718 flag indicating, that the update contained an add 1851 flag indicating, that the update contained an add or delete
1719 or delete (boolean) 1852 </dd>
1853 </dl>
1854 <dl>
1855 <dt>Return Type:</dt>
1856 <dd>
1857 bool
1720 </dd> 1858 </dd>
1721 </dl> 1859 </dl>
1722 <a NAME="Git.gitPush" ID="Git.gitPush"></a> 1860 <a NAME="Git.gitPush" ID="Git.gitPush"></a>
1723 <h4>Git.gitPush</h4> 1861 <h4>Git.gitPush</h4>
1724 <b>gitPush</b>(<i>name</i>) 1862 <b>gitPush</b>(<i>name</i>)
1726 <p> 1864 <p>
1727 Public method used to push changes to a remote Git repository. 1865 Public method used to push changes to a remote Git repository.
1728 </p> 1866 </p>
1729 <dl> 1867 <dl>
1730 1868
1731 <dt><i>name</i></dt> 1869 <dt><i>name</i> (str)</dt>
1732 <dd> 1870 <dd>
1733 directory name of the project to be pushed from (string) 1871 directory name of the project to be pushed from
1734 </dd> 1872 </dd>
1735 </dl> 1873 </dl>
1736 <a NAME="Git.gitReflogBrowser" ID="Git.gitReflogBrowser"></a> 1874 <a NAME="Git.gitReflogBrowser" ID="Git.gitReflogBrowser"></a>
1737 <h4>Git.gitReflogBrowser</h4> 1875 <h4>Git.gitReflogBrowser</h4>
1738 <b>gitReflogBrowser</b>(<i>projectDir</i>) 1876 <b>gitReflogBrowser</b>(<i>projectDir</i>)
1740 <p> 1878 <p>
1741 Public method used to browse the reflog of the project. 1879 Public method used to browse the reflog of the project.
1742 </p> 1880 </p>
1743 <dl> 1881 <dl>
1744 1882
1745 <dt><i>projectDir</i></dt> 1883 <dt><i>projectDir</i> (str)</dt>
1746 <dd> 1884 <dd>
1747 name of the project directory (string) 1885 name of the project directory
1748 </dd> 1886 </dd>
1749 </dl> 1887 </dl>
1750 <a NAME="Git.gitRemoveRemote" ID="Git.gitRemoveRemote"></a> 1888 <a NAME="Git.gitRemoveRemote" ID="Git.gitRemoveRemote"></a>
1751 <h4>Git.gitRemoveRemote</h4> 1889 <h4>Git.gitRemoveRemote</h4>
1752 <b>gitRemoveRemote</b>(<i>projectDir, remoteName</i>) 1890 <b>gitRemoveRemote</b>(<i>projectDir, remoteName</i>)
1754 <p> 1892 <p>
1755 Public method to remove a remote repository. 1893 Public method to remove a remote repository.
1756 </p> 1894 </p>
1757 <dl> 1895 <dl>
1758 1896
1759 <dt><i>projectDir</i></dt> 1897 <dt><i>projectDir</i> (str)</dt>
1760 <dd> 1898 <dd>
1761 name of the project directory (string) 1899 name of the project directory
1762 </dd> 1900 </dd>
1763 <dt><i>remoteName</i></dt> 1901 <dt><i>remoteName</i> (str)</dt>
1764 <dd> 1902 <dd>
1765 name of the remote repository (string) 1903 name of the remote repository
1766 </dd> 1904 </dd>
1767 </dl> 1905 </dl>
1768 <a NAME="Git.gitRenameRemote" ID="Git.gitRenameRemote"></a> 1906 <a NAME="Git.gitRenameRemote" ID="Git.gitRenameRemote"></a>
1769 <h4>Git.gitRenameRemote</h4> 1907 <h4>Git.gitRenameRemote</h4>
1770 <b>gitRenameRemote</b>(<i>projectDir, remoteName</i>) 1908 <b>gitRenameRemote</b>(<i>projectDir, remoteName</i>)
1772 <p> 1910 <p>
1773 Public method to rename a remote repository. 1911 Public method to rename a remote repository.
1774 </p> 1912 </p>
1775 <dl> 1913 <dl>
1776 1914
1777 <dt><i>projectDir</i></dt> 1915 <dt><i>projectDir</i> (str)</dt>
1778 <dd> 1916 <dd>
1779 name of the project directory (string) 1917 name of the project directory
1780 </dd> 1918 </dd>
1781 <dt><i>remoteName</i></dt> 1919 <dt><i>remoteName</i> (str)</dt>
1782 <dd> 1920 <dd>
1783 name of the remote repository (string) 1921 name of the remote repository
1784 </dd> 1922 </dd>
1785 </dl> 1923 </dl>
1786 <a NAME="Git.gitShortlog" ID="Git.gitShortlog"></a> 1924 <a NAME="Git.gitShortlog" ID="Git.gitShortlog"></a>
1787 <h4>Git.gitShortlog</h4> 1925 <h4>Git.gitShortlog</h4>
1788 <b>gitShortlog</b>(<i>projectDir, commit</i>) 1926 <b>gitShortlog</b>(<i>projectDir, commit</i>)
1791 Public method to show a short log suitable for inclusion in release 1929 Public method to show a short log suitable for inclusion in release
1792 announcements. 1930 announcements.
1793 </p> 1931 </p>
1794 <dl> 1932 <dl>
1795 1933
1796 <dt><i>projectDir</i></dt> 1934 <dt><i>projectDir</i> (str)</dt>
1797 <dd> 1935 <dd>
1798 name of the project directory (string) 1936 name of the project directory
1799 </dd> 1937 </dd>
1800 <dt><i>commit</i></dt> 1938 <dt><i>commit</i> (str)</dt>
1801 <dd> 1939 <dd>
1802 commit to start the log at (strings) 1940 commit to start the log at
1803 </dd> 1941 </dd>
1804 </dl> 1942 </dl>
1805 <a NAME="Git.gitShowBranch" ID="Git.gitShowBranch"></a> 1943 <a NAME="Git.gitShowBranch" ID="Git.gitShowBranch"></a>
1806 <h4>Git.gitShowBranch</h4> 1944 <h4>Git.gitShowBranch</h4>
1807 <b>gitShowBranch</b>(<i>name</i>) 1945 <b>gitShowBranch</b>(<i>name</i>)
1809 <p> 1947 <p>
1810 Public method used to show the current branch of the working directory. 1948 Public method used to show the current branch of the working directory.
1811 </p> 1949 </p>
1812 <dl> 1950 <dl>
1813 1951
1814 <dt><i>name</i></dt> 1952 <dt><i>name</i> (str)</dt>
1815 <dd> 1953 <dd>
1816 file/directory name (string) 1954 file/directory name
1817 </dd> 1955 </dd>
1818 </dl> 1956 </dl>
1819 <a NAME="Git.gitShowConfig" ID="Git.gitShowConfig"></a> 1957 <a NAME="Git.gitShowConfig" ID="Git.gitShowConfig"></a>
1820 <h4>Git.gitShowConfig</h4> 1958 <h4>Git.gitShowConfig</h4>
1821 <b>gitShowConfig</b>(<i>projectDir</i>) 1959 <b>gitShowConfig</b>(<i>projectDir</i>)
1823 <p> 1961 <p>
1824 Public method to show the combined configuration. 1962 Public method to show the combined configuration.
1825 </p> 1963 </p>
1826 <dl> 1964 <dl>
1827 1965
1828 <dt><i>projectDir</i></dt> 1966 <dt><i>projectDir</i> (str)</dt>
1829 <dd> 1967 <dd>
1830 name of the project directory (string) 1968 name of the project directory
1831 </dd> 1969 </dd>
1832 </dl> 1970 </dl>
1833 <a NAME="Git.gitShowPatchesStatistics" ID="Git.gitShowPatchesStatistics"></a> 1971 <a NAME="Git.gitShowPatchesStatistics" ID="Git.gitShowPatchesStatistics"></a>
1834 <h4>Git.gitShowPatchesStatistics</h4> 1972 <h4>Git.gitShowPatchesStatistics</h4>
1835 <b>gitShowPatchesStatistics</b>(<i>projectDir</i>) 1973 <b>gitShowPatchesStatistics</b>(<i>projectDir</i>)
1837 <p> 1975 <p>
1838 Public method to show statistics for a set of patch files. 1976 Public method to show statistics for a set of patch files.
1839 </p> 1977 </p>
1840 <dl> 1978 <dl>
1841 1979
1842 <dt><i>projectDir</i></dt> 1980 <dt><i>projectDir</i> (str)</dt>
1843 <dd> 1981 <dd>
1844 directory name of the project (string) 1982 directory name of the project
1845 </dd> 1983 </dd>
1846 </dl> 1984 </dl>
1847 <a NAME="Git.gitShowRemote" ID="Git.gitShowRemote"></a> 1985 <a NAME="Git.gitShowRemote" ID="Git.gitShowRemote"></a>
1848 <h4>Git.gitShowRemote</h4> 1986 <h4>Git.gitShowRemote</h4>
1849 <b>gitShowRemote</b>(<i>projectDir, remoteName</i>) 1987 <b>gitShowRemote</b>(<i>projectDir, remoteName</i>)
1851 <p> 1989 <p>
1852 Public method to show information about a remote repository. 1990 Public method to show information about a remote repository.
1853 </p> 1991 </p>
1854 <dl> 1992 <dl>
1855 1993
1856 <dt><i>projectDir</i></dt> 1994 <dt><i>projectDir</i> (str)</dt>
1857 <dd> 1995 <dd>
1858 name of the project directory (string) 1996 name of the project directory
1859 </dd> 1997 </dd>
1860 <dt><i>remoteName</i></dt> 1998 <dt><i>remoteName</i> (str)</dt>
1861 <dd> 1999 <dd>
1862 name of the remote repository (string) 2000 name of the remote repository
1863 </dd> 2001 </dd>
1864 </dl> 2002 </dl>
1865 <a NAME="Git.gitShowRemotes" ID="Git.gitShowRemotes"></a> 2003 <a NAME="Git.gitShowRemotes" ID="Git.gitShowRemotes"></a>
1866 <h4>Git.gitShowRemotes</h4> 2004 <h4>Git.gitShowRemotes</h4>
1867 <b>gitShowRemotes</b>(<i>projectDir</i>) 2005 <b>gitShowRemotes</b>(<i>projectDir</i>)
1869 <p> 2007 <p>
1870 Public method to show available remote repositories. 2008 Public method to show available remote repositories.
1871 </p> 2009 </p>
1872 <dl> 2010 <dl>
1873 2011
1874 <dt><i>projectDir</i></dt> 2012 <dt><i>projectDir</i> (str)</dt>
1875 <dd> 2013 <dd>
1876 name of the project directory (string) 2014 name of the project directory
1877 </dd> 2015 </dd>
1878 </dl> 2016 </dl>
1879 <a NAME="Git.gitStashApply" ID="Git.gitStashApply"></a> 2017 <a NAME="Git.gitStashApply" ID="Git.gitStashApply"></a>
1880 <h4>Git.gitStashApply</h4> 2018 <h4>Git.gitStashApply</h4>
1881 <b>gitStashApply</b>(<i>projectDir, stashName=""</i>) 2019 <b>gitStashApply</b>(<i>projectDir, stashName=""</i>)
1883 <p> 2021 <p>
1884 Public method to apply a stash but keep it. 2022 Public method to apply a stash but keep it.
1885 </p> 2023 </p>
1886 <dl> 2024 <dl>
1887 2025
1888 <dt><i>projectDir</i></dt> 2026 <dt><i>projectDir</i> (str)</dt>
1889 <dd> 2027 <dd>
1890 name of the project directory (string) 2028 name of the project directory
1891 </dd> 2029 </dd>
1892 <dt><i>stashName</i></dt> 2030 <dt><i>stashName</i> (str)</dt>
1893 <dd> 2031 <dd>
1894 name of a stash (string) 2032 name of a stash
1895 </dd> 2033 </dd>
1896 </dl> 2034 </dl>
1897 <dl> 2035 <dl>
1898 <dt>Return:</dt> 2036 <dt>Return:</dt>
1899 <dd> 2037 <dd>
1900 flag indicating, that the restore contained an add 2038 flag indicating, that the restore contained an add or delete
1901 or delete (boolean) 2039 </dd>
2040 </dl>
2041 <dl>
2042 <dt>Return Type:</dt>
2043 <dd>
2044 bool
1902 </dd> 2045 </dd>
1903 </dl> 2046 </dl>
1904 <a NAME="Git.gitStashBranch" ID="Git.gitStashBranch"></a> 2047 <a NAME="Git.gitStashBranch" ID="Git.gitStashBranch"></a>
1905 <h4>Git.gitStashBranch</h4> 2048 <h4>Git.gitStashBranch</h4>
1906 <b>gitStashBranch</b>(<i>projectDir, stashName=""</i>) 2049 <b>gitStashBranch</b>(<i>projectDir, stashName=""</i>)
1908 <p> 2051 <p>
1909 Public method to create a branch from a stash. 2052 Public method to create a branch from a stash.
1910 </p> 2053 </p>
1911 <dl> 2054 <dl>
1912 2055
1913 <dt><i>projectDir</i></dt> 2056 <dt><i>projectDir</i> (str)</dt>
1914 <dd> 2057 <dd>
1915 name of the project directory (string) 2058 name of the project directory
1916 </dd> 2059 </dd>
1917 <dt><i>stashName</i></dt> 2060 <dt><i>stashName</i> (str)</dt>
1918 <dd> 2061 <dd>
1919 name of a stash (string) 2062 name of a stash
1920 </dd> 2063 </dd>
1921 </dl> 2064 </dl>
1922 <dl> 2065 <dl>
1923 <dt>Return:</dt> 2066 <dt>Return:</dt>
1924 <dd> 2067 <dd>
1925 flag indicating, that the restore contained an add 2068 flag indicating, that the restore contained an add or delete
1926 or delete (boolean) 2069 </dd>
2070 </dl>
2071 <dl>
2072 <dt>Return Type:</dt>
2073 <dd>
2074 bool
1927 </dd> 2075 </dd>
1928 </dl> 2076 </dl>
1929 <a NAME="Git.gitStashBrowser" ID="Git.gitStashBrowser"></a> 2077 <a NAME="Git.gitStashBrowser" ID="Git.gitStashBrowser"></a>
1930 <h4>Git.gitStashBrowser</h4> 2078 <h4>Git.gitStashBrowser</h4>
1931 <b>gitStashBrowser</b>(<i>projectDir</i>) 2079 <b>gitStashBrowser</b>(<i>projectDir</i>)
1933 <p> 2081 <p>
1934 Public method used to browse the stashed changes. 2082 Public method used to browse the stashed changes.
1935 </p> 2083 </p>
1936 <dl> 2084 <dl>
1937 2085
1938 <dt><i>projectDir</i></dt> 2086 <dt><i>projectDir</i> (str)</dt>
1939 <dd> 2087 <dd>
1940 name of the project directory (string) 2088 name of the project directory
1941 </dd> 2089 </dd>
1942 </dl> 2090 </dl>
1943 <a NAME="Git.gitStashClear" ID="Git.gitStashClear"></a> 2091 <a NAME="Git.gitStashClear" ID="Git.gitStashClear"></a>
1944 <h4>Git.gitStashClear</h4> 2092 <h4>Git.gitStashClear</h4>
1945 <b>gitStashClear</b>(<i>projectDir</i>) 2093 <b>gitStashClear</b>(<i>projectDir</i>)
1947 <p> 2095 <p>
1948 Public method to delete all stashes. 2096 Public method to delete all stashes.
1949 </p> 2097 </p>
1950 <dl> 2098 <dl>
1951 2099
1952 <dt><i>projectDir</i></dt> 2100 <dt><i>projectDir</i> (str)</dt>
1953 <dd> 2101 <dd>
1954 name of the project directory (string) 2102 name of the project directory
1955 </dd> 2103 </dd>
1956 </dl> 2104 </dl>
1957 <dl> 2105 <dl>
1958 <dt>Return:</dt> 2106 <dt>Return:</dt>
1959 <dd> 2107 <dd>
1960 flag indicating a successful deletion (boolean) 2108 flag indicating a successful deletion
2109 </dd>
2110 </dl>
2111 <dl>
2112 <dt>Return Type:</dt>
2113 <dd>
2114 bool
1961 </dd> 2115 </dd>
1962 </dl> 2116 </dl>
1963 <a NAME="Git.gitStashDrop" ID="Git.gitStashDrop"></a> 2117 <a NAME="Git.gitStashDrop" ID="Git.gitStashDrop"></a>
1964 <h4>Git.gitStashDrop</h4> 2118 <h4>Git.gitStashDrop</h4>
1965 <b>gitStashDrop</b>(<i>projectDir, stashName=""</i>) 2119 <b>gitStashDrop</b>(<i>projectDir, stashName=""</i>)
1967 <p> 2121 <p>
1968 Public method to delete a stash. 2122 Public method to delete a stash.
1969 </p> 2123 </p>
1970 <dl> 2124 <dl>
1971 2125
1972 <dt><i>projectDir</i></dt> 2126 <dt><i>projectDir</i> (str)</dt>
1973 <dd> 2127 <dd>
1974 name of the project directory (string) 2128 name of the project directory
1975 </dd> 2129 </dd>
1976 <dt><i>stashName</i></dt> 2130 <dt><i>stashName</i> (str)</dt>
1977 <dd> 2131 <dd>
1978 name of a stash (string) 2132 name of a stash
1979 </dd> 2133 </dd>
1980 </dl> 2134 </dl>
1981 <dl> 2135 <dl>
1982 <dt>Return:</dt> 2136 <dt>Return:</dt>
1983 <dd> 2137 <dd>
1984 flag indicating a successful deletion (boolean) 2138 flag indicating a successful deletion
2139 </dd>
2140 </dl>
2141 <dl>
2142 <dt>Return Type:</dt>
2143 <dd>
2144 bool
1985 </dd> 2145 </dd>
1986 </dl> 2146 </dl>
1987 <a NAME="Git.gitStashPop" ID="Git.gitStashPop"></a> 2147 <a NAME="Git.gitStashPop" ID="Git.gitStashPop"></a>
1988 <h4>Git.gitStashPop</h4> 2148 <h4>Git.gitStashPop</h4>
1989 <b>gitStashPop</b>(<i>projectDir, stashName=""</i>) 2149 <b>gitStashPop</b>(<i>projectDir, stashName=""</i>)
1991 <p> 2151 <p>
1992 Public method to apply a stash and delete it. 2152 Public method to apply a stash and delete it.
1993 </p> 2153 </p>
1994 <dl> 2154 <dl>
1995 2155
1996 <dt><i>projectDir</i></dt> 2156 <dt><i>projectDir</i> (str)</dt>
1997 <dd> 2157 <dd>
1998 name of the project directory (string) 2158 name of the project directory
1999 </dd> 2159 </dd>
2000 <dt><i>stashName</i></dt> 2160 <dt><i>stashName</i> (str)</dt>
2001 <dd> 2161 <dd>
2002 name of a stash (string) 2162 name of a stash
2003 </dd> 2163 </dd>
2004 </dl> 2164 </dl>
2005 <dl> 2165 <dl>
2006 <dt>Return:</dt> 2166 <dt>Return:</dt>
2007 <dd> 2167 <dd>
2008 flag indicating, that the restore contained an add 2168 flag indicating, that the restore contained an add or delete
2009 or delete (boolean) 2169 </dd>
2170 </dl>
2171 <dl>
2172 <dt>Return Type:</dt>
2173 <dd>
2174 bool
2010 </dd> 2175 </dd>
2011 </dl> 2176 </dl>
2012 <a NAME="Git.gitStashSave" ID="Git.gitStashSave"></a> 2177 <a NAME="Git.gitStashSave" ID="Git.gitStashSave"></a>
2013 <h4>Git.gitStashSave</h4> 2178 <h4>Git.gitStashSave</h4>
2014 <b>gitStashSave</b>(<i>projectDir</i>) 2179 <b>gitStashSave</b>(<i>projectDir</i>)
2016 <p> 2181 <p>
2017 Public method to save the current changes to a new stash. 2182 Public method to save the current changes to a new stash.
2018 </p> 2183 </p>
2019 <dl> 2184 <dl>
2020 2185
2021 <dt><i>projectDir</i></dt> 2186 <dt><i>projectDir</i> (str)</dt>
2022 <dd> 2187 <dd>
2023 name of the project directory (string) 2188 name of the project directory
2024 </dd> 2189 </dd>
2025 </dl> 2190 </dl>
2026 <dl> 2191 <dl>
2027 <dt>Return:</dt> 2192 <dt>Return:</dt>
2028 <dd> 2193 <dd>
2029 flag indicating, that the save contained an add 2194 flag indicating, that the save contained an add or delete
2030 or delete (boolean) 2195 </dd>
2196 </dl>
2197 <dl>
2198 <dt>Return Type:</dt>
2199 <dd>
2200 bool
2031 </dd> 2201 </dd>
2032 </dl> 2202 </dl>
2033 <a NAME="Git.gitStashShowPatch" ID="Git.gitStashShowPatch"></a> 2203 <a NAME="Git.gitStashShowPatch" ID="Git.gitStashShowPatch"></a>
2034 <h4>Git.gitStashShowPatch</h4> 2204 <h4>Git.gitStashShowPatch</h4>
2035 <b>gitStashShowPatch</b>(<i>projectDir, stashName=""</i>) 2205 <b>gitStashShowPatch</b>(<i>projectDir, stashName=""</i>)
2037 <p> 2207 <p>
2038 Public method to show the contents of a stash. 2208 Public method to show the contents of a stash.
2039 </p> 2209 </p>
2040 <dl> 2210 <dl>
2041 2211
2042 <dt><i>projectDir</i></dt> 2212 <dt><i>projectDir</i> (str)</dt>
2043 <dd> 2213 <dd>
2044 name of the project directory (string) 2214 name of the project directory
2045 </dd> 2215 </dd>
2046 <dt><i>stashName</i></dt> 2216 <dt><i>stashName</i> (str)</dt>
2047 <dd> 2217 <dd>
2048 name of a stash (string) 2218 name of a stash
2049 </dd> 2219 </dd>
2050 </dl> 2220 </dl>
2051 <a NAME="Git.gitStatistics" ID="Git.gitStatistics"></a> 2221 <a NAME="Git.gitStatistics" ID="Git.gitStatistics"></a>
2052 <h4>Git.gitStatistics</h4> 2222 <h4>Git.gitStatistics</h4>
2053 <b>gitStatistics</b>(<i>projectDir</i>) 2223 <b>gitStatistics</b>(<i>projectDir</i>)
2055 <p> 2225 <p>
2056 Public method to show some statistics of the local repository. 2226 Public method to show some statistics of the local repository.
2057 </p> 2227 </p>
2058 <dl> 2228 <dl>
2059 2229
2060 <dt><i>projectDir</i></dt> 2230 <dt><i>projectDir</i> (str)</dt>
2061 <dd> 2231 <dd>
2062 name of the project directory (string) 2232 name of the project directory
2063 </dd> 2233 </dd>
2064 </dl> 2234 </dl>
2065 <a NAME="Git.gitSubmoduleAdd" ID="Git.gitSubmoduleAdd"></a> 2235 <a NAME="Git.gitSubmoduleAdd" ID="Git.gitSubmoduleAdd"></a>
2066 <h4>Git.gitSubmoduleAdd</h4> 2236 <h4>Git.gitSubmoduleAdd</h4>
2067 <b>gitSubmoduleAdd</b>(<i>projectDir</i>) 2237 <b>gitSubmoduleAdd</b>(<i>projectDir</i>)
2204 <p> 2374 <p>
2205 Public method used to unstage a file/directory. 2375 Public method used to unstage a file/directory.
2206 </p> 2376 </p>
2207 <dl> 2377 <dl>
2208 2378
2209 <dt><i>name</i></dt> 2379 <dt><i>name</i> (str)</dt>
2210 <dd> 2380 <dd>
2211 file/directory name to be reverted (string) 2381 file/directory name to be reverted
2212 </dd> 2382 </dd>
2213 </dl> 2383 </dl>
2214 <dl> 2384 <dl>
2215 <dt>Return:</dt> 2385 <dt>Return:</dt>
2216 <dd> 2386 <dd>
2217 flag indicating, that the update contained an add 2387 flag indicating, that the update contained an add or delete
2218 or delete (boolean) 2388 </dd>
2389 </dl>
2390 <dl>
2391 <dt>Return Type:</dt>
2392 <dd>
2393 bool
2219 </dd> 2394 </dd>
2220 </dl> 2395 </dl>
2221 <a NAME="Git.gitVerify" ID="Git.gitVerify"></a> 2396 <a NAME="Git.gitVerify" ID="Git.gitVerify"></a>
2222 <h4>Git.gitVerify</h4> 2397 <h4>Git.gitVerify</h4>
2223 <b>gitVerify</b>(<i>projectDir</i>) 2398 <b>gitVerify</b>(<i>projectDir</i>)
2226 Public method to verify the connectivity and validity of objects 2401 Public method to verify the connectivity and validity of objects
2227 of the database. 2402 of the database.
2228 </p> 2403 </p>
2229 <dl> 2404 <dl>
2230 2405
2231 <dt><i>projectDir</i></dt> 2406 <dt><i>projectDir</i> (str)</dt>
2232 <dd> 2407 <dd>
2233 name of the project directory (string) 2408 name of the project directory
2234 </dd> 2409 </dd>
2235 </dl> 2410 </dl>
2236 <a NAME="Git.gitVerifyBundle" ID="Git.gitVerifyBundle"></a> 2411 <a NAME="Git.gitVerifyBundle" ID="Git.gitVerifyBundle"></a>
2237 <h4>Git.gitVerifyBundle</h4> 2412 <h4>Git.gitVerifyBundle</h4>
2238 <b>gitVerifyBundle</b>(<i>projectDir</i>) 2413 <b>gitVerifyBundle</b>(<i>projectDir</i>)
2240 <p> 2415 <p>
2241 Public method to verify a bundle file. 2416 Public method to verify a bundle file.
2242 </p> 2417 </p>
2243 <dl> 2418 <dl>
2244 2419
2245 <dt><i>projectDir</i></dt> 2420 <dt><i>projectDir</i> (str)</dt>
2246 <dd> 2421 <dd>
2247 name of the project directory (string) 2422 name of the project directory
2248 </dd> 2423 </dd>
2249 </dl> 2424 </dl>
2250 <a NAME="Git.gitWorktreeManagement" ID="Git.gitWorktreeManagement"></a> 2425 <a NAME="Git.gitWorktreeManagement" ID="Git.gitWorktreeManagement"></a>
2251 <h4>Git.gitWorktreeManagement</h4> 2426 <h4>Git.gitWorktreeManagement</h4>
2252 <b>gitWorktreeManagement</b>(<i>projectDir</i>) 2427 <b>gitWorktreeManagement</b>(<i>projectDir</i>)
2268 <p> 2443 <p>
2269 Public method to initialize a command arguments list. 2444 Public method to initialize a command arguments list.
2270 </p> 2445 </p>
2271 <dl> 2446 <dl>
2272 2447
2273 <dt><i>command</i></dt> 2448 <dt><i>command</i> (str)</dt>
2274 <dd> 2449 <dd>
2275 command name (string) 2450 command name
2276 </dd> 2451 </dd>
2277 </dl> 2452 </dl>
2278 <dl> 2453 <dl>
2279 <dt>Return:</dt> 2454 <dt>Return:</dt>
2280 <dd> 2455 <dd>
2281 list of command options (list of string) 2456 list of command options
2457 </dd>
2458 </dl>
2459 <dl>
2460 <dt>Return Type:</dt>
2461 <dd>
2462 list of str
2282 </dd> 2463 </dd>
2283 </dl> 2464 </dl>
2284 <a NAME="Git.vcsAdd" ID="Git.vcsAdd"></a> 2465 <a NAME="Git.vcsAdd" ID="Git.vcsAdd"></a>
2285 <h4>Git.vcsAdd</h4> 2466 <h4>Git.vcsAdd</h4>
2286 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) 2467 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
2288 <p> 2469 <p>
2289 Public method used to add a file/directory to the Git repository. 2470 Public method used to add a file/directory to the Git repository.
2290 </p> 2471 </p>
2291 <dl> 2472 <dl>
2292 2473
2293 <dt><i>name</i></dt> 2474 <dt><i>name</i> (str)</dt>
2294 <dd> 2475 <dd>
2295 file/directory name to be added (string) 2476 file/directory name to be added
2296 </dd> 2477 </dd>
2297 <dt><i>isDir</i></dt> 2478 <dt><i>isDir</i> (bool)</dt>
2298 <dd> 2479 <dd>
2299 flag indicating name is a directory (boolean) 2480 flag indicating name is a directory
2300 </dd> 2481 </dd>
2301 <dt><i>noDialog</i></dt> 2482 <dt><i>noDialog</i> (bool)</dt>
2302 <dd> 2483 <dd>
2303 flag indicating quiet operations 2484 flag indicating quiet operations
2304 </dd> 2485 </dd>
2305 </dl> 2486 </dl>
2306 <a NAME="Git.vcsAddBinary" ID="Git.vcsAddBinary"></a> 2487 <a NAME="Git.vcsAddBinary" ID="Git.vcsAddBinary"></a>
2311 Public method used to add a file/directory in binary mode to the 2492 Public method used to add a file/directory in binary mode to the
2312 Git repository. 2493 Git repository.
2313 </p> 2494 </p>
2314 <dl> 2495 <dl>
2315 2496
2316 <dt><i>name</i></dt> 2497 <dt><i>name</i> (str)</dt>
2317 <dd> 2498 <dd>
2318 file/directory name to be added (string) 2499 file/directory name to be added
2319 </dd> 2500 </dd>
2320 <dt><i>isDir</i></dt> 2501 <dt><i>isDir</i> (bool)</dt>
2321 <dd> 2502 <dd>
2322 flag indicating name is a directory (boolean) 2503 flag indicating name is a directory
2323 </dd> 2504 </dd>
2324 </dl> 2505 </dl>
2325 <a NAME="Git.vcsAddCommitMessage" ID="Git.vcsAddCommitMessage"></a> 2506 <a NAME="Git.vcsAddCommitMessage" ID="Git.vcsAddCommitMessage"></a>
2326 <h4>Git.vcsAddCommitMessage</h4> 2507 <h4>Git.vcsAddCommitMessage</h4>
2327 <b>vcsAddCommitMessage</b>(<i>message</i>) 2508 <b>vcsAddCommitMessage</b>(<i>message</i>)
2344 Public method to add a directory tree rooted at path to the Git 2525 Public method to add a directory tree rooted at path to the Git
2345 repository. 2526 repository.
2346 </p> 2527 </p>
2347 <dl> 2528 <dl>
2348 2529
2349 <dt><i>path</i></dt> 2530 <dt><i>path</i> (str or list of str)</dt>
2350 <dd> 2531 <dd>
2351 root directory of the tree to be added (string or list of 2532 root directory of the tree to be added
2352 strings))
2353 </dd> 2533 </dd>
2354 </dl> 2534 </dl>
2355 <a NAME="Git.vcsAllRegisteredStates" ID="Git.vcsAllRegisteredStates"></a> 2535 <a NAME="Git.vcsAllRegisteredStates" ID="Git.vcsAllRegisteredStates"></a>
2356 <h4>Git.vcsAllRegisteredStates</h4> 2536 <h4>Git.vcsAllRegisteredStates</h4>
2357 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) 2537 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>)
2365 if the named directory has been scanned already. If so, it is assumed, 2545 if the named directory has been scanned already. If so, it is assumed,
2366 that the states for all files have been populated by the previous run. 2546 that the states for all files have been populated by the previous run.
2367 </p> 2547 </p>
2368 <dl> 2548 <dl>
2369 2549
2370 <dt><i>names</i></dt> 2550 <dt><i>names</i> (dict)</dt>
2371 <dd> 2551 <dd>
2372 dictionary with all filenames to be checked as keys 2552 dictionary with all filenames to be checked as keys
2373 </dd> 2553 </dd>
2374 <dt><i>dname</i></dt> 2554 <dt><i>dname</i> (str)</dt>
2375 <dd> 2555 <dd>
2376 directory to check in (string) 2556 directory to check in
2377 </dd> 2557 </dd>
2378 <dt><i>shortcut</i></dt> 2558 <dt><i>shortcut</i> (bool)</dt>
2379 <dd> 2559 <dd>
2380 flag indicating a shortcut should be taken (boolean) 2560 flag indicating a shortcut should be taken
2381 </dd> 2561 </dd>
2382 </dl> 2562 </dl>
2383 <dl> 2563 <dl>
2384 <dt>Return:</dt> 2564 <dt>Return:</dt>
2385 <dd> 2565 <dd>
2386 the received dictionary completed with a combination of 2566 the received dictionary completed with a combination of
2387 canBeCommited and canBeAdded or None in order to signal an error 2567 canBeCommited and canBeAdded or None in order to signal an error
2568 </dd>
2569 </dl>
2570 <dl>
2571 <dt>Return Type:</dt>
2572 <dd>
2573 dict
2388 </dd> 2574 </dd>
2389 </dl> 2575 </dl>
2390 <a NAME="Git.vcsCheckout" ID="Git.vcsCheckout"></a> 2576 <a NAME="Git.vcsCheckout" ID="Git.vcsCheckout"></a>
2391 <h4>Git.vcsCheckout</h4> 2577 <h4>Git.vcsCheckout</h4>
2392 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) 2578 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
2395 Public method used to check the project out of a Git repository 2581 Public method used to check the project out of a Git repository
2396 (clone). 2582 (clone).
2397 </p> 2583 </p>
2398 <dl> 2584 <dl>
2399 2585
2400 <dt><i>vcsDataDict</i></dt> 2586 <dt><i>vcsDataDict</i> (dict)</dt>
2401 <dd> 2587 <dd>
2402 dictionary of data required for the checkout 2588 dictionary of data required for the checkout
2403 </dd> 2589 </dd>
2404 <dt><i>projectDir</i></dt> 2590 <dt><i>projectDir</i> (str)</dt>
2405 <dd> 2591 <dd>
2406 project directory to create (string) 2592 project directory to create
2407 </dd> 2593 </dd>
2408 <dt><i>noDialog</i></dt> 2594 <dt><i>noDialog</i> (bool)</dt>
2409 <dd> 2595 <dd>
2410 flag indicating quiet operations 2596 flag indicating quiet operations
2411 </dd> 2597 </dd>
2412 </dl> 2598 </dl>
2413 <dl> 2599 <dl>
2414 <dt>Return:</dt> 2600 <dt>Return:</dt>
2415 <dd> 2601 <dd>
2416 flag indicating an execution without errors (boolean) 2602 flag indicating an execution without errors
2603 </dd>
2604 </dl>
2605 <dl>
2606 <dt>Return Type:</dt>
2607 <dd>
2608 bool
2417 </dd> 2609 </dd>
2418 </dl> 2610 </dl>
2419 <a NAME="Git.vcsCleanup" ID="Git.vcsCleanup"></a> 2611 <a NAME="Git.vcsCleanup" ID="Git.vcsCleanup"></a>
2420 <h4>Git.vcsCleanup</h4> 2612 <h4>Git.vcsCleanup</h4>
2421 <b>vcsCleanup</b>(<i>name</i>) 2613 <b>vcsCleanup</b>(<i>name</i>)
2423 <p> 2615 <p>
2424 Public method used to cleanup the working directory. 2616 Public method used to cleanup the working directory.
2425 </p> 2617 </p>
2426 <dl> 2618 <dl>
2427 2619
2428 <dt><i>name</i></dt> 2620 <dt><i>name</i> (str)</dt>
2429 <dd> 2621 <dd>
2430 directory name to be cleaned up (string) 2622 directory name to be cleaned up
2431 </dd> 2623 </dd>
2432 </dl> 2624 </dl>
2433 <a NAME="Git.vcsClearCommitMessages" ID="Git.vcsClearCommitMessages"></a> 2625 <a NAME="Git.vcsClearCommitMessages" ID="Git.vcsClearCommitMessages"></a>
2434 <h4>Git.vcsClearCommitMessages</h4> 2626 <h4>Git.vcsClearCommitMessages</h4>
2435 <b>vcsClearCommitMessages</b>(<i></i>) 2627 <b>vcsClearCommitMessages</b>(<i></i>)
2444 <p> 2636 <p>
2445 Public method used to execute arbitrary Git commands. 2637 Public method used to execute arbitrary Git commands.
2446 </p> 2638 </p>
2447 <dl> 2639 <dl>
2448 2640
2449 <dt><i>name</i></dt> 2641 <dt><i>name</i> (str)</dt>
2450 <dd> 2642 <dd>
2451 directory name of the working directory (string) 2643 directory name of the working directory
2452 </dd> 2644 </dd>
2453 </dl> 2645 </dl>
2454 <a NAME="Git.vcsCommit" ID="Git.vcsCommit"></a> 2646 <a NAME="Git.vcsCommit" ID="Git.vcsCommit"></a>
2455 <h4>Git.vcsCommit</h4> 2647 <h4>Git.vcsCommit</h4>
2456 <b>vcsCommit</b>(<i>name, message="", noDialog=False, commitAll=True, amend=False</i>) 2648 <b>vcsCommit</b>(<i>name, message="", noDialog=False, commitAll=True, amend=False</i>)
2459 Public method used to make the change of a file/directory permanent 2651 Public method used to make the change of a file/directory permanent
2460 in the Git repository. 2652 in the Git repository.
2461 </p> 2653 </p>
2462 <dl> 2654 <dl>
2463 2655
2464 <dt><i>name</i></dt> 2656 <dt><i>name</i> (str or list of str)</dt>
2465 <dd> 2657 <dd>
2466 file/directory name to be committed (string or list of 2658 file/directory name to be committed
2467 strings) 2659 </dd>
2468 </dd> 2660 <dt><i>message</i> (str)</dt>
2469 <dt><i>message</i></dt> 2661 <dd>
2470 <dd> 2662 message for this operation
2471 message for this operation (string) 2663 </dd>
2472 </dd> 2664 <dt><i>noDialog</i> (bool)</dt>
2473 <dt><i>noDialog</i></dt> 2665 <dd>
2474 <dd> 2666 flag indicating quiet operations
2475 flag indicating quiet operations (boolean) 2667 </dd>
2476 </dd> 2668 <dt><i>commitAll</i> (bool)</dt>
2477 <dt><i>commitAll</i></dt> 2669 <dd>
2478 <dd> 2670 flag indicating to commit all local changes
2479 flag indicating to commit all local changes (boolean) 2671 </dd>
2480 </dd> 2672 <dt><i>amend</i> (bool)</dt>
2481 <dt><i>amend</i></dt> 2673 <dd>
2482 <dd> 2674 flag indicating to amend the HEAD commit
2483 flag indicating to amend the HEAD commit (boolean)
2484 </dd> 2675 </dd>
2485 </dl> 2676 </dl>
2486 <a NAME="Git.vcsCommitMessages" ID="Git.vcsCommitMessages"></a> 2677 <a NAME="Git.vcsCommitMessages" ID="Git.vcsCommitMessages"></a>
2487 <h4>Git.vcsCommitMessages</h4> 2678 <h4>Git.vcsCommitMessages</h4>
2488 <b>vcsCommitMessages</b>(<i></i>) 2679 <b>vcsCommitMessages</b>(<i></i>)
2539 being edited and has unsaved modification, they can be saved or the 2730 being edited and has unsaved modification, they can be saved or the
2540 operation may be aborted. 2731 operation may be aborted.
2541 </p> 2732 </p>
2542 <dl> 2733 <dl>
2543 2734
2544 <dt><i>name</i></dt> 2735 <dt><i>name</i> (str)</dt>
2545 <dd> 2736 <dd>
2546 file/directory name to be diffed (string) 2737 file/directory name to be diffed
2547 </dd> 2738 </dd>
2548 </dl> 2739 </dl>
2549 <a NAME="Git.vcsExists" ID="Git.vcsExists"></a> 2740 <a NAME="Git.vcsExists" ID="Git.vcsExists"></a>
2550 <h4>Git.vcsExists</h4> 2741 <h4>Git.vcsExists</h4>
2551 <b>vcsExists</b>(<i></i>) 2742 <b>vcsExists</b>(<i></i>)
2554 Public method used to test for the presence of the git executable. 2745 Public method used to test for the presence of the git executable.
2555 </p> 2746 </p>
2556 <dl> 2747 <dl>
2557 <dt>Return:</dt> 2748 <dt>Return:</dt>
2558 <dd> 2749 <dd>
2559 flag indicating the existance (boolean) and an error message 2750 flag indicating the existance and an error message
2560 (string) 2751 </dd>
2752 </dl>
2753 <dl>
2754 <dt>Return Type:</dt>
2755 <dd>
2756 tuple of (bool, str)
2561 </dd> 2757 </dd>
2562 </dl> 2758 </dl>
2563 <a NAME="Git.vcsExport" ID="Git.vcsExport"></a> 2759 <a NAME="Git.vcsExport" ID="Git.vcsExport"></a>
2564 <h4>Git.vcsExport</h4> 2760 <h4>Git.vcsExport</h4>
2565 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>) 2761 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
2567 <p> 2763 <p>
2568 Public method used to export a directory from the Git repository. 2764 Public method used to export a directory from the Git repository.
2569 </p> 2765 </p>
2570 <dl> 2766 <dl>
2571 2767
2572 <dt><i>vcsDataDict</i></dt> 2768 <dt><i>vcsDataDict</i> (dict)</dt>
2573 <dd> 2769 <dd>
2574 dictionary of data required for the checkout 2770 dictionary of data required for the checkout
2575 </dd> 2771 </dd>
2576 <dt><i>projectDir</i></dt> 2772 <dt><i>projectDir</i> (str)</dt>
2577 <dd> 2773 <dd>
2578 project directory to create (string) 2774 project directory to create
2579 </dd> 2775 </dd>
2580 </dl> 2776 </dl>
2581 <dl> 2777 <dl>
2582 <dt>Return:</dt> 2778 <dt>Return:</dt>
2583 <dd> 2779 <dd>
2584 flag indicating an execution without errors (boolean) 2780 flag indicating an execution without errors
2781 </dd>
2782 </dl>
2783 <dl>
2784 <dt>Return Type:</dt>
2785 <dd>
2786 bool
2585 </dd> 2787 </dd>
2586 </dl> 2788 </dl>
2587 <a NAME="Git.vcsForget" ID="Git.vcsForget"></a> 2789 <a NAME="Git.vcsForget" ID="Git.vcsForget"></a>
2588 <h4>Git.vcsForget</h4> 2790 <h4>Git.vcsForget</h4>
2589 <b>vcsForget</b>(<i>name</i>) 2791 <b>vcsForget</b>(<i>name</i>)
2609 Public method to instantiate a helper object for the different 2811 Public method to instantiate a helper object for the different
2610 project browsers. 2812 project browsers.
2611 </p> 2813 </p>
2612 <dl> 2814 <dl>
2613 2815
2614 <dt><i>browser</i></dt> 2816 <dt><i>browser</i> (ProjectBaseBrowser)</dt>
2615 <dd> 2817 <dd>
2616 reference to the project browser object 2818 reference to the project browser object
2617 </dd> 2819 </dd>
2618 <dt><i>project</i></dt> 2820 <dt><i>project</i> (Project)</dt>
2619 <dd> 2821 <dd>
2620 reference to the project object 2822 reference to the project object
2621 </dd> 2823 </dd>
2622 <dt><i>isTranslationsBrowser</i></dt> 2824 <dt><i>isTranslationsBrowser</i> (bool)</dt>
2623 <dd> 2825 <dd>
2624 flag indicating, the helper is requested 2826 flag indicating, the helper is requested
2625 for the translations browser (this needs some special treatment) 2827 for the translations browser (this needs some special treatment)
2626 </dd> 2828 </dd>
2627 </dl> 2829 </dl>
2628 <dl> 2830 <dl>
2629 <dt>Return:</dt> 2831 <dt>Return:</dt>
2630 <dd> 2832 <dd>
2631 the project browser helper object 2833 the project browser helper object
2834 </dd>
2835 </dl>
2836 <dl>
2837 <dt>Return Type:</dt>
2838 <dd>
2839 GitProjectBrowserHelper
2632 </dd> 2840 </dd>
2633 </dl> 2841 </dl>
2634 <a NAME="Git.vcsGetProjectHelper" ID="Git.vcsGetProjectHelper"></a> 2842 <a NAME="Git.vcsGetProjectHelper" ID="Git.vcsGetProjectHelper"></a>
2635 <h4>Git.vcsGetProjectHelper</h4> 2843 <h4>Git.vcsGetProjectHelper</h4>
2636 <b>vcsGetProjectHelper</b>(<i>project</i>) 2844 <b>vcsGetProjectHelper</b>(<i>project</i>)
2638 <p> 2846 <p>
2639 Public method to instantiate a helper object for the project. 2847 Public method to instantiate a helper object for the project.
2640 </p> 2848 </p>
2641 <dl> 2849 <dl>
2642 2850
2643 <dt><i>project</i></dt> 2851 <dt><i>project</i> (Project)</dt>
2644 <dd> 2852 <dd>
2645 reference to the project object 2853 reference to the project object
2646 </dd> 2854 </dd>
2647 </dl> 2855 </dl>
2648 <dl> 2856 <dl>
2649 <dt>Return:</dt> 2857 <dt>Return:</dt>
2650 <dd> 2858 <dd>
2651 the project helper object 2859 the project helper object
2860 </dd>
2861 </dl>
2862 <dl>
2863 <dt>Return Type:</dt>
2864 <dd>
2865 GitProjectHelper
2652 </dd> 2866 </dd>
2653 </dl> 2867 </dl>
2654 <a NAME="Git.vcsImport" ID="Git.vcsImport"></a> 2868 <a NAME="Git.vcsImport" ID="Git.vcsImport"></a>
2655 <h4>Git.vcsImport</h4> 2869 <h4>Git.vcsImport</h4>
2656 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>) 2870 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>)
2664 <dd> 2878 <dd>
2665 dictionary of data required for the import 2879 dictionary of data required for the import
2666 </dd> 2880 </dd>
2667 <dt><i>projectDir</i> (str)</dt> 2881 <dt><i>projectDir</i> (str)</dt>
2668 <dd> 2882 <dd>
2669 project directory (string) 2883 project directory
2670 </dd> 2884 </dd>
2671 <dt><i>noDialog</i> (bool)</dt> 2885 <dt><i>noDialog</i> (bool)</dt>
2672 <dd> 2886 <dd>
2673 flag indicating quiet operations 2887 flag indicating quiet operations
2674 </dd> 2888 </dd>
2702 Git controlled project. Therefore we always return TRUE without 2916 Git controlled project. Therefore we always return TRUE without
2703 doing anything. 2917 doing anything.
2704 </p> 2918 </p>
2705 <dl> 2919 <dl>
2706 2920
2707 <dt><i>vcsDir</i></dt> 2921 <dt><i>vcsDir</i> (str)</dt>
2708 <dd> 2922 <dd>
2709 name of the VCS directory (string) 2923 name of the VCS directory
2710 </dd> 2924 </dd>
2711 <dt><i>noDialog</i></dt> 2925 <dt><i>noDialog</i> (bool)</dt>
2712 <dd> 2926 <dd>
2713 flag indicating quiet operations (boolean) 2927 flag indicating quiet operations
2714 </dd> 2928 </dd>
2715 </dl> 2929 </dl>
2716 <dl> 2930 <dl>
2717 <dt>Return:</dt> 2931 <dt>Return:</dt>
2718 <dd> 2932 <dd>
2719 always TRUE 2933 always True
2934 </dd>
2935 </dl>
2936 <dl>
2937 <dt>Return Type:</dt>
2938 <dd>
2939 bool
2720 </dd> 2940 </dd>
2721 </dl> 2941 </dl>
2722 <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a> 2942 <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a>
2723 <h4>Git.vcsInitConfig</h4> 2943 <h4>Git.vcsInitConfig</h4>
2724 <b>vcsInitConfig</b>(<i>project</i>) 2944 <b>vcsInitConfig</b>(<i>project</i>)
2729 <p> 2949 <p>
2730 This method ensures, that an ignore file exists. 2950 This method ensures, that an ignore file exists.
2731 </p> 2951 </p>
2732 <dl> 2952 <dl>
2733 2953
2734 <dt><i>project</i></dt> 2954 <dt><i>project</i> (Project)</dt>
2735 <dd> 2955 <dd>
2736 reference to the project (Project) 2956 reference to the project
2737 </dd> 2957 </dd>
2738 </dl> 2958 </dl>
2739 <a NAME="Git.vcsLogBrowser" ID="Git.vcsLogBrowser"></a> 2959 <a NAME="Git.vcsLogBrowser" ID="Git.vcsLogBrowser"></a>
2740 <h4>Git.vcsLogBrowser</h4> 2960 <h4>Git.vcsLogBrowser</h4>
2741 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) 2961 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>)
2744 Public method used to browse the log of a file/directory from the 2964 Public method used to browse the log of a file/directory from the
2745 Git repository. 2965 Git repository.
2746 </p> 2966 </p>
2747 <dl> 2967 <dl>
2748 2968
2749 <dt><i>name</i></dt> 2969 <dt><i>name</i> (str)</dt>
2750 <dd> 2970 <dd>
2751 file/directory name to show the log of (string) 2971 file/directory name to show the log of
2752 </dd> 2972 </dd>
2753 <dt><i>isFile</i></dt> 2973 <dt><i>isFile</i> (bool)</dt>
2754 <dd> 2974 <dd>
2755 flag indicating log for a file is to be shown 2975 flag indicating log for a file is to be shown
2756 (boolean)
2757 </dd> 2976 </dd>
2758 </dl> 2977 </dl>
2759 <a NAME="Git.vcsMerge" ID="Git.vcsMerge"></a> 2978 <a NAME="Git.vcsMerge" ID="Git.vcsMerge"></a>
2760 <h4>Git.vcsMerge</h4> 2979 <h4>Git.vcsMerge</h4>
2761 <b>vcsMerge</b>(<i>name</i>) 2980 <b>vcsMerge</b>(<i>name</i>)
2763 <p> 2982 <p>
2764 Public method used to merge a URL/revision into the local project. 2983 Public method used to merge a URL/revision into the local project.
2765 </p> 2984 </p>
2766 <dl> 2985 <dl>
2767 2986
2768 <dt><i>name</i></dt> 2987 <dt><i>name</i> (str)</dt>
2769 <dd> 2988 <dd>
2770 file/directory name to be merged (string) 2989 file/directory name to be merged
2771 </dd> 2990 </dd>
2772 </dl> 2991 </dl>
2773 <a NAME="Git.vcsMove" ID="Git.vcsMove"></a> 2992 <a NAME="Git.vcsMove" ID="Git.vcsMove"></a>
2774 <h4>Git.vcsMove</h4> 2993 <h4>Git.vcsMove</h4>
2775 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) 2994 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>)
2777 <p> 2996 <p>
2778 Public method used to move a file/directory. 2997 Public method used to move a file/directory.
2779 </p> 2998 </p>
2780 <dl> 2999 <dl>
2781 3000
2782 <dt><i>name</i></dt> 3001 <dt><i>name</i> (str)</dt>
2783 <dd> 3002 <dd>
2784 file/directory name to be moved (string) 3003 file/directory name to be moved
2785 </dd> 3004 </dd>
2786 <dt><i>project</i></dt> 3005 <dt><i>project</i> (Project)</dt>
2787 <dd> 3006 <dd>
2788 reference to the project object 3007 reference to the project object
2789 </dd> 3008 </dd>
2790 <dt><i>target</i></dt> 3009 <dt><i>target</i> (str)</dt>
2791 <dd> 3010 <dd>
2792 new name of the file/directory (string) 3011 new name of the file/directory
2793 </dd> 3012 </dd>
2794 <dt><i>noDialog</i></dt> 3013 <dt><i>noDialog</i> (bool)</dt>
2795 <dd> 3014 <dd>
2796 flag indicating quiet operations 3015 flag indicating quiet operations
2797 </dd> 3016 </dd>
2798 </dl> 3017 </dl>
2799 <dl> 3018 <dl>
2800 <dt>Return:</dt> 3019 <dt>Return:</dt>
2801 <dd> 3020 <dd>
2802 flag indicating successful operation (boolean) 3021 flag indicating successful operation
3022 </dd>
3023 </dl>
3024 <dl>
3025 <dt>Return Type:</dt>
3026 <dd>
3027 bool
2803 </dd> 3028 </dd>
2804 </dl> 3029 </dl>
2805 <a NAME="Git.vcsName" ID="Git.vcsName"></a> 3030 <a NAME="Git.vcsName" ID="Git.vcsName"></a>
2806 <h4>Git.vcsName</h4> 3031 <h4>Git.vcsName</h4>
2807 <b>vcsName</b>(<i></i>) 3032 <b>vcsName</b>(<i></i>)
2810 Public method returning the name of the vcs. 3035 Public method returning the name of the vcs.
2811 </p> 3036 </p>
2812 <dl> 3037 <dl>
2813 <dt>Return:</dt> 3038 <dt>Return:</dt>
2814 <dd> 3039 <dd>
2815 always 'Git' (string) 3040 always 'Git'
3041 </dd>
3042 </dl>
3043 <dl>
3044 <dt>Return Type:</dt>
3045 <dd>
3046 str
2816 </dd> 3047 </dd>
2817 </dl> 3048 </dl>
2818 <a NAME="Git.vcsNewProjectOptionsDialog" ID="Git.vcsNewProjectOptionsDialog"></a> 3049 <a NAME="Git.vcsNewProjectOptionsDialog" ID="Git.vcsNewProjectOptionsDialog"></a>
2819 <h4>Git.vcsNewProjectOptionsDialog</h4> 3050 <h4>Git.vcsNewProjectOptionsDialog</h4>
2820 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) 3051 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>)
2823 Public method to get a dialog to enter repository info for getting a 3054 Public method to get a dialog to enter repository info for getting a
2824 new project. 3055 new project.
2825 </p> 3056 </p>
2826 <dl> 3057 <dl>
2827 3058
2828 <dt><i>parent</i></dt> 3059 <dt><i>parent</i> (QWidget)</dt>
2829 <dd> 3060 <dd>
2830 parent widget (QWidget) 3061 parent widget
2831 </dd> 3062 </dd>
2832 </dl> 3063 </dl>
2833 <dl> 3064 <dl>
2834 <dt>Return:</dt> 3065 <dt>Return:</dt>
2835 <dd> 3066 <dd>
2836 reference to the instantiated options dialog 3067 reference to the instantiated options dialog
2837 (GitNewProjectOptionsDialog) 3068 </dd>
3069 </dl>
3070 <dl>
3071 <dt>Return Type:</dt>
3072 <dd>
3073 GitNewProjectOptionsDialog
2838 </dd> 3074 </dd>
2839 </dl> 3075 </dl>
2840 <a NAME="Git.vcsOptionsDialog" ID="Git.vcsOptionsDialog"></a> 3076 <a NAME="Git.vcsOptionsDialog" ID="Git.vcsOptionsDialog"></a>
2841 <h4>Git.vcsOptionsDialog</h4> 3077 <h4>Git.vcsOptionsDialog</h4>
2842 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) 3078 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>)
2844 <p> 3080 <p>
2845 Public method to get a dialog to enter repository info. 3081 Public method to get a dialog to enter repository info.
2846 </p> 3082 </p>
2847 <dl> 3083 <dl>
2848 3084
2849 <dt><i>project</i></dt> 3085 <dt><i>project</i> (Project)</dt>
2850 <dd> 3086 <dd>
2851 reference to the project object 3087 reference to the project object
2852 </dd> 3088 </dd>
2853 <dt><i>archive</i></dt> 3089 <dt><i>archive</i> (str)</dt>
2854 <dd> 3090 <dd>
2855 name of the project in the repository (string) 3091 name of the project in the repository
2856 </dd> 3092 </dd>
2857 <dt><i>editable</i></dt> 3093 <dt><i>editable</i> (bool)</dt>
2858 <dd> 3094 <dd>
2859 flag indicating that the project name is editable 3095 flag indicating that the project name is editable
2860 (boolean) 3096 </dd>
2861 </dd> 3097 <dt><i>parent</i> (QWidget)</dt>
2862 <dt><i>parent</i></dt> 3098 <dd>
2863 <dd> 3099 parent widget
2864 parent widget (QWidget) 3100 </dd>
2865 </dd> 3101 </dl>
2866 </dl> 3102 <dl>
2867 <dl> 3103 <dt>Return:</dt>
2868 <dt>Return:</dt> 3104 <dd>
2869 <dd> 3105 reference to the instantiated options dialog
2870 reference to the instantiated options dialog (GitOptionsDialog) 3106 </dd>
3107 </dl>
3108 <dl>
3109 <dt>Return Type:</dt>
3110 <dd>
3111 GitOptionsDialog
2871 </dd> 3112 </dd>
2872 </dl> 3113 </dl>
2873 <a NAME="Git.vcsRegisteredState" ID="Git.vcsRegisteredState"></a> 3114 <a NAME="Git.vcsRegisteredState" ID="Git.vcsRegisteredState"></a>
2874 <h4>Git.vcsRegisteredState</h4> 3115 <h4>Git.vcsRegisteredState</h4>
2875 <b>vcsRegisteredState</b>(<i>name</i>) 3116 <b>vcsRegisteredState</b>(<i>name</i>)
2877 <p> 3118 <p>
2878 Public method used to get the registered state of a file in the vcs. 3119 Public method used to get the registered state of a file in the vcs.
2879 </p> 3120 </p>
2880 <dl> 3121 <dl>
2881 3122
2882 <dt><i>name</i></dt> 3123 <dt><i>name</i> (str)</dt>
2883 <dd> 3124 <dd>
2884 filename to check (string) 3125 filename to check
2885 </dd> 3126 </dd>
2886 </dl> 3127 </dl>
2887 <dl> 3128 <dl>
2888 <dt>Return:</dt> 3129 <dt>Return:</dt>
2889 <dd> 3130 <dd>
2890 a combination of canBeCommited and canBeAdded 3131 registered state (one of canBeCommited and canBeAdded)
3132 </dd>
3133 </dl>
3134 <dl>
3135 <dt>Return Type:</dt>
3136 <dd>
3137 int
2891 </dd> 3138 </dd>
2892 </dl> 3139 </dl>
2893 <a NAME="Git.vcsRemove" ID="Git.vcsRemove"></a> 3140 <a NAME="Git.vcsRemove" ID="Git.vcsRemove"></a>
2894 <h4>Git.vcsRemove</h4> 3141 <h4>Git.vcsRemove</h4>
2895 <b>vcsRemove</b>(<i>name, project=False, noDialog=False, stageOnly=False</i>) 3142 <b>vcsRemove</b>(<i>name, project=False, noDialog=False, stageOnly=False</i>)
2901 <p> 3148 <p>
2902 The default operation is to remove the local copy as well. 3149 The default operation is to remove the local copy as well.
2903 </p> 3150 </p>
2904 <dl> 3151 <dl>
2905 3152
2906 <dt><i>name</i></dt> 3153 <dt><i>name</i> (str or list of str)</dt>
2907 <dd> 3154 <dd>
2908 file/directory name to be removed (string or list of 3155 file/directory name to be removed
2909 strings)) 3156 </dd>
2910 </dd> 3157 <dt><i>project</i> (bool)</dt>
2911 <dt><i>project</i></dt> 3158 <dd>
2912 <dd> 3159 flag indicating deletion of a project tree
2913 flag indicating deletion of a project tree (boolean) 3160 </dd>
2914 (not needed) 3161 <dt><i>noDialog</i> (bool)</dt>
2915 </dd> 3162 <dd>
2916 <dt><i>noDialog</i></dt> 3163 flag indicating quiet operations
2917 <dd> 3164 </dd>
2918 flag indicating quiet operations (boolean) 3165 <dt><i>stageOnly</i> (bool)</dt>
2919 </dd>
2920 <dt><i>stageOnly</i></dt>
2921 <dd> 3166 <dd>
2922 flag indicating to just remove the file from the 3167 flag indicating to just remove the file from the
2923 staging area (boolean) 3168 staging area
2924 </dd> 3169 </dd>
2925 </dl> 3170 </dl>
2926 <dl> 3171 <dl>
2927 <dt>Return:</dt> 3172 <dt>Return:</dt>
2928 <dd> 3173 <dd>
2929 flag indicating successful operation (boolean) 3174 flag indicating successful operation
3175 </dd>
3176 </dl>
3177 <dl>
3178 <dt>Return Type:</dt>
3179 <dd>
3180 bool
2930 </dd> 3181 </dd>
2931 </dl> 3182 </dl>
2932 <a NAME="Git.vcsRepositoryInfos" ID="Git.vcsRepositoryInfos"></a> 3183 <a NAME="Git.vcsRepositoryInfos" ID="Git.vcsRepositoryInfos"></a>
2933 <h4>Git.vcsRepositoryInfos</h4> 3184 <h4>Git.vcsRepositoryInfos</h4>
2934 <b>vcsRepositoryInfos</b>(<i>ppath</i>) 3185 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
2936 <p> 3187 <p>
2937 Public method to retrieve information about the repository. 3188 Public method to retrieve information about the repository.
2938 </p> 3189 </p>
2939 <dl> 3190 <dl>
2940 3191
2941 <dt><i>ppath</i></dt> 3192 <dt><i>ppath</i> (str)</dt>
2942 <dd> 3193 <dd>
2943 local path to get the repository infos (string) 3194 local path to get the repository infos
2944 </dd> 3195 </dd>
2945 </dl> 3196 </dl>
2946 <dl> 3197 <dl>
2947 <dt>Return:</dt> 3198 <dt>Return:</dt>
2948 <dd> 3199 <dd>
2949 string with ready formated info for display (string) 3200 string with ready formated info for display
3201 </dd>
3202 </dl>
3203 <dl>
3204 <dt>Return Type:</dt>
3205 <dd>
3206 str
2950 </dd> 3207 </dd>
2951 </dl> 3208 </dl>
2952 <a NAME="Git.vcsRevert" ID="Git.vcsRevert"></a> 3209 <a NAME="Git.vcsRevert" ID="Git.vcsRevert"></a>
2953 <h4>Git.vcsRevert</h4> 3210 <h4>Git.vcsRevert</h4>
2954 <b>vcsRevert</b>(<i>name</i>) 3211 <b>vcsRevert</b>(<i>name</i>)
2984 Public method used to view the difference of a file to the Git 3241 Public method used to view the difference of a file to the Git
2985 repository side-by-side. 3242 repository side-by-side.
2986 </p> 3243 </p>
2987 <dl> 3244 <dl>
2988 3245
2989 <dt><i>name</i></dt> 3246 <dt><i>name</i> (str)</dt>
2990 <dd> 3247 <dd>
2991 file name to be diffed (string) 3248 file name to be diffed
2992 </dd> 3249 </dd>
2993 <dt><i>extended</i></dt> 3250 <dt><i>extended</i> (bool)</dt>
2994 <dd> 3251 <dd>
2995 flag indicating the extended variant (boolean) 3252 flag indicating the extended variant
2996 </dd> 3253 </dd>
2997 <dt><i>revisions</i></dt> 3254 <dt><i>revisions</i> (tuple of (str, str))</dt>
2998 <dd> 3255 <dd>
2999 tuple of two revisions (tuple of strings) 3256 tuple of two revisions
3000 </dd> 3257 </dd>
3001 </dl> 3258 </dl>
3002 <dl> 3259 <dl>
3003 3260
3004 <dt>Raises <b>ValueError</b>:</dt> 3261 <dt>Raises <b>ValueError</b>:</dt>
3021 Public method used to view the status of files/directories in the 3278 Public method used to view the status of files/directories in the
3022 Git repository. 3279 Git repository.
3023 </p> 3280 </p>
3024 <dl> 3281 <dl>
3025 3282
3026 <dt><i>name</i></dt> 3283 <dt><i>name</i> (str or list of str)</dt>
3027 <dd> 3284 <dd>
3028 file/directory name(s) to show the status of 3285 file/directory name(s) to show the status of
3029 (string or list of strings)
3030 </dd> 3286 </dd>
3031 </dl> 3287 </dl>
3032 <a NAME="Git.vcsSupportCommandOptions" ID="Git.vcsSupportCommandOptions"></a> 3288 <a NAME="Git.vcsSupportCommandOptions" ID="Git.vcsSupportCommandOptions"></a>
3033 <h4>Git.vcsSupportCommandOptions</h4> 3289 <h4>Git.vcsSupportCommandOptions</h4>
3034 <b>vcsSupportCommandOptions</b>(<i></i>) 3290 <b>vcsSupportCommandOptions</b>(<i></i>)
3038 </p> 3294 </p>
3039 <dl> 3295 <dl>
3040 <dt>Return:</dt> 3296 <dt>Return:</dt>
3041 <dd> 3297 <dd>
3042 flag indicating the support of user settable command options 3298 flag indicating the support of user settable command options
3043 (boolean) 3299 </dd>
3300 </dl>
3301 <dl>
3302 <dt>Return Type:</dt>
3303 <dd>
3304 bool
3044 </dd> 3305 </dd>
3045 </dl> 3306 </dl>
3046 <a NAME="Git.vcsSwitch" ID="Git.vcsSwitch"></a> 3307 <a NAME="Git.vcsSwitch" ID="Git.vcsSwitch"></a>
3047 <h4>Git.vcsSwitch</h4> 3308 <h4>Git.vcsSwitch</h4>
3048 <b>vcsSwitch</b>(<i>name</i>) 3309 <b>vcsSwitch</b>(<i>name</i>)
3051 Public method used to switch a working directory to a different 3312 Public method used to switch a working directory to a different
3052 revision. 3313 revision.
3053 </p> 3314 </p>
3054 <dl> 3315 <dl>
3055 3316
3056 <dt><i>name</i></dt> 3317 <dt><i>name</i> (str)</dt>
3057 <dd> 3318 <dd>
3058 directory name to be switched (string) 3319 directory name to be switched
3059 </dd> 3320 </dd>
3060 </dl> 3321 </dl>
3061 <dl> 3322 <dl>
3062 <dt>Return:</dt> 3323 <dt>Return:</dt>
3063 <dd> 3324 <dd>
3064 flag indicating, that the switch contained an add 3325 flag indicating, that the switch contained an add or delete
3065 or delete (boolean) 3326 </dd>
3327 </dl>
3328 <dl>
3329 <dt>Return Type:</dt>
3330 <dd>
3331 bool
3066 </dd> 3332 </dd>
3067 </dl> 3333 </dl>
3068 <a NAME="Git.vcsTag" ID="Git.vcsTag"></a> 3334 <a NAME="Git.vcsTag" ID="Git.vcsTag"></a>
3069 <h4>Git.vcsTag</h4> 3335 <h4>Git.vcsTag</h4>
3070 <b>vcsTag</b>(<i>name, revision=None, tagName=None</i>) 3336 <b>vcsTag</b>(<i>name, revision=None, tagName=None</i>)
3072 <p> 3338 <p>
3073 Public method used to set/remove a tag in the Git repository. 3339 Public method used to set/remove a tag in the Git repository.
3074 </p> 3340 </p>
3075 <dl> 3341 <dl>
3076 3342
3077 <dt><i>name</i></dt> 3343 <dt><i>name</i> (str)</dt>
3078 <dd> 3344 <dd>
3079 file/directory name to determine the repo root from 3345 file/directory name to determine the repo root from
3080 (string) 3346 </dd>
3081 </dd> 3347 <dt><i>revision</i> (str)</dt>
3082 <dt><i>revision</i></dt> 3348 <dd>
3083 <dd> 3349 revision to set tag for
3084 revision to set tag for (string) 3350 </dd>
3085 </dd> 3351 <dt><i>tagName</i> (str)</dt>
3086 <dt><i>tagName</i></dt> 3352 <dd>
3087 <dd> 3353 name of the tag
3088 name of the tag (string) 3354 </dd>
3089 </dd> 3355 </dl>
3090 </dl> 3356 <dl>
3091 <dl> 3357 <dt>Return:</dt>
3092 <dt>Return:</dt> 3358 <dd>
3093 <dd> 3359 flag indicating a performed tag action
3094 flag indicating a performed tag action (boolean) 3360 </dd>
3361 </dl>
3362 <dl>
3363 <dt>Return Type:</dt>
3364 <dd>
3365 bool
3095 </dd> 3366 </dd>
3096 </dl> 3367 </dl>
3097 <a NAME="Git.vcsUpdate" ID="Git.vcsUpdate"></a> 3368 <a NAME="Git.vcsUpdate" ID="Git.vcsUpdate"></a>
3098 <h4>Git.vcsUpdate</h4> 3369 <h4>Git.vcsUpdate</h4>
3099 <b>vcsUpdate</b>(<i>name, noDialog=False, revision=None</i>) 3370 <b>vcsUpdate</b>(<i>name, noDialog=False, revision=None</i>)
3102 Public method used to update a file/directory with the Git 3373 Public method used to update a file/directory with the Git
3103 repository. 3374 repository.
3104 </p> 3375 </p>
3105 <dl> 3376 <dl>
3106 3377
3107 <dt><i>name</i></dt> 3378 <dt><i>name</i> (str or list of str)</dt>
3108 <dd> 3379 <dd>
3109 file/directory name to be updated (string or list of 3380 file/directory name to be updated
3110 strings) 3381 </dd>
3111 </dd> 3382 <dt><i>noDialog</i> (bool)</dt>
3112 <dt><i>noDialog</i></dt> 3383 <dd>
3113 <dd> 3384 flag indicating quiet operations
3114 flag indicating quiet operations (boolean) 3385 </dd>
3115 </dd> 3386 <dt><i>revision</i> (str)</dt>
3116 <dt><i>revision</i></dt> 3387 <dd>
3117 <dd> 3388 revision to update to
3118 revision to update to (string) 3389 </dd>
3119 </dd> 3390 </dl>
3120 </dl> 3391 <dl>
3121 <dl> 3392 <dt>Return:</dt>
3122 <dt>Return:</dt> 3393 <dd>
3123 <dd> 3394 flag indicating, that the update contained an add or delete
3124 flag indicating, that the update contained an add 3395 </dd>
3125 or delete (boolean) 3396 </dl>
3397 <dl>
3398 <dt>Return Type:</dt>
3399 <dd>
3400 bool
3126 </dd> 3401 </dd>
3127 </dl> 3402 </dl>
3128 <div align="right"><a href="#top">Up</a></div> 3403 <div align="right"><a href="#top">Up</a></div>
3129 <hr /> 3404 <hr />
3130 </body></html> 3405 </body></html>

Mercurial Repository: eric

eric ide

mercurial