Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html

src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 10259
b51dfacef37f
child 10479
856476537696
equal deleted inserted replaced
10437:2f70ca07f0af 10438:4cd7e5a8b3cf
562 <p> 562 <p>
563 Constructor 563 Constructor
564 </p> 564 </p>
565 <dl> 565 <dl>
566 566
567 <dt><i>plugin</i></dt> 567 <dt><i>plugin</i> (VcsMercurialPlugin)</dt>
568 <dd> 568 <dd>
569 reference to the plugin object 569 reference to the plugin object
570 </dd> 570 </dd>
571 <dt><i>parent</i></dt> 571 <dt><i>parent</i> (QWidget)</dt>
572 <dd> 572 <dd>
573 parent widget (QWidget) 573 parent widget
574 </dd> 574 </dd>
575 <dt><i>name</i></dt> 575 <dt><i>name</i> (str)</dt>
576 <dd> 576 <dd>
577 name of this object (string) 577 name of this object
578 </dd> 578 </dd>
579 </dl> 579 </dl>
580 <a NAME="Hg.__checkDefaults" ID="Hg.__checkDefaults"></a> 580 <a NAME="Hg.__checkDefaults" ID="Hg.__checkDefaults"></a>
581 <h4>Hg.__checkDefaults</h4> 581 <h4>Hg.__checkDefaults</h4>
582 <b>__checkDefaults</b>(<i></i>) 582 <b>__checkDefaults</b>(<i></i>)
613 <p> 613 <p>
614 Private method to get the list of incoming or outgoing bookmarks. 614 Private method to get the list of incoming or outgoing bookmarks.
615 </p> 615 </p>
616 <dl> 616 <dl>
617 617
618 <dt><i>incoming</i></dt> 618 <dt><i>incoming</i> (bool)</dt>
619 <dd> 619 <dd>
620 flag indicating to get incoming bookmarks (boolean) 620 flag indicating to get incoming bookmarks
621 </dd> 621 </dd>
622 </dl> 622 </dl>
623 <dl> 623 <dl>
624 <dt>Return:</dt> 624 <dt>Return:</dt>
625 <dd> 625 <dd>
626 list of bookmarks (list of string) 626 list of bookmarks
627 </dd>
628 </dl>
629 <dl>
630 <dt>Return Type:</dt>
631 <dd>
632 list of str
627 </dd> 633 </dd>
628 </dl> 634 </dl>
629 <a NAME="Hg.__getMostRecentCommitMessage" ID="Hg.__getMostRecentCommitMessage"></a> 635 <a NAME="Hg.__getMostRecentCommitMessage" ID="Hg.__getMostRecentCommitMessage"></a>
630 <h4>Hg.__getMostRecentCommitMessage</h4> 636 <h4>Hg.__getMostRecentCommitMessage</h4>
631 <b>__getMostRecentCommitMessage</b>(<i></i>) 637 <b>__getMostRecentCommitMessage</b>(<i></i>)
657 Private method to get a file for a specific revision from the 663 Private method to get a file for a specific revision from the
658 repository. 664 repository.
659 </p> 665 </p>
660 <dl> 666 <dl>
661 667
662 <dt><i>name</i></dt> 668 <dt><i>name</i> (str)</dt>
663 <dd> 669 <dd>
664 file name to get from the repository (string) 670 file name to get from the repository
665 </dd> 671 </dd>
666 <dt><i>rev</i></dt> 672 <dt><i>rev</i> (str)</dt>
667 <dd> 673 <dd>
668 revision to retrieve (string) 674 revision to retrieve
669 </dd> 675 </dd>
670 </dl> 676 </dl>
671 <dl> 677 <dl>
672 <dt>Return:</dt> 678 <dt>Return:</dt>
673 <dd> 679 <dd>
674 contents of the file (string) and an error message (string) 680 contents of the file (string) and an error message
681 </dd>
682 </dl>
683 <dl>
684 <dt>Return Type:</dt>
685 <dd>
686 str
675 </dd> 687 </dd>
676 </dl> 688 </dl>
677 <a NAME="Hg.__hgGraftSubCommand" ID="Hg.__hgGraftSubCommand"></a> 689 <a NAME="Hg.__hgGraftSubCommand" ID="Hg.__hgGraftSubCommand"></a>
678 <h4>Hg.__hgGraftSubCommand</h4> 690 <h4>Hg.__hgGraftSubCommand</h4>
679 <b>__hgGraftSubCommand</b>(<i>subcommand, title</i>) 691 <b>__hgGraftSubCommand</b>(<i>subcommand, title</i>)
711 <p> 723 <p>
712 Private slot to handle a change of the Mercurial configuration file. 724 Private slot to handle a change of the Mercurial configuration file.
713 </p> 725 </p>
714 <dl> 726 <dl>
715 727
716 <dt><i>path</i></dt> 728 <dt><i>path</i> (str)</dt>
717 <dd> 729 <dd>
718 name of the changed file (string) 730 name of the changed file
719 </dd> 731 </dd>
720 </dl> 732 </dl>
721 <a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a> 733 <a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a>
722 <h4>Hg.__monitorRepoIniFile</h4> 734 <h4>Hg.__monitorRepoIniFile</h4>
723 <b>__monitorRepoIniFile</b>(<i>repodir</i>) 735 <b>__monitorRepoIniFile</b>(<i>repodir</i>)
748 Protected method to create an instance of the VCS status monitor 760 Protected method to create an instance of the VCS status monitor
749 thread. 761 thread.
750 </p> 762 </p>
751 <dl> 763 <dl>
752 764
753 <dt><i>interval</i></dt> 765 <dt><i>interval</i> (int)</dt>
754 <dd> 766 <dd>
755 check interval for the monitor thread in seconds 767 check interval for the monitor thread in seconds
756 (integer) 768 </dd>
757 </dd> 769 <dt><i>project</i> (Project)</dt>
758 <dt><i>project</i></dt> 770 <dd>
759 <dd> 771 reference to the project object
760 reference to the project object (Project) 772 </dd>
761 </dd> 773 </dl>
762 </dl> 774 <dl>
763 <dl> 775 <dt>Return:</dt>
764 <dt>Return:</dt> 776 <dd>
765 <dd> 777 reference to the monitor thread
766 reference to the monitor thread (QThread) 778 </dd>
779 </dl>
780 <dl>
781 <dt>Return Type:</dt>
782 <dd>
783 HgStatusMonitorThread
767 </dd> 784 </dd>
768 </dl> 785 </dl>
769 <a NAME="Hg.canCommitMerge" ID="Hg.canCommitMerge"></a> 786 <a NAME="Hg.canCommitMerge" ID="Hg.canCommitMerge"></a>
770 <h4>Hg.canCommitMerge</h4> 787 <h4>Hg.canCommitMerge</h4>
771 <b>canCommitMerge</b>(<i></i>) 788 <b>canCommitMerge</b>(<i></i>)
794 Public method to check, if pull is possible. 811 Public method to check, if pull is possible.
795 </p> 812 </p>
796 <dl> 813 <dl>
797 <dt>Return:</dt> 814 <dt>Return:</dt>
798 <dd> 815 <dd>
799 flag indicating pull capability (boolean) 816 flag indicating pull capability
817 </dd>
818 </dl>
819 <dl>
820 <dt>Return Type:</dt>
821 <dd>
822 bool
800 </dd> 823 </dd>
801 </dl> 824 </dl>
802 <a NAME="Hg.canPush" ID="Hg.canPush"></a> 825 <a NAME="Hg.canPush" ID="Hg.canPush"></a>
803 <h4>Hg.canPush</h4> 826 <h4>Hg.canPush</h4>
804 <b>canPush</b>(<i></i>) 827 <b>canPush</b>(<i></i>)
807 Public method to check, if push is possible. 830 Public method to check, if push is possible.
808 </p> 831 </p>
809 <dl> 832 <dl>
810 <dt>Return:</dt> 833 <dt>Return:</dt>
811 <dd> 834 <dd>
812 flag indicating push capability (boolean) 835 flag indicating push capability
836 </dd>
837 </dl>
838 <dl>
839 <dt>Return Type:</dt>
840 <dd>
841 bool
813 </dd> 842 </dd>
814 </dl> 843 </dl>
815 <a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a> 844 <a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a>
816 <h4>Hg.clearStatusCache</h4> 845 <h4>Hg.clearStatusCache</h4>
817 <b>clearStatusCache</b>(<i></i>) 846 <b>clearStatusCache</b>(<i></i>)
827 Public method to get a reference to the command server interface. 856 Public method to get a reference to the command server interface.
828 </p> 857 </p>
829 <dl> 858 <dl>
830 <dt>Return:</dt> 859 <dt>Return:</dt>
831 <dd> 860 <dd>
832 reference to the client (HgClient) 861 reference to the client
862 </dd>
863 </dl>
864 <dl>
865 <dt>Return Type:</dt>
866 <dd>
867 HgClient
833 </dd> 868 </dd>
834 </dl> 869 </dl>
835 <a NAME="Hg.getEncoding" ID="Hg.getEncoding"></a> 870 <a NAME="Hg.getEncoding" ID="Hg.getEncoding"></a>
836 <h4>Hg.getEncoding</h4> 871 <h4>Hg.getEncoding</h4>
837 <b>getEncoding</b>(<i></i>) 872 <b>getEncoding</b>(<i></i>)
840 Public method to get the encoding to be used by Mercurial. 875 Public method to get the encoding to be used by Mercurial.
841 </p> 876 </p>
842 <dl> 877 <dl>
843 <dt>Return:</dt> 878 <dt>Return:</dt>
844 <dd> 879 <dd>
845 encoding (string) 880 encoding
881 </dd>
882 </dl>
883 <dl>
884 <dt>Return Type:</dt>
885 <dd>
886 str
846 </dd> 887 </dd>
847 </dl> 888 </dl>
848 <a NAME="Hg.getExtensionObject" ID="Hg.getExtensionObject"></a> 889 <a NAME="Hg.getExtensionObject" ID="Hg.getExtensionObject"></a>
849 <h4>Hg.getExtensionObject</h4> 890 <h4>Hg.getExtensionObject</h4>
850 <b>getExtensionObject</b>(<i>extensionName</i>) 891 <b>getExtensionObject</b>(<i>extensionName</i>)
852 <p> 893 <p>
853 Public method to get a reference to an extension object. 894 Public method to get a reference to an extension object.
854 </p> 895 </p>
855 <dl> 896 <dl>
856 897
857 <dt><i>extensionName</i></dt> 898 <dt><i>extensionName</i> (str)</dt>
858 <dd> 899 <dd>
859 name of the extension (string) 900 name of the extension
860 </dd> 901 </dd>
861 </dl> 902 </dl>
862 <dl> 903 <dl>
863 <dt>Return:</dt> 904 <dt>Return:</dt>
864 <dd> 905 <dd>
865 reference to the extension object (boolean) 906 reference to the extension object
907 </dd>
908 </dl>
909 <dl>
910 <dt>Return Type:</dt>
911 <dd>
912 bool
866 </dd> 913 </dd>
867 </dl> 914 </dl>
868 <a NAME="Hg.getHgSubPath" ID="Hg.getHgSubPath"></a> 915 <a NAME="Hg.getHgSubPath" ID="Hg.getHgSubPath"></a>
869 <h4>Hg.getHgSubPath</h4> 916 <h4>Hg.getHgSubPath</h4>
870 <b>getHgSubPath</b>(<i></i>) 917 <b>getHgSubPath</b>(<i></i>)
874 definitions of sub-repositories. 921 definitions of sub-repositories.
875 </p> 922 </p>
876 <dl> 923 <dl>
877 <dt>Return:</dt> 924 <dt>Return:</dt>
878 <dd> 925 <dd>
879 full path of the .hgsub file (string) 926 full path of the .hgsub file
927 </dd>
928 </dl>
929 <dl>
930 <dt>Return Type:</dt>
931 <dd>
932 str
880 </dd> 933 </dd>
881 </dl> 934 </dl>
882 <a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a> 935 <a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a>
883 <h4>Hg.getPlugin</h4> 936 <h4>Hg.getPlugin</h4>
884 <b>getPlugin</b>(<i></i>) 937 <b>getPlugin</b>(<i></i>)
887 Public method to get a reference to the plugin object. 940 Public method to get a reference to the plugin object.
888 </p> 941 </p>
889 <dl> 942 <dl>
890 <dt>Return:</dt> 943 <dt>Return:</dt>
891 <dd> 944 <dd>
892 reference to the plugin object (VcsMercurialPlugin) 945 reference to the plugin object
946 </dd>
947 </dl>
948 <dl>
949 <dt>Return Type:</dt>
950 <dd>
951 VcsMercurialPlugin
893 </dd> 952 </dd>
894 </dl> 953 </dl>
895 <a NAME="Hg.hasSubrepositories" ID="Hg.hasSubrepositories"></a> 954 <a NAME="Hg.hasSubrepositories" ID="Hg.hasSubrepositories"></a>
896 <h4>Hg.hasSubrepositories</h4> 955 <h4>Hg.hasSubrepositories</h4>
897 <b>hasSubrepositories</b>(<i></i>) 956 <b>hasSubrepositories</b>(<i></i>)
900 Public method to check, if the project might have sub-repositories. 959 Public method to check, if the project might have sub-repositories.
901 </p> 960 </p>
902 <dl> 961 <dl>
903 <dt>Return:</dt> 962 <dt>Return:</dt>
904 <dd> 963 <dd>
905 flag indicating the existence of sub-repositories (boolean) 964 flag indicating the existence of sub-repositories
965 </dd>
966 </dl>
967 <dl>
968 <dt>Return Type:</dt>
969 <dd>
970 bool
906 </dd> 971 </dd>
907 </dl> 972 </dl>
908 <a NAME="Hg.hgAbortMerge" ID="Hg.hgAbortMerge"></a> 973 <a NAME="Hg.hgAbortMerge" ID="Hg.hgAbortMerge"></a>
909 <h4>Hg.hgAbortMerge</h4> 974 <h4>Hg.hgAbortMerge</h4>
910 <b>hgAbortMerge</b>(<i></i>) 975 <b>hgAbortMerge</b>(<i></i>)
913 Public method to abort an uncommitted merge. 978 Public method to abort an uncommitted merge.
914 </p> 979 </p>
915 <dl> 980 <dl>
916 <dt>Return:</dt> 981 <dt>Return:</dt>
917 <dd> 982 <dd>
918 flag indicating, that the abortion contained an add 983 flag indicating, that the abortion contained an add or delete
919 or delete (boolean) 984 </dd>
985 </dl>
986 <dl>
987 <dt>Return Type:</dt>
988 <dd>
989 bool
920 </dd> 990 </dd>
921 </dl> 991 </dl>
922 <a NAME="Hg.hgAddSubrepository" ID="Hg.hgAddSubrepository"></a> 992 <a NAME="Hg.hgAddSubrepository" ID="Hg.hgAddSubrepository"></a>
923 <h4>Hg.hgAddSubrepository</h4> 993 <h4>Hg.hgAddSubrepository</h4>
924 <b>hgAddSubrepository</b>(<i></i>) 994 <b>hgAddSubrepository</b>(<i></i>)
988 <p> 1058 <p>
989 Public method to define a bookmark. 1059 Public method to define a bookmark.
990 </p> 1060 </p>
991 <dl> 1061 <dl>
992 1062
993 <dt><i>revision</i></dt> 1063 <dt><i>revision</i> (str)</dt>
994 <dd> 1064 <dd>
995 revision to set bookmark for (string) 1065 revision to set bookmark for
996 </dd> 1066 </dd>
997 <dt><i>bookmark</i></dt> 1067 <dt><i>bookmark</i> (str)</dt>
998 <dd> 1068 <dd>
999 name of the bookmark (string) 1069 name of the bookmark
1000 </dd> 1070 </dd>
1001 </dl> 1071 </dl>
1002 <a NAME="Hg.hgBookmarkDelete" ID="Hg.hgBookmarkDelete"></a> 1072 <a NAME="Hg.hgBookmarkDelete" ID="Hg.hgBookmarkDelete"></a>
1003 <h4>Hg.hgBookmarkDelete</h4> 1073 <h4>Hg.hgBookmarkDelete</h4>
1004 <b>hgBookmarkDelete</b>(<i>bookmark=None</i>) 1074 <b>hgBookmarkDelete</b>(<i>bookmark=None</i>)
1006 <p> 1076 <p>
1007 Public method to delete a bookmark. 1077 Public method to delete a bookmark.
1008 </p> 1078 </p>
1009 <dl> 1079 <dl>
1010 1080
1011 <dt><i>bookmark</i></dt> 1081 <dt><i>bookmark</i> (str)</dt>
1012 <dd> 1082 <dd>
1013 name of the bookmark (string) 1083 name of the bookmark
1014 </dd> 1084 </dd>
1015 </dl> 1085 </dl>
1016 <a NAME="Hg.hgBookmarkIncoming" ID="Hg.hgBookmarkIncoming"></a> 1086 <a NAME="Hg.hgBookmarkIncoming" ID="Hg.hgBookmarkIncoming"></a>
1017 <h4>Hg.hgBookmarkIncoming</h4> 1087 <h4>Hg.hgBookmarkIncoming</h4>
1018 <b>hgBookmarkIncoming</b>(<i></i>) 1088 <b>hgBookmarkIncoming</b>(<i></i>)
1027 <p> 1097 <p>
1028 Public method to move a bookmark. 1098 Public method to move a bookmark.
1029 </p> 1099 </p>
1030 <dl> 1100 <dl>
1031 1101
1032 <dt><i>revision</i></dt> 1102 <dt><i>revision</i> (str)</dt>
1033 <dd> 1103 <dd>
1034 revision to set bookmark for (string) 1104 revision to set bookmark for
1035 </dd> 1105 </dd>
1036 <dt><i>bookmark</i></dt> 1106 <dt><i>bookmark</i> (str)</dt>
1037 <dd> 1107 <dd>
1038 name of the bookmark (string) 1108 name of the bookmark
1039 </dd> 1109 </dd>
1040 </dl> 1110 </dl>
1041 <a NAME="Hg.hgBookmarkOutgoing" ID="Hg.hgBookmarkOutgoing"></a> 1111 <a NAME="Hg.hgBookmarkOutgoing" ID="Hg.hgBookmarkOutgoing"></a>
1042 <h4>Hg.hgBookmarkOutgoing</h4> 1112 <h4>Hg.hgBookmarkOutgoing</h4>
1043 <b>hgBookmarkOutgoing</b>(<i></i>) 1113 <b>hgBookmarkOutgoing</b>(<i></i>)
1134 <p> 1204 <p>
1135 Public method used to copy a file/directory. 1205 Public method used to copy a file/directory.
1136 </p> 1206 </p>
1137 <dl> 1207 <dl>
1138 1208
1139 <dt><i>name</i></dt> 1209 <dt><i>name</i> (str)</dt>
1140 <dd> 1210 <dd>
1141 file/directory name to be copied (string) 1211 file/directory name to be copied
1142 </dd> 1212 </dd>
1143 <dt><i>project</i></dt> 1213 <dt><i>project</i> (Project)</dt>
1144 <dd> 1214 <dd>
1145 reference to the project object 1215 reference to the project object
1146 </dd> 1216 </dd>
1147 </dl> 1217 </dl>
1148 <dl> 1218 <dl>
1149 <dt>Return:</dt> 1219 <dt>Return:</dt>
1150 <dd> 1220 <dd>
1151 flag indicating successful operation (boolean) 1221 flag indicating successful operation
1222 </dd>
1223 </dl>
1224 <dl>
1225 <dt>Return Type:</dt>
1226 <dd>
1227 bool
1152 </dd> 1228 </dd>
1153 </dl> 1229 </dl>
1154 <a NAME="Hg.hgCreateIgnoreFile" ID="Hg.hgCreateIgnoreFile"></a> 1230 <a NAME="Hg.hgCreateIgnoreFile" ID="Hg.hgCreateIgnoreFile"></a>
1155 <h4>Hg.hgCreateIgnoreFile</h4> 1231 <h4>Hg.hgCreateIgnoreFile</h4>
1156 <b>hgCreateIgnoreFile</b>(<i>name, autoAdd=False</i>) 1232 <b>hgCreateIgnoreFile</b>(<i>name, autoAdd=False</i>)
1158 <p> 1234 <p>
1159 Public method to create the ignore file. 1235 Public method to create the ignore file.
1160 </p> 1236 </p>
1161 <dl> 1237 <dl>
1162 1238
1163 <dt><i>name</i></dt> 1239 <dt><i>name</i> (str)</dt>
1164 <dd> 1240 <dd>
1165 directory name to create the ignore file in (string) 1241 directory name to create the ignore file in
1166 </dd> 1242 </dd>
1167 <dt><i>autoAdd</i></dt> 1243 <dt><i>autoAdd</i> (bool)</dt>
1168 <dd> 1244 <dd>
1169 flag indicating to add it automatically (boolean) 1245 flag indicating to add it automatically
1170 </dd> 1246 </dd>
1171 </dl> 1247 </dl>
1172 <dl> 1248 <dl>
1173 <dt>Return:</dt> 1249 <dt>Return:</dt>
1174 <dd> 1250 <dd>
1175 flag indicating success 1251 flag indicating success
1252 </dd>
1253 </dl>
1254 <dl>
1255 <dt>Return Type:</dt>
1256 <dd>
1257 bool
1176 </dd> 1258 </dd>
1177 </dl> 1259 </dl>
1178 <a NAME="Hg.hgDeleteBackups" ID="Hg.hgDeleteBackups"></a> 1260 <a NAME="Hg.hgDeleteBackups" ID="Hg.hgDeleteBackups"></a>
1179 <h4>Hg.hgDeleteBackups</h4> 1261 <h4>Hg.hgDeleteBackups</h4>
1180 <b>hgDeleteBackups</b>(<i></i>) 1262 <b>hgDeleteBackups</b>(<i></i>)
1237 <p> 1319 <p>
1238 This method gives the chance to enter the revisions to be compared. 1320 This method gives the chance to enter the revisions to be compared.
1239 </p> 1321 </p>
1240 <dl> 1322 <dl>
1241 1323
1242 <dt><i>name</i></dt> 1324 <dt><i>name</i> (str)</dt>
1243 <dd> 1325 <dd>
1244 file/directory name to be diffed (string) 1326 file/directory name to be diffed
1245 </dd> 1327 </dd>
1246 </dl> 1328 </dl>
1247 <a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a> 1329 <a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a>
1248 <h4>Hg.hgGetBookmarksList</h4> 1330 <h4>Hg.hgGetBookmarksList</h4>
1249 <b>hgGetBookmarksList</b>(<i></i>) 1331 <b>hgGetBookmarksList</b>(<i></i>)
1252 Public method to get the list of bookmarks. 1334 Public method to get the list of bookmarks.
1253 </p> 1335 </p>
1254 <dl> 1336 <dl>
1255 <dt>Return:</dt> 1337 <dt>Return:</dt>
1256 <dd> 1338 <dd>
1257 list of bookmarks (list of string) 1339 list of bookmarks
1340 </dd>
1341 </dl>
1342 <dl>
1343 <dt>Return Type:</dt>
1344 <dd>
1345 list of str
1258 </dd> 1346 </dd>
1259 </dl> 1347 </dl>
1260 <a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a> 1348 <a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a>
1261 <h4>Hg.hgGetBranchesList</h4> 1349 <h4>Hg.hgGetBranchesList</h4>
1262 <b>hgGetBranchesList</b>(<i>withState=False, withDefault=False</i>) 1350 <b>hgGetBranchesList</b>(<i>withState=False, withDefault=False</i>)
1316 <p> 1404 <p>
1317 Public method to get the list of tags. 1405 Public method to get the list of tags.
1318 </p> 1406 </p>
1319 <dl> 1407 <dl>
1320 1408
1321 <dt><i>withType</i></dt> 1409 <dt><i>withType</i> (bool)</dt>
1322 <dd> 1410 <dd>
1323 flag indicating to get the tag type as well (boolean) 1411 flag indicating to get the tag type as well
1324 </dd> 1412 </dd>
1325 </dl> 1413 </dl>
1326 <dl> 1414 <dl>
1327 <dt>Return:</dt> 1415 <dt>Return:</dt>
1328 <dd> 1416 <dd>
1329 list of tags (list of string) or list of tuples of 1417 list of tags or list of tuples of tag name and flag indicating
1330 tag name and flag indicating a local tag (list of tuple of string 1418 a local tag, if withType is True
1331 and boolean), if withType is True 1419 </dd>
1420 </dl>
1421 <dl>
1422 <dt>Return Type:</dt>
1423 <dd>
1424 list of str or list of [(str, bool)]
1332 </dd> 1425 </dd>
1333 </dl> 1426 </dl>
1334 <a NAME="Hg.hgGraft" ID="Hg.hgGraft"></a> 1427 <a NAME="Hg.hgGraft" ID="Hg.hgGraft"></a>
1335 <h4>Hg.hgGraft</h4> 1428 <h4>Hg.hgGraft</h4>
1336 <b>hgGraft</b>(<i>revs=None</i>) 1429 <b>hgGraft</b>(<i>revs=None</i>)
1338 <p> 1431 <p>
1339 Public method to copy changesets from another branch. 1432 Public method to copy changesets from another branch.
1340 </p> 1433 </p>
1341 <dl> 1434 <dl>
1342 1435
1343 <dt><i>revs</i></dt> 1436 <dt><i>revs</i> (list of str)</dt>
1344 <dd> 1437 <dd>
1345 list of revisions to show in the revisions pane (list of 1438 list of revisions to show in the revisions pane
1346 strings) 1439 </dd>
1347 </dd> 1440 </dl>
1348 </dl> 1441 <dl>
1349 <dl> 1442 <dt>Return:</dt>
1350 <dt>Return:</dt> 1443 <dd>
1351 <dd> 1444 flag indicating that the project should be reread
1352 flag indicating that the project should be reread (boolean) 1445 </dd>
1446 </dl>
1447 <dl>
1448 <dt>Return Type:</dt>
1449 <dd>
1450 bool
1353 </dd> 1451 </dd>
1354 </dl> 1452 </dl>
1355 <a NAME="Hg.hgGraftAbort" ID="Hg.hgGraftAbort"></a> 1453 <a NAME="Hg.hgGraftAbort" ID="Hg.hgGraftAbort"></a>
1356 <h4>Hg.hgGraftAbort</h4> 1454 <h4>Hg.hgGraftAbort</h4>
1357 <b>hgGraftAbort</b>(<i></i>) 1455 <b>hgGraftAbort</b>(<i></i>)
1426 </p> 1524 </p>
1427 <dl> 1525 <dl>
1428 <dt>Return:</dt> 1526 <dt>Return:</dt>
1429 <dd> 1527 <dd>
1430 flag indicating, that the import contained an add, a delete 1528 flag indicating, that the import contained an add, a delete
1431 or a change to the project file (boolean) 1529 or a change to the project file
1530 </dd>
1531 </dl>
1532 <dl>
1533 <dt>Return Type:</dt>
1534 <dd>
1535 bool
1432 </dd> 1536 </dd>
1433 </dl> 1537 </dl>
1434 <a NAME="Hg.hgIncoming" ID="Hg.hgIncoming"></a> 1538 <a NAME="Hg.hgIncoming" ID="Hg.hgIncoming"></a>
1435 <h4>Hg.hgIncoming</h4> 1539 <h4>Hg.hgIncoming</h4>
1436 <b>hgIncoming</b>(<i></i>) 1540 <b>hgIncoming</b>(<i></i>)
1446 <p> 1550 <p>
1447 Public method to show information about the heads of the repository. 1551 Public method to show information about the heads of the repository.
1448 </p> 1552 </p>
1449 <dl> 1553 <dl>
1450 1554
1451 <dt><i>mode</i></dt> 1555 <dt><i>mode</i> (str)</dt>
1452 <dd> 1556 <dd>
1453 mode of the operation (string, one of heads, parents, 1557 mode of the operation (one of 'heads', 'parents', 'tip')
1454 tip)
1455 </dd> 1558 </dd>
1456 </dl> 1559 </dl>
1457 <a NAME="Hg.hgListBookmarks" ID="Hg.hgListBookmarks"></a> 1560 <a NAME="Hg.hgListBookmarks" ID="Hg.hgListBookmarks"></a>
1458 <h4>Hg.hgListBookmarks</h4> 1561 <h4>Hg.hgListBookmarks</h4>
1459 <b>hgListBookmarks</b>(<i></i>) 1562 <b>hgListBookmarks</b>(<i></i>)
1468 <p> 1571 <p>
1469 Public method used to list the available tags or branches. 1572 Public method used to list the available tags or branches.
1470 </p> 1573 </p>
1471 <dl> 1574 <dl>
1472 1575
1473 <dt><i>tags</i></dt> 1576 <dt><i>tags</i> (bool)</dt>
1474 <dd> 1577 <dd>
1475 flag indicating listing of branches or tags 1578 flag indicating listing of branches or tags
1476 (False = branches, True = tags) 1579 (False = branches, True = tags)
1477 </dd> 1580 </dd>
1478 </dl> 1581 </dl>
1479 <a NAME="Hg.hgNormalizeURL" ID="Hg.hgNormalizeURL"></a> 1582 <a NAME="Hg.hgNormalizeURL" ID="Hg.hgNormalizeURL"></a>
1480 <h4>Hg.hgNormalizeURL</h4> 1583 <h4>Hg.hgNormalizeURL</h4>
1481 <b>hgNormalizeURL</b>(<i>url</i>) 1584 <b>hgNormalizeURL</b>(<i>url</i>)
1483 <p> 1586 <p>
1484 Public method to normalize a url for Mercurial. 1587 Public method to normalize a url for Mercurial.
1485 </p> 1588 </p>
1486 <dl> 1589 <dl>
1487 1590
1488 <dt><i>url</i></dt> 1591 <dt><i>url</i> (str)</dt>
1489 <dd> 1592 <dd>
1490 url string (string) 1593 url string
1491 </dd> 1594 </dd>
1492 </dl> 1595 </dl>
1493 <dl> 1596 <dl>
1494 <dt>Return:</dt> 1597 <dt>Return:</dt>
1495 <dd> 1598 <dd>
1496 properly normalized url for mercurial (string) 1599 properly normalized url for mercurial
1600 </dd>
1601 </dl>
1602 <dl>
1603 <dt>Return Type:</dt>
1604 <dd>
1605 str
1497 </dd> 1606 </dd>
1498 </dl> 1607 </dl>
1499 <a NAME="Hg.hgOutgoing" ID="Hg.hgOutgoing"></a> 1608 <a NAME="Hg.hgOutgoing" ID="Hg.hgOutgoing"></a>
1500 <h4>Hg.hgOutgoing</h4> 1609 <h4>Hg.hgOutgoing</h4>
1501 <b>hgOutgoing</b>(<i></i>) 1610 <b>hgOutgoing</b>(<i></i>)
1511 <p> 1620 <p>
1512 Public method to change the phase of revisions. 1621 Public method to change the phase of revisions.
1513 </p> 1622 </p>
1514 <dl> 1623 <dl>
1515 1624
1516 <dt><i>data</i></dt> 1625 <dt><i>data</i> (tuple of (list of str, str, bool))</dt>
1517 <dd> 1626 <dd>
1518 tuple giving phase data (list of revisions, phase, flag 1627 tuple giving phase data (list of revisions, phase, flag
1519 indicating a forced operation) (list of strings, string, boolean) 1628 indicating a forced operation)
1520 </dd> 1629 </dd>
1521 </dl> 1630 </dl>
1522 <dl> 1631 <dl>
1523 <dt>Return:</dt> 1632 <dt>Return:</dt>
1524 <dd> 1633 <dd>
1525 flag indicating success (boolean) 1634 flag indicating success
1635 </dd>
1636 </dl>
1637 <dl>
1638 <dt>Return Type:</dt>
1639 <dd>
1640 bool
1526 </dd> 1641 </dd>
1527 </dl> 1642 </dl>
1528 <dl> 1643 <dl>
1529 1644
1530 <dt>Raises <b>ValueError</b>:</dt> 1645 <dt>Raises <b>ValueError</b>:</dt>
1574 <p> 1689 <p>
1575 Public method used to push changes to a remote Mercurial repository. 1690 Public method used to push changes to a remote Mercurial repository.
1576 </p> 1691 </p>
1577 <dl> 1692 <dl>
1578 1693
1579 <dt><i>force</i></dt> 1694 <dt><i>force</i> (bool)</dt>
1580 <dd> 1695 <dd>
1581 flag indicating a forced push (boolean) 1696 flag indicating a forced push
1582 </dd> 1697 </dd>
1583 <dt><i>newBranch</i></dt> 1698 <dt><i>newBranch</i> (bool)</dt>
1584 <dd> 1699 <dd>
1585 flag indicating to push a new branch (boolean) 1700 flag indicating to push a new branch
1586 </dd> 1701 </dd>
1587 <dt><i>rev</i></dt> 1702 <dt><i>rev</i> (str)</dt>
1588 <dd> 1703 <dd>
1589 revision to be pushed (including all ancestors) (string) 1704 revision to be pushed (including all ancestors)
1590 </dd> 1705 </dd>
1591 </dl> 1706 </dl>
1592 <a NAME="Hg.hgReMerge" ID="Hg.hgReMerge"></a> 1707 <a NAME="Hg.hgReMerge" ID="Hg.hgReMerge"></a>
1593 <h4>Hg.hgReMerge</h4> 1708 <h4>Hg.hgReMerge</h4>
1594 <b>hgReMerge</b>(<i>name</i>) 1709 <b>hgReMerge</b>(<i>name</i>)
1596 <p> 1711 <p>
1597 Public method used to merge a URL/revision into the local project. 1712 Public method used to merge a URL/revision into the local project.
1598 </p> 1713 </p>
1599 <dl> 1714 <dl>
1600 1715
1601 <dt><i>name</i></dt> 1716 <dt><i>name</i> (str)</dt>
1602 <dd> 1717 <dd>
1603 file/directory name to be merged (string) 1718 file/directory name to be merged
1604 </dd> 1719 </dd>
1605 </dl> 1720 </dl>
1606 <a NAME="Hg.hgRecover" ID="Hg.hgRecover"></a> 1721 <a NAME="Hg.hgRecover" ID="Hg.hgRecover"></a>
1607 <h4>Hg.hgRecover</h4> 1722 <h4>Hg.hgRecover</h4>
1608 <b>hgRecover</b>(<i></i>) 1723 <b>hgRecover</b>(<i></i>)
1667 Public method used to show some summary information of the 1782 Public method used to show some summary information of the
1668 working directory state. 1783 working directory state.
1669 </p> 1784 </p>
1670 <dl> 1785 <dl>
1671 1786
1672 <dt><i>mq</i></dt> 1787 <dt><i>mq</i> (bool)</dt>
1673 <dd> 1788 <dd>
1674 flag indicating to show the queue status as well (boolean) 1789 flag indicating to show the queue status as well
1675 </dd> 1790 </dd>
1676 <dt><i>largefiles</i></dt> 1791 <dt><i>largefiles</i> (bool)</dt>
1677 <dd> 1792 <dd>
1678 flag indicating to show the largefiles status as 1793 flag indicating to show the largefiles status as
1679 well (boolean) 1794 well
1680 </dd> 1795 </dd>
1681 </dl> 1796 </dl>
1682 <a NAME="Hg.hgUnbundle" ID="Hg.hgUnbundle"></a> 1797 <a NAME="Hg.hgUnbundle" ID="Hg.hgUnbundle"></a>
1683 <h4>Hg.hgUnbundle</h4> 1798 <h4>Hg.hgUnbundle</h4>
1684 <b>hgUnbundle</b>(<i>files=None</i>) 1799 <b>hgUnbundle</b>(<i>files=None</i>)
1720 <p> 1835 <p>
1721 Public method to initialize a command arguments list. 1836 Public method to initialize a command arguments list.
1722 </p> 1837 </p>
1723 <dl> 1838 <dl>
1724 1839
1725 <dt><i>command</i></dt> 1840 <dt><i>command</i> (str)</dt>
1726 <dd> 1841 <dd>
1727 command name (string) 1842 command name
1728 </dd> 1843 </dd>
1729 </dl> 1844 </dl>
1730 <dl> 1845 <dl>
1731 <dt>Return:</dt> 1846 <dt>Return:</dt>
1732 <dd> 1847 <dd>
1733 list of command options (list of string) 1848 list of command options
1849 </dd>
1850 </dl>
1851 <dl>
1852 <dt>Return Type:</dt>
1853 <dd>
1854 list of str
1734 </dd> 1855 </dd>
1735 </dl> 1856 </dl>
1736 <a NAME="Hg.isExtensionActive" ID="Hg.isExtensionActive"></a> 1857 <a NAME="Hg.isExtensionActive" ID="Hg.isExtensionActive"></a>
1737 <h4>Hg.isExtensionActive</h4> 1858 <h4>Hg.isExtensionActive</h4>
1738 <b>isExtensionActive</b>(<i>extensionName</i>) 1859 <b>isExtensionActive</b>(<i>extensionName</i>)
1740 <p> 1861 <p>
1741 Public method to check, if an extension is active. 1862 Public method to check, if an extension is active.
1742 </p> 1863 </p>
1743 <dl> 1864 <dl>
1744 1865
1745 <dt><i>extensionName</i></dt> 1866 <dt><i>extensionName</i> (str)</dt>
1746 <dd> 1867 <dd>
1747 name of the extension to check for (string) 1868 name of the extension to check for
1748 </dd> 1869 </dd>
1749 </dl> 1870 </dl>
1750 <dl> 1871 <dl>
1751 <dt>Return:</dt> 1872 <dt>Return:</dt>
1752 <dd> 1873 <dd>
1753 flag indicating an active extension (boolean) 1874 flag indicating an active extension
1875 </dd>
1876 </dl>
1877 <dl>
1878 <dt>Return Type:</dt>
1879 <dd>
1880 bool
1754 </dd> 1881 </dd>
1755 </dl> 1882 </dl>
1756 <a NAME="Hg.stopClient" ID="Hg.stopClient"></a> 1883 <a NAME="Hg.stopClient" ID="Hg.stopClient"></a>
1757 <h4>Hg.stopClient</h4> 1884 <h4>Hg.stopClient</h4>
1758 <b>stopClient</b>(<i></i>) 1885 <b>stopClient</b>(<i></i>)
1767 <p> 1894 <p>
1768 Public method used to add a file/directory to the Mercurial repository. 1895 Public method used to add a file/directory to the Mercurial repository.
1769 </p> 1896 </p>
1770 <dl> 1897 <dl>
1771 1898
1772 <dt><i>name</i></dt> 1899 <dt><i>name</i> (str)</dt>
1773 <dd> 1900 <dd>
1774 file/directory name to be added (string) 1901 file/directory name to be added
1775 </dd> 1902 </dd>
1776 <dt><i>isDir</i></dt> 1903 <dt><i>isDir</i> (bool)</dt>
1777 <dd> 1904 <dd>
1778 flag indicating name is a directory (boolean) 1905 flag indicating name is a directory
1779 </dd> 1906 </dd>
1780 <dt><i>noDialog</i></dt> 1907 <dt><i>noDialog</i> (bool)</dt>
1781 <dd> 1908 <dd>
1782 flag indicating quiet operations 1909 flag indicating quiet operations
1783 </dd> 1910 </dd>
1784 </dl> 1911 </dl>
1785 <a NAME="Hg.vcsAddBinary" ID="Hg.vcsAddBinary"></a> 1912 <a NAME="Hg.vcsAddBinary" ID="Hg.vcsAddBinary"></a>
1790 Public method used to add a file/directory in binary mode to the 1917 Public method used to add a file/directory in binary mode to the
1791 Mercurial repository. 1918 Mercurial repository.
1792 </p> 1919 </p>
1793 <dl> 1920 <dl>
1794 1921
1795 <dt><i>name</i></dt> 1922 <dt><i>name</i> (str)</dt>
1796 <dd> 1923 <dd>
1797 file/directory name to be added (string) 1924 file/directory name to be added
1798 </dd> 1925 </dd>
1799 <dt><i>isDir</i></dt> 1926 <dt><i>isDir</i> (bool)</dt>
1800 <dd> 1927 <dd>
1801 flag indicating name is a directory (boolean) 1928 flag indicating name is a directory
1802 </dd> 1929 </dd>
1803 </dl> 1930 </dl>
1804 <a NAME="Hg.vcsAddCommitMessage" ID="Hg.vcsAddCommitMessage"></a> 1931 <a NAME="Hg.vcsAddCommitMessage" ID="Hg.vcsAddCommitMessage"></a>
1805 <h4>Hg.vcsAddCommitMessage</h4> 1932 <h4>Hg.vcsAddCommitMessage</h4>
1806 <b>vcsAddCommitMessage</b>(<i>message</i>) 1933 <b>vcsAddCommitMessage</b>(<i>message</i>)
1823 Public method to add a directory tree rooted at path to the Mercurial 1950 Public method to add a directory tree rooted at path to the Mercurial
1824 repository. 1951 repository.
1825 </p> 1952 </p>
1826 <dl> 1953 <dl>
1827 1954
1828 <dt><i>path</i></dt> 1955 <dt><i>path</i> (str or list of str)</dt>
1829 <dd> 1956 <dd>
1830 root directory of the tree to be added (string or list of 1957 root directory of the tree to be added
1831 strings))
1832 </dd> 1958 </dd>
1833 </dl> 1959 </dl>
1834 <a NAME="Hg.vcsAllRegisteredStates" ID="Hg.vcsAllRegisteredStates"></a> 1960 <a NAME="Hg.vcsAllRegisteredStates" ID="Hg.vcsAllRegisteredStates"></a>
1835 <h4>Hg.vcsAllRegisteredStates</h4> 1961 <h4>Hg.vcsAllRegisteredStates</h4>
1836 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) 1962 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>)
1844 if the named directory has been scanned already. If so, it is assumed, 1970 if the named directory has been scanned already. If so, it is assumed,
1845 that the states for all files have been populated by the previous run. 1971 that the states for all files have been populated by the previous run.
1846 </p> 1972 </p>
1847 <dl> 1973 <dl>
1848 1974
1849 <dt><i>names</i></dt> 1975 <dt><i>names</i> (dict)</dt>
1850 <dd> 1976 <dd>
1851 dictionary with all filenames to be checked as keys 1977 dictionary with all filenames to be checked as keys
1852 </dd> 1978 </dd>
1853 <dt><i>dname</i></dt> 1979 <dt><i>dname</i> (str)</dt>
1854 <dd> 1980 <dd>
1855 directory to check in (string) 1981 directory to check in
1856 </dd> 1982 </dd>
1857 <dt><i>shortcut</i></dt> 1983 <dt><i>shortcut</i> (bool)</dt>
1858 <dd> 1984 <dd>
1859 flag indicating a shortcut should be taken (boolean) 1985 flag indicating a shortcut should be taken
1860 </dd> 1986 </dd>
1861 </dl> 1987 </dl>
1862 <dl> 1988 <dl>
1863 <dt>Return:</dt> 1989 <dt>Return:</dt>
1864 <dd> 1990 <dd>
1865 the received dictionary completed with a combination of 1991 the received dictionary completed with a combination of
1866 canBeCommited and canBeAdded or None in order to signal an error 1992 canBeCommited and canBeAdded or None in order to signal an error
1993 </dd>
1994 </dl>
1995 <dl>
1996 <dt>Return Type:</dt>
1997 <dd>
1998 dict
1867 </dd> 1999 </dd>
1868 </dl> 2000 </dl>
1869 <a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a> 2001 <a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a>
1870 <h4>Hg.vcsCheckout</h4> 2002 <h4>Hg.vcsCheckout</h4>
1871 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) 2003 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
1874 Public method used to check the project out of a Mercurial repository 2006 Public method used to check the project out of a Mercurial repository
1875 (clone). 2007 (clone).
1876 </p> 2008 </p>
1877 <dl> 2009 <dl>
1878 2010
1879 <dt><i>vcsDataDict</i></dt> 2011 <dt><i>vcsDataDict</i> (dict)</dt>
1880 <dd> 2012 <dd>
1881 dictionary of data required for the checkout 2013 dictionary of data required for the checkout
1882 </dd> 2014 </dd>
1883 <dt><i>projectDir</i></dt> 2015 <dt><i>projectDir</i> (str)</dt>
1884 <dd> 2016 <dd>
1885 project directory to create (string) 2017 project directory to create
1886 </dd> 2018 </dd>
1887 <dt><i>noDialog</i></dt> 2019 <dt><i>noDialog</i> (bool)</dt>
1888 <dd> 2020 <dd>
1889 flag indicating quiet operations 2021 flag indicating quiet operations
1890 </dd> 2022 </dd>
1891 </dl> 2023 </dl>
1892 <dl> 2024 <dl>
1893 <dt>Return:</dt> 2025 <dt>Return:</dt>
1894 <dd> 2026 <dd>
1895 flag indicating an execution without errors (boolean) 2027 flag indicating an execution without errors
2028 </dd>
2029 </dl>
2030 <dl>
2031 <dt>Return Type:</dt>
2032 <dd>
2033 bool
1896 </dd> 2034 </dd>
1897 </dl> 2035 </dl>
1898 <a NAME="Hg.vcsCleanup" ID="Hg.vcsCleanup"></a> 2036 <a NAME="Hg.vcsCleanup" ID="Hg.vcsCleanup"></a>
1899 <h4>Hg.vcsCleanup</h4> 2037 <h4>Hg.vcsCleanup</h4>
1900 <b>vcsCleanup</b>(<i>name</i>) 2038 <b>vcsCleanup</b>(<i>name</i>)
1902 <p> 2040 <p>
1903 Public method used to cleanup the working directory. 2041 Public method used to cleanup the working directory.
1904 </p> 2042 </p>
1905 <dl> 2043 <dl>
1906 2044
1907 <dt><i>name</i></dt> 2045 <dt><i>name</i> (str)</dt>
1908 <dd> 2046 <dd>
1909 directory name to be cleaned up (string) 2047 directory name to be cleaned up
1910 </dd> 2048 </dd>
1911 </dl> 2049 </dl>
1912 <a NAME="Hg.vcsClearCommitMessages" ID="Hg.vcsClearCommitMessages"></a> 2050 <a NAME="Hg.vcsClearCommitMessages" ID="Hg.vcsClearCommitMessages"></a>
1913 <h4>Hg.vcsClearCommitMessages</h4> 2051 <h4>Hg.vcsClearCommitMessages</h4>
1914 <b>vcsClearCommitMessages</b>(<i></i>) 2052 <b>vcsClearCommitMessages</b>(<i></i>)
1923 <p> 2061 <p>
1924 Public method used to execute arbitrary mercurial commands. 2062 Public method used to execute arbitrary mercurial commands.
1925 </p> 2063 </p>
1926 <dl> 2064 <dl>
1927 2065
1928 <dt><i>name</i></dt> 2066 <dt><i>name</i> (str)</dt>
1929 <dd> 2067 <dd>
1930 directory name of the working directory (string) 2068 directory name of the working directory
1931 </dd> 2069 </dd>
1932 </dl> 2070 </dl>
1933 <a NAME="Hg.vcsCommit" ID="Hg.vcsCommit"></a> 2071 <a NAME="Hg.vcsCommit" ID="Hg.vcsCommit"></a>
1934 <h4>Hg.vcsCommit</h4> 2072 <h4>Hg.vcsCommit</h4>
1935 <b>vcsCommit</b>(<i>name, message, noDialog=False, closeBranch=False, mq=False, merge=False</i>) 2073 <b>vcsCommit</b>(<i>name, message, noDialog=False, closeBranch=False, mq=False, merge=False</i>)
1938 Public method used to make the change of a file/directory permanent 2076 Public method used to make the change of a file/directory permanent
1939 in the Mercurial repository. 2077 in the Mercurial repository.
1940 </p> 2078 </p>
1941 <dl> 2079 <dl>
1942 2080
1943 <dt><i>name</i></dt> 2081 <dt><i>name</i> (str or list of str)</dt>
1944 <dd> 2082 <dd>
1945 file/directory name to be committed (string or list of 2083 file/directory name to be committed
1946 strings) 2084 </dd>
1947 </dd> 2085 <dt><i>message</i> (str)</dt>
1948 <dt><i>message</i></dt> 2086 <dd>
1949 <dd> 2087 message for this operation
1950 message for this operation (string) 2088 </dd>
1951 </dd> 2089 <dt><i>noDialog</i> (bool)</dt>
1952 <dt><i>noDialog</i></dt>
1953 <dd> 2090 <dd>
1954 flag indicating quiet operations 2091 flag indicating quiet operations
1955 </dd> 2092 </dd>
1956 <dt><i>closeBranch</i></dt> 2093 <dt><i>closeBranch</i> (bool)</dt>
1957 <dd> 2094 <dd>
1958 flag indicating a close branch commit (boolean) 2095 flag indicating a close branch commit
1959 </dd> 2096 </dd>
1960 <dt><i>mq</i></dt> 2097 <dt><i>mq</i> (bool)</dt>
1961 <dd> 2098 <dd>
1962 flag indicating a queue commit (boolean) 2099 flag indicating a queue commit
1963 </dd> 2100 </dd>
1964 <dt><i>merge</i></dt> 2101 <dt><i>merge</i> (bool)</dt>
1965 <dd> 2102 <dd>
1966 flag indicating a merge commit (boolean) 2103 flag indicating a merge commit
1967 </dd> 2104 </dd>
1968 </dl> 2105 </dl>
1969 <a NAME="Hg.vcsCommitMessages" ID="Hg.vcsCommitMessages"></a> 2106 <a NAME="Hg.vcsCommitMessages" ID="Hg.vcsCommitMessages"></a>
1970 <h4>Hg.vcsCommitMessages</h4> 2107 <h4>Hg.vcsCommitMessages</h4>
1971 <b>vcsCommitMessages</b>(<i></i>) 2108 <b>vcsCommitMessages</b>(<i></i>)
2022 being edited and has unsaved modification, they can be saved or the 2159 being edited and has unsaved modification, they can be saved or the
2023 operation may be aborted. 2160 operation may be aborted.
2024 </p> 2161 </p>
2025 <dl> 2162 <dl>
2026 2163
2027 <dt><i>name</i></dt> 2164 <dt><i>name</i> (str)</dt>
2028 <dd> 2165 <dd>
2029 file/directory name to be diffed (string) 2166 file/directory name to be diffed
2030 </dd> 2167 </dd>
2031 </dl> 2168 </dl>
2032 <a NAME="Hg.vcsExists" ID="Hg.vcsExists"></a> 2169 <a NAME="Hg.vcsExists" ID="Hg.vcsExists"></a>
2033 <h4>Hg.vcsExists</h4> 2170 <h4>Hg.vcsExists</h4>
2034 <b>vcsExists</b>(<i></i>) 2171 <b>vcsExists</b>(<i></i>)
2037 Public method used to test for the presence of the hg executable. 2174 Public method used to test for the presence of the hg executable.
2038 </p> 2175 </p>
2039 <dl> 2176 <dl>
2040 <dt>Return:</dt> 2177 <dt>Return:</dt>
2041 <dd> 2178 <dd>
2042 flag indicating the existence (boolean) and an error message 2179 flag indicating the existence and an error message
2043 (string) 2180 </dd>
2181 </dl>
2182 <dl>
2183 <dt>Return Type:</dt>
2184 <dd>
2185 tuple of (bool, str)
2044 </dd> 2186 </dd>
2045 </dl> 2187 </dl>
2046 <a NAME="Hg.vcsExport" ID="Hg.vcsExport"></a> 2188 <a NAME="Hg.vcsExport" ID="Hg.vcsExport"></a>
2047 <h4>Hg.vcsExport</h4> 2189 <h4>Hg.vcsExport</h4>
2048 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>) 2190 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
2050 <p> 2192 <p>
2051 Public method used to export a directory from the Mercurial repository. 2193 Public method used to export a directory from the Mercurial repository.
2052 </p> 2194 </p>
2053 <dl> 2195 <dl>
2054 2196
2055 <dt><i>vcsDataDict</i></dt> 2197 <dt><i>vcsDataDict</i> (dict)</dt>
2056 <dd> 2198 <dd>
2057 dictionary of data required for the checkout 2199 dictionary of data required for the checkout
2058 </dd> 2200 </dd>
2059 <dt><i>projectDir</i></dt> 2201 <dt><i>projectDir</i> (str)</dt>
2060 <dd> 2202 <dd>
2061 project directory to create (string) 2203 project directory to create
2062 </dd> 2204 </dd>
2063 </dl> 2205 </dl>
2064 <dl> 2206 <dl>
2065 <dt>Return:</dt> 2207 <dt>Return:</dt>
2066 <dd> 2208 <dd>
2067 flag indicating an execution without errors (boolean) 2209 flag indicating an execution without errors
2210 </dd>
2211 </dl>
2212 <dl>
2213 <dt>Return Type:</dt>
2214 <dd>
2215 bool
2068 </dd> 2216 </dd>
2069 </dl> 2217 </dl>
2070 <a NAME="Hg.vcsForget" ID="Hg.vcsForget"></a> 2218 <a NAME="Hg.vcsForget" ID="Hg.vcsForget"></a>
2071 <h4>Hg.vcsForget</h4> 2219 <h4>Hg.vcsForget</h4>
2072 <b>vcsForget</b>(<i>name</i>) 2220 <b>vcsForget</b>(<i>name</i>)
2092 Public method to instantiate a helper object for the different 2240 Public method to instantiate a helper object for the different
2093 project browsers. 2241 project browsers.
2094 </p> 2242 </p>
2095 <dl> 2243 <dl>
2096 2244
2097 <dt><i>browser</i></dt> 2245 <dt><i>browser</i> (ProjectBaseBrowser)</dt>
2098 <dd> 2246 <dd>
2099 reference to the project browser object 2247 reference to the project browser object
2100 </dd> 2248 </dd>
2101 <dt><i>project</i></dt> 2249 <dt><i>project</i> (Project)</dt>
2102 <dd> 2250 <dd>
2103 reference to the project object 2251 reference to the project object
2104 </dd> 2252 </dd>
2105 <dt><i>isTranslationsBrowser</i></dt> 2253 <dt><i>isTranslationsBrowser</i> (bool)</dt>
2106 <dd> 2254 <dd>
2107 flag indicating, the helper is requested 2255 flag indicating, the helper is requested
2108 for the translations browser (this needs some special treatment) 2256 for the translations browser (this needs some special treatment)
2109 </dd> 2257 </dd>
2110 </dl> 2258 </dl>
2111 <dl> 2259 <dl>
2112 <dt>Return:</dt> 2260 <dt>Return:</dt>
2113 <dd> 2261 <dd>
2114 the project browser helper object 2262 the project browser helper object
2263 </dd>
2264 </dl>
2265 <dl>
2266 <dt>Return Type:</dt>
2267 <dd>
2268 HgProjectBrowserHelper
2115 </dd> 2269 </dd>
2116 </dl> 2270 </dl>
2117 <a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a> 2271 <a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a>
2118 <h4>Hg.vcsGetProjectHelper</h4> 2272 <h4>Hg.vcsGetProjectHelper</h4>
2119 <b>vcsGetProjectHelper</b>(<i>project</i>) 2273 <b>vcsGetProjectHelper</b>(<i>project</i>)
2121 <p> 2275 <p>
2122 Public method to instantiate a helper object for the project. 2276 Public method to instantiate a helper object for the project.
2123 </p> 2277 </p>
2124 <dl> 2278 <dl>
2125 2279
2126 <dt><i>project</i></dt> 2280 <dt><i>project</i> (Project)</dt>
2127 <dd> 2281 <dd>
2128 reference to the project object 2282 reference to the project object
2129 </dd> 2283 </dd>
2130 </dl> 2284 </dl>
2131 <dl> 2285 <dl>
2132 <dt>Return:</dt> 2286 <dt>Return:</dt>
2133 <dd> 2287 <dd>
2134 the project helper object 2288 the project helper object
2289 </dd>
2290 </dl>
2291 <dl>
2292 <dt>Return Type:</dt>
2293 <dd>
2294 HgProjectHelper
2135 </dd> 2295 </dd>
2136 </dl> 2296 </dl>
2137 <a NAME="Hg.vcsImport" ID="Hg.vcsImport"></a> 2297 <a NAME="Hg.vcsImport" ID="Hg.vcsImport"></a>
2138 <h4>Hg.vcsImport</h4> 2298 <h4>Hg.vcsImport</h4>
2139 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>) 2299 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>)
2147 <dd> 2307 <dd>
2148 dictionary of data required for the import 2308 dictionary of data required for the import
2149 </dd> 2309 </dd>
2150 <dt><i>projectDir</i> (str)</dt> 2310 <dt><i>projectDir</i> (str)</dt>
2151 <dd> 2311 <dd>
2152 project directory (string) 2312 project directory
2153 </dd> 2313 </dd>
2154 <dt><i>noDialog</i> (bool)</dt> 2314 <dt><i>noDialog</i> (bool)</dt>
2155 <dd> 2315 <dd>
2156 flag indicating quiet operations 2316 flag indicating quiet operations
2157 </dd> 2317 </dd>
2185 Mercurial controlled project. Therefore we always return TRUE without 2345 Mercurial controlled project. Therefore we always return TRUE without
2186 doing anything. 2346 doing anything.
2187 </p> 2347 </p>
2188 <dl> 2348 <dl>
2189 2349
2190 <dt><i>vcsDir</i></dt> 2350 <dt><i>vcsDir</i> (str)</dt>
2191 <dd> 2351 <dd>
2192 name of the VCS directory (string) 2352 name of the VCS directory
2193 </dd> 2353 </dd>
2194 <dt><i>noDialog</i></dt> 2354 <dt><i>noDialog</i> (bool)</dt>
2195 <dd> 2355 <dd>
2196 flag indicating quiet operations (boolean) 2356 flag indicating quiet operations
2197 </dd> 2357 </dd>
2198 </dl> 2358 </dl>
2199 <dl> 2359 <dl>
2200 <dt>Return:</dt> 2360 <dt>Return:</dt>
2201 <dd> 2361 <dd>
2202 always TRUE 2362 always True
2363 </dd>
2364 </dl>
2365 <dl>
2366 <dt>Return Type:</dt>
2367 <dd>
2368 bool
2203 </dd> 2369 </dd>
2204 </dl> 2370 </dl>
2205 <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a> 2371 <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a>
2206 <h4>Hg.vcsInitConfig</h4> 2372 <h4>Hg.vcsInitConfig</h4>
2207 <b>vcsInitConfig</b>(<i>project</i>) 2373 <b>vcsInitConfig</b>(<i>project</i>)
2212 <p> 2378 <p>
2213 This method ensures, that an ignore file exists. 2379 This method ensures, that an ignore file exists.
2214 </p> 2380 </p>
2215 <dl> 2381 <dl>
2216 2382
2217 <dt><i>project</i></dt> 2383 <dt><i>project</i> (Project)</dt>
2218 <dd> 2384 <dd>
2219 reference to the project (Project) 2385 reference to the project
2220 </dd> 2386 </dd>
2221 </dl> 2387 </dl>
2222 <a NAME="Hg.vcsLogBrowser" ID="Hg.vcsLogBrowser"></a> 2388 <a NAME="Hg.vcsLogBrowser" ID="Hg.vcsLogBrowser"></a>
2223 <h4>Hg.vcsLogBrowser</h4> 2389 <h4>Hg.vcsLogBrowser</h4>
2224 <b>vcsLogBrowser</b>(<i>name=None, isFile=False</i>) 2390 <b>vcsLogBrowser</b>(<i>name=None, isFile=False</i>)
2227 Public method used to browse the log of a file/directory from the 2393 Public method used to browse the log of a file/directory from the
2228 Mercurial repository. 2394 Mercurial repository.
2229 </p> 2395 </p>
2230 <dl> 2396 <dl>
2231 2397
2232 <dt><i>name</i></dt> 2398 <dt><i>name</i> (str)</dt>
2233 <dd> 2399 <dd>
2234 file/directory name to show the log of (string) 2400 file/directory name to show the log of
2235 </dd> 2401 </dd>
2236 <dt><i>isFile</i></dt> 2402 <dt><i>isFile</i> (bool)</dt>
2237 <dd> 2403 <dd>
2238 flag indicating log for a file is to be shown 2404 flag indicating log for a file is to be shown
2239 (boolean)
2240 </dd> 2405 </dd>
2241 </dl> 2406 </dl>
2242 <a NAME="Hg.vcsMerge" ID="Hg.vcsMerge"></a> 2407 <a NAME="Hg.vcsMerge" ID="Hg.vcsMerge"></a>
2243 <h4>Hg.vcsMerge</h4> 2408 <h4>Hg.vcsMerge</h4>
2244 <b>vcsMerge</b>(<i>name, rev=""</i>) 2409 <b>vcsMerge</b>(<i>name, rev=""</i>)
2264 <p> 2429 <p>
2265 Public method used to move a file/directory. 2430 Public method used to move a file/directory.
2266 </p> 2431 </p>
2267 <dl> 2432 <dl>
2268 2433
2269 <dt><i>name</i></dt> 2434 <dt><i>name</i> (str)</dt>
2270 <dd> 2435 <dd>
2271 file/directory name to be moved (string) 2436 file/directory name to be moved
2272 </dd> 2437 </dd>
2273 <dt><i>project</i></dt> 2438 <dt><i>project</i> (Project)</dt>
2274 <dd> 2439 <dd>
2275 reference to the project object 2440 reference to the project object
2276 </dd> 2441 </dd>
2277 <dt><i>target</i></dt> 2442 <dt><i>target</i> (str)</dt>
2278 <dd> 2443 <dd>
2279 new name of the file/directory (string) 2444 new name of the file/directory
2280 </dd> 2445 </dd>
2281 <dt><i>noDialog</i></dt> 2446 <dt><i>noDialog</i> (bool)</dt>
2282 <dd> 2447 <dd>
2283 flag indicating quiet operations 2448 flag indicating quiet operations
2284 </dd> 2449 </dd>
2285 </dl> 2450 </dl>
2286 <dl> 2451 <dl>
2287 <dt>Return:</dt> 2452 <dt>Return:</dt>
2288 <dd> 2453 <dd>
2289 flag indicating successfull operation (boolean) 2454 flag indicating successfull operation
2455 </dd>
2456 </dl>
2457 <dl>
2458 <dt>Return Type:</dt>
2459 <dd>
2460 bool
2290 </dd> 2461 </dd>
2291 </dl> 2462 </dl>
2292 <a NAME="Hg.vcsName" ID="Hg.vcsName"></a> 2463 <a NAME="Hg.vcsName" ID="Hg.vcsName"></a>
2293 <h4>Hg.vcsName</h4> 2464 <h4>Hg.vcsName</h4>
2294 <b>vcsName</b>(<i></i>) 2465 <b>vcsName</b>(<i></i>)
2297 Public method returning the name of the vcs. 2468 Public method returning the name of the vcs.
2298 </p> 2469 </p>
2299 <dl> 2470 <dl>
2300 <dt>Return:</dt> 2471 <dt>Return:</dt>
2301 <dd> 2472 <dd>
2302 always 'Mercurial' (string) 2473 always 'Mercurial'
2474 </dd>
2475 </dl>
2476 <dl>
2477 <dt>Return Type:</dt>
2478 <dd>
2479 str
2303 </dd> 2480 </dd>
2304 </dl> 2481 </dl>
2305 <a NAME="Hg.vcsNewProjectOptionsDialog" ID="Hg.vcsNewProjectOptionsDialog"></a> 2482 <a NAME="Hg.vcsNewProjectOptionsDialog" ID="Hg.vcsNewProjectOptionsDialog"></a>
2306 <h4>Hg.vcsNewProjectOptionsDialog</h4> 2483 <h4>Hg.vcsNewProjectOptionsDialog</h4>
2307 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) 2484 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>)
2310 Public method to get a dialog to enter repository info for getting a 2487 Public method to get a dialog to enter repository info for getting a
2311 new project. 2488 new project.
2312 </p> 2489 </p>
2313 <dl> 2490 <dl>
2314 2491
2315 <dt><i>parent</i></dt> 2492 <dt><i>parent</i> (QWidget)</dt>
2316 <dd> 2493 <dd>
2317 parent widget (QWidget) 2494 parent widget
2318 </dd> 2495 </dd>
2319 </dl> 2496 </dl>
2320 <dl> 2497 <dl>
2321 <dt>Return:</dt> 2498 <dt>Return:</dt>
2322 <dd> 2499 <dd>
2323 reference to the instantiated options dialog 2500 reference to the instantiated options dialog
2324 (HgNewProjectOptionsDialog) 2501 </dd>
2502 </dl>
2503 <dl>
2504 <dt>Return Type:</dt>
2505 <dd>
2506 HgNewProjectOptionsDialog
2325 </dd> 2507 </dd>
2326 </dl> 2508 </dl>
2327 <a NAME="Hg.vcsOptionsDialog" ID="Hg.vcsOptionsDialog"></a> 2509 <a NAME="Hg.vcsOptionsDialog" ID="Hg.vcsOptionsDialog"></a>
2328 <h4>Hg.vcsOptionsDialog</h4> 2510 <h4>Hg.vcsOptionsDialog</h4>
2329 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) 2511 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>)
2331 <p> 2513 <p>
2332 Public method to get a dialog to enter repository info. 2514 Public method to get a dialog to enter repository info.
2333 </p> 2515 </p>
2334 <dl> 2516 <dl>
2335 2517
2336 <dt><i>project</i></dt> 2518 <dt><i>project</i> (Project)</dt>
2337 <dd> 2519 <dd>
2338 reference to the project object 2520 reference to the project object
2339 </dd> 2521 </dd>
2340 <dt><i>archive</i></dt> 2522 <dt><i>archive</i> (str)</dt>
2341 <dd> 2523 <dd>
2342 name of the project in the repository (string) 2524 name of the project in the repository
2343 </dd> 2525 </dd>
2344 <dt><i>editable</i></dt> 2526 <dt><i>editable</i> (bool)</dt>
2345 <dd> 2527 <dd>
2346 flag indicating that the project name is editable 2528 flag indicating that the project name is editable
2347 (boolean) 2529 </dd>
2348 </dd> 2530 <dt><i>parent</i> (QWidget)</dt>
2349 <dt><i>parent</i></dt> 2531 <dd>
2350 <dd> 2532 parent widget
2351 parent widget (QWidget) 2533 </dd>
2352 </dd> 2534 </dl>
2353 </dl> 2535 <dl>
2354 <dl> 2536 <dt>Return:</dt>
2355 <dt>Return:</dt> 2537 <dd>
2356 <dd> 2538 reference to the instantiated options dialog
2357 reference to the instantiated options dialog (HgOptionsDialog) 2539 </dd>
2540 </dl>
2541 <dl>
2542 <dt>Return Type:</dt>
2543 <dd>
2544 HgOptionsDialog
2358 </dd> 2545 </dd>
2359 </dl> 2546 </dl>
2360 <a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a> 2547 <a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a>
2361 <h4>Hg.vcsRegisteredState</h4> 2548 <h4>Hg.vcsRegisteredState</h4>
2362 <b>vcsRegisteredState</b>(<i>name</i>) 2549 <b>vcsRegisteredState</b>(<i>name</i>)
2372 </dd> 2559 </dd>
2373 </dl> 2560 </dl>
2374 <dl> 2561 <dl>
2375 <dt>Return:</dt> 2562 <dt>Return:</dt>
2376 <dd> 2563 <dd>
2377 a combination of canBeCommited and canBeAdded 2564 registered state (one of canBeCommited and canBeAdded)
2378 </dd> 2565 </dd>
2379 </dl> 2566 </dl>
2380 <dl> 2567 <dl>
2381 <dt>Return Type:</dt> 2568 <dt>Return Type:</dt>
2382 <dd> 2569 <dd>
2394 <p> 2581 <p>
2395 The default operation is to remove the local copy as well. 2582 The default operation is to remove the local copy as well.
2396 </p> 2583 </p>
2397 <dl> 2584 <dl>
2398 2585
2399 <dt><i>name</i></dt> 2586 <dt><i>name</i> (str or list of str)</dt>
2400 <dd> 2587 <dd>
2401 file/directory name to be removed (string or list of 2588 file/directory name to be removed
2402 strings)) 2589 </dd>
2403 </dd> 2590 <dt><i>project</i> (bool)</dt>
2404 <dt><i>project</i></dt> 2591 <dd>
2405 <dd> 2592 flag indicating deletion of a project tree
2406 flag indicating deletion of a project tree (boolean) 2593 </dd>
2407 (not needed) 2594 <dt><i>noDialog</i> (bool)</dt>
2408 </dd>
2409 <dt><i>noDialog</i></dt>
2410 <dd> 2595 <dd>
2411 flag indicating quiet operations 2596 flag indicating quiet operations
2412 </dd> 2597 </dd>
2413 </dl> 2598 </dl>
2414 <dl> 2599 <dl>
2415 <dt>Return:</dt> 2600 <dt>Return:</dt>
2416 <dd> 2601 <dd>
2417 flag indicating successfull operation (boolean) 2602 flag indicating successfull operation
2603 </dd>
2604 </dl>
2605 <dl>
2606 <dt>Return Type:</dt>
2607 <dd>
2608 bool
2418 </dd> 2609 </dd>
2419 </dl> 2610 </dl>
2420 <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a> 2611 <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a>
2421 <h4>Hg.vcsRepositoryInfos</h4> 2612 <h4>Hg.vcsRepositoryInfos</h4>
2422 <b>vcsRepositoryInfos</b>(<i>ppath</i>) 2613 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
2424 <p> 2615 <p>
2425 Public method to retrieve information about the repository. 2616 Public method to retrieve information about the repository.
2426 </p> 2617 </p>
2427 <dl> 2618 <dl>
2428 2619
2429 <dt><i>ppath</i></dt> 2620 <dt><i>ppath</i> (str)</dt>
2430 <dd> 2621 <dd>
2431 local path to get the repository infos (string) 2622 local path to get the repository infos
2432 </dd> 2623 </dd>
2433 </dl> 2624 </dl>
2434 <dl> 2625 <dl>
2435 <dt>Return:</dt> 2626 <dt>Return:</dt>
2436 <dd> 2627 <dd>
2437 string with ready formated info for display (string) 2628 string with ready formated info for display
2629 </dd>
2630 </dl>
2631 <dl>
2632 <dt>Return Type:</dt>
2633 <dd>
2634 str
2438 </dd> 2635 </dd>
2439 </dl> 2636 </dl>
2440 <a NAME="Hg.vcsResolved" ID="Hg.vcsResolved"></a> 2637 <a NAME="Hg.vcsResolved" ID="Hg.vcsResolved"></a>
2441 <h4>Hg.vcsResolved</h4> 2638 <h4>Hg.vcsResolved</h4>
2442 <b>vcsResolved</b>(<i>name, unresolve=False</i>) 2639 <b>vcsResolved</b>(<i>name, unresolve=False</i>)
2444 <p> 2641 <p>
2445 Public method used to resolve conflicts of a file/directory. 2642 Public method used to resolve conflicts of a file/directory.
2446 </p> 2643 </p>
2447 <dl> 2644 <dl>
2448 2645
2449 <dt><i>name</i></dt> 2646 <dt><i>name</i> (str)</dt>
2450 <dd> 2647 <dd>
2451 file/directory name to be resolved (string) 2648 file/directory name to be resolved
2452 </dd> 2649 </dd>
2453 <dt><i>unresolve</i></dt> 2650 <dt><i>unresolve</i> (bool)</dt>
2454 <dd> 2651 <dd>
2455 flag indicating to mark the file/directory as 2652 flag indicating to mark the file/directory as
2456 unresolved (boolean) 2653 unresolved
2457 </dd> 2654 </dd>
2458 </dl> 2655 </dl>
2459 <a NAME="Hg.vcsRevert" ID="Hg.vcsRevert"></a> 2656 <a NAME="Hg.vcsRevert" ID="Hg.vcsRevert"></a>
2460 <h4>Hg.vcsRevert</h4> 2657 <h4>Hg.vcsRevert</h4>
2461 <b>vcsRevert</b>(<i>name</i>) 2658 <b>vcsRevert</b>(<i>name</i>)
2491 Public method used to view the difference of a file to the Mercurial 2688 Public method used to view the difference of a file to the Mercurial
2492 repository side-by-side. 2689 repository side-by-side.
2493 </p> 2690 </p>
2494 <dl> 2691 <dl>
2495 2692
2496 <dt><i>name</i></dt> 2693 <dt><i>name</i> (str)</dt>
2497 <dd> 2694 <dd>
2498 file name to be diffed (string) 2695 file name to be diffed
2499 </dd> 2696 </dd>
2500 <dt><i>extended</i></dt> 2697 <dt><i>extended</i> (bool)</dt>
2501 <dd> 2698 <dd>
2502 flag indicating the extended variant (boolean) 2699 flag indicating the extended variant
2503 </dd> 2700 </dd>
2504 <dt><i>revisions</i></dt> 2701 <dt><i>revisions</i> (tuple of (str, str))</dt>
2505 <dd> 2702 <dd>
2506 tuple of two revisions (tuple of strings) 2703 tuple of two revisions
2507 </dd> 2704 </dd>
2508 </dl> 2705 </dl>
2509 <dl> 2706 <dl>
2510 2707
2511 <dt>Raises <b>ValueError</b>:</dt> 2708 <dt>Raises <b>ValueError</b>:</dt>
2528 Public method used to view the status of files/directories in the 2725 Public method used to view the status of files/directories in the
2529 Mercurial repository. 2726 Mercurial repository.
2530 </p> 2727 </p>
2531 <dl> 2728 <dl>
2532 2729
2533 <dt><i>name</i></dt> 2730 <dt><i>name</i> (str or list of str)</dt>
2534 <dd> 2731 <dd>
2535 file/directory name(s) to show the status of 2732 file/directory name(s) to show the status of
2536 (string or list of strings)
2537 </dd> 2733 </dd>
2538 </dl> 2734 </dl>
2539 <a NAME="Hg.vcsSupportCommandOptions" ID="Hg.vcsSupportCommandOptions"></a> 2735 <a NAME="Hg.vcsSupportCommandOptions" ID="Hg.vcsSupportCommandOptions"></a>
2540 <h4>Hg.vcsSupportCommandOptions</h4> 2736 <h4>Hg.vcsSupportCommandOptions</h4>
2541 <b>vcsSupportCommandOptions</b>(<i></i>) 2737 <b>vcsSupportCommandOptions</b>(<i></i>)
2545 </p> 2741 </p>
2546 <dl> 2742 <dl>
2547 <dt>Return:</dt> 2743 <dt>Return:</dt>
2548 <dd> 2744 <dd>
2549 flag indicating the support of user settable command options 2745 flag indicating the support of user settable command options
2550 (boolean) 2746 </dd>
2747 </dl>
2748 <dl>
2749 <dt>Return Type:</dt>
2750 <dd>
2751 bool
2551 </dd> 2752 </dd>
2552 </dl> 2753 </dl>
2553 <a NAME="Hg.vcsSwitch" ID="Hg.vcsSwitch"></a> 2754 <a NAME="Hg.vcsSwitch" ID="Hg.vcsSwitch"></a>
2554 <h4>Hg.vcsSwitch</h4> 2755 <h4>Hg.vcsSwitch</h4>
2555 <b>vcsSwitch</b>(<i>name</i>) 2756 <b>vcsSwitch</b>(<i>name</i>)
2558 Public method used to switch a working directory to a different 2759 Public method used to switch a working directory to a different
2559 revision. 2760 revision.
2560 </p> 2761 </p>
2561 <dl> 2762 <dl>
2562 2763
2563 <dt><i>name</i></dt> 2764 <dt><i>name</i> (str)</dt>
2564 <dd> 2765 <dd>
2565 directory name to be switched (string) 2766 directory name to be switched
2566 </dd> 2767 </dd>
2567 </dl> 2768 </dl>
2568 <dl> 2769 <dl>
2569 <dt>Return:</dt> 2770 <dt>Return:</dt>
2570 <dd> 2771 <dd>
2571 flag indicating, that the switch contained an add 2772 flag indicating, that the switch contained an add or delete
2572 or delete (boolean) 2773 </dd>
2774 </dl>
2775 <dl>
2776 <dt>Return Type:</dt>
2777 <dd>
2778 bool
2573 </dd> 2779 </dd>
2574 </dl> 2780 </dl>
2575 <a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a> 2781 <a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a>
2576 <h4>Hg.vcsTag</h4> 2782 <h4>Hg.vcsTag</h4>
2577 <b>vcsTag</b>(<i>name=None, revision=None, tagName=None</i>) 2783 <b>vcsTag</b>(<i>name=None, revision=None, tagName=None</i>)
2579 <p> 2785 <p>
2580 Public method used to set/remove a tag in the Mercurial repository. 2786 Public method used to set/remove a tag in the Mercurial repository.
2581 </p> 2787 </p>
2582 <dl> 2788 <dl>
2583 2789
2584 <dt><i>name</i></dt> 2790 <dt><i>name</i> (str)</dt>
2585 <dd> 2791 <dd>
2586 file/directory name to determine the repo root from 2792 file/directory name to determine the repo root from
2587 (string) 2793 </dd>
2588 </dd> 2794 <dt><i>revision</i> (str)</dt>
2589 <dt><i>revision</i></dt> 2795 <dd>
2590 <dd> 2796 revision to set tag for
2591 revision to set tag for (string) 2797 </dd>
2592 </dd> 2798 <dt><i>tagName</i> (str)</dt>
2593 <dt><i>tagName</i></dt> 2799 <dd>
2594 <dd> 2800 name of the tag
2595 name of the tag (string) 2801 </dd>
2596 </dd> 2802 </dl>
2597 </dl> 2803 <dl>
2598 <dl> 2804 <dt>Return:</dt>
2599 <dt>Return:</dt> 2805 <dd>
2600 <dd> 2806 flag indicating a performed tag action
2601 flag indicating a performed tag action (boolean) 2807 </dd>
2808 </dl>
2809 <dl>
2810 <dt>Return Type:</dt>
2811 <dd>
2812 bool
2602 </dd> 2813 </dd>
2603 </dl> 2814 </dl>
2604 <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a> 2815 <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a>
2605 <h4>Hg.vcsUpdate</h4> 2816 <h4>Hg.vcsUpdate</h4>
2606 <b>vcsUpdate</b>(<i>name=None, noDialog=False, revision=None</i>) 2817 <b>vcsUpdate</b>(<i>name=None, noDialog=False, revision=None</i>)
2609 Public method used to update a file/directory with the Mercurial 2820 Public method used to update a file/directory with the Mercurial
2610 repository. 2821 repository.
2611 </p> 2822 </p>
2612 <dl> 2823 <dl>
2613 2824
2614 <dt><i>name</i></dt> 2825 <dt><i>name</i> (str)</dt>
2615 <dd> 2826 <dd>
2616 file/directory name to be updated (not used) 2827 file/directory name to be updated (not used)
2617 </dd> 2828 </dd>
2618 <dt><i>noDialog</i></dt> 2829 <dt><i>noDialog</i> (bool)</dt>
2619 <dd> 2830 <dd>
2620 flag indicating quiet operations (boolean) 2831 flag indicating quiet operations
2621 </dd> 2832 </dd>
2622 <dt><i>revision</i></dt> 2833 <dt><i>revision</i> (str)</dt>
2623 <dd> 2834 <dd>
2624 revision to update to (string) 2835 revision to update to
2625 </dd> 2836 </dd>
2626 </dl> 2837 </dl>
2627 <dl> 2838 <dl>
2628 <dt>Return:</dt> 2839 <dt>Return:</dt>
2629 <dd> 2840 <dd>
2630 flag indicating, that the update contained an add 2841 flag indicating, that the update contained an add or delete
2631 or delete (boolean) 2842 </dd>
2843 </dl>
2844 <dl>
2845 <dt>Return Type:</dt>
2846 <dd>
2847 bool
2632 </dd> 2848 </dd>
2633 </dl> 2849 </dl>
2634 <div align="right"><a href="#top">Up</a></div> 2850 <div align="right"><a href="#top">Up</a></div>
2635 <hr /> 2851 <hr />
2636 </body></html> 2852 </body></html>

Mercurial Repository: eric

eric ide

mercurial