Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.hg.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.hg.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
child 8108
a42ae6be4cc3
equal deleted inserted replaced
7991:866adc8c315b 8043:0acf98cd089a
608 <p> 608 <p>
609 Private method to get the active extensions from Mercurial. 609 Private method to get the active extensions from Mercurial.
610 </p> 610 </p>
611 <a NAME="Hg.__getInOutBookmarks" ID="Hg.__getInOutBookmarks"></a> 611 <a NAME="Hg.__getInOutBookmarks" ID="Hg.__getInOutBookmarks"></a>
612 <h4>Hg.__getInOutBookmarks</h4> 612 <h4>Hg.__getInOutBookmarks</h4>
613 <b>__getInOutBookmarks</b>(<i>repodir, incoming</i>) 613 <b>__getInOutBookmarks</b>(<i>incoming</i>)
614 614
615 <p> 615 <p>
616 Private method to get the list of incoming or outgoing bookmarks. 616 Private method to get the list of incoming or outgoing bookmarks.
617 </p> 617 </p>
618 <dl> 618 <dl>
619 619
620 <dt><i>repodir</i></dt>
621 <dd>
622 directory name of the repository (string)
623 </dd>
624 <dt><i>incoming</i></dt> 620 <dt><i>incoming</i></dt>
625 <dd> 621 <dd>
626 flag indicating to get incoming bookmarks (boolean) 622 flag indicating to get incoming bookmarks (boolean)
627 </dd> 623 </dd>
628 </dl> 624 </dl>
629 <dl> 625 <dl>
630 <dt>Returns:</dt> 626 <dt>Return:</dt>
631 <dd> 627 <dd>
632 list of bookmarks (list of string) 628 list of bookmarks (list of string)
633 </dd> 629 </dd>
634 </dl> 630 </dl>
635 <a NAME="Hg.__getMostRecentCommitMessage" ID="Hg.__getMostRecentCommitMessage"></a> 631 <a NAME="Hg.__getMostRecentCommitMessage" ID="Hg.__getMostRecentCommitMessage"></a>
636 <h4>Hg.__getMostRecentCommitMessage</h4> 632 <h4>Hg.__getMostRecentCommitMessage</h4>
637 <b>__getMostRecentCommitMessage</b>(<i>repodir</i>) 633 <b>__getMostRecentCommitMessage</b>(<i></i>)
638 634
639 <p> 635 <p>
640 Private method to get the most recent commit message. 636 Private method to get the most recent commit message.
641 </p> 637 </p>
642 <p> 638 <p>
643 Note: This message is extracted from the parent commit of the 639 Note: This message is extracted from the parent commit of the
644 working directory. 640 working directory.
645 </p> 641 </p>
646 <dl> 642 <dl>
647 643 <dt>Return:</dt>
648 <dt><i>repodir</i> (str)</dt>
649 <dd>
650 path containing the repository
651 </dd>
652 </dl>
653 <dl>
654 <dt>Returns:</dt>
655 <dd> 644 <dd>
656 most recent commit message 645 most recent commit message
657 </dd> 646 </dd>
658 </dl> 647 </dl>
659 <dl> 648 <dl>
674 663
675 <dt><i>name</i></dt> 664 <dt><i>name</i></dt>
676 <dd> 665 <dd>
677 file name to get from the repository (string) 666 file name to get from the repository (string)
678 </dd> 667 </dd>
679 <dt><i>rev=</i></dt> 668 <dt><i>rev</i></dt>
680 <dd> 669 <dd>
681 revision to retrieve (string) 670 revision to retrieve (string)
682 </dd> 671 </dd>
683 </dl> 672 </dl>
684 <dl> 673 <dl>
685 <dt>Returns:</dt> 674 <dt>Return:</dt>
686 <dd> 675 <dd>
687 contents of the file (string) and an error message (string) 676 contents of the file (string) and an error message (string)
688 </dd> 677 </dd>
689 </dl> 678 </dl>
690 <a NAME="Hg.__hgGraftSubCommand" ID="Hg.__hgGraftSubCommand"></a> 679 <a NAME="Hg.__hgGraftSubCommand" ID="Hg.__hgGraftSubCommand"></a>
691 <h4>Hg.__hgGraftSubCommand</h4> 680 <h4>Hg.__hgGraftSubCommand</h4>
692 <b>__hgGraftSubCommand</b>(<i>path, subcommand, title</i>) 681 <b>__hgGraftSubCommand</b>(<i>subcommand, title</i>)
693 682
694 <p> 683 <p>
695 Private method to perform a Mercurial graft subcommand. 684 Private method to perform a Mercurial graft subcommand.
696 </p> 685 </p>
697 <dl> 686 <dl>
698 687
699 <dt><i>path</i> (str)</dt>
700 <dd>
701 directory name of the project
702 </dd>
703 <dt><i>subcommand</i> (str)</dt> 688 <dt><i>subcommand</i> (str)</dt>
704 <dd> 689 <dd>
705 subcommand flag 690 subcommand flag
706 </dd> 691 </dd>
707 <dt><i>title</i> (str)</dt> 692 <dt><i>title</i> (str)</dt>
708 <dd> 693 <dd>
709 tirle of the dialog 694 tirle of the dialog
710 </dd> 695 </dd>
711 </dl> 696 </dl>
712 <dl> 697 <dl>
713 <dt>Returns:</dt> 698 <dt>Return:</dt>
714 <dd> 699 <dd>
715 flag indicating that the project should be reread 700 flag indicating that the project should be reread
716 </dd> 701 </dd>
717 </dl> 702 </dl>
718 <dl> 703 <dl>
735 name of the changed file (string) 720 name of the changed file (string)
736 </dd> 721 </dd>
737 </dl> 722 </dl>
738 <a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a> 723 <a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a>
739 <h4>Hg.__monitorRepoIniFile</h4> 724 <h4>Hg.__monitorRepoIniFile</h4>
740 <b>__monitorRepoIniFile</b>(<i>name</i>) 725 <b>__monitorRepoIniFile</b>(<i>repodir</i>)
741 726
742 <p> 727 <p>
743 Private slot to add a repository configuration file to the list of 728 Private slot to add a repository configuration file to the list of
744 monitored files. 729 monitored files.
745 </p> 730 </p>
746 <dl> 731 <dl>
747 732
748 <dt><i>name</i></dt> 733 <dt><i>repodir</i> (str)</dt>
749 <dd> 734 <dd>
750 directory name pointing into the repository (string) 735 directory name of the repository
751 </dd> 736 </dd>
752 </dl> 737 </dl>
753 <a NAME="Hg.__vcsCommit_Step2" ID="Hg.__vcsCommit_Step2"></a> 738 <a NAME="Hg.__vcsCommit_Step2" ID="Hg.__vcsCommit_Step2"></a>
754 <h4>Hg.__vcsCommit_Step2</h4> 739 <h4>Hg.__vcsCommit_Step2</h4>
755 <b>__vcsCommit_Step2</b>(<i></i>) 740 <b>__vcsCommit_Step2</b>(<i></i>)
776 <dd> 761 <dd>
777 reference to the project object (Project) 762 reference to the project object (Project)
778 </dd> 763 </dd>
779 </dl> 764 </dl>
780 <dl> 765 <dl>
781 <dt>Returns:</dt> 766 <dt>Return:</dt>
782 <dd> 767 <dd>
783 reference to the monitor thread (QThread) 768 reference to the monitor thread (QThread)
784 </dd> 769 </dd>
785 </dl> 770 </dl>
786 <a NAME="Hg.canCommitMerge" ID="Hg.canCommitMerge"></a> 771 <a NAME="Hg.canCommitMerge" ID="Hg.canCommitMerge"></a>
787 <h4>Hg.canCommitMerge</h4> 772 <h4>Hg.canCommitMerge</h4>
788 <b>canCommitMerge</b>(<i>name</i>) 773 <b>canCommitMerge</b>(<i></i>)
789 774
790 <p> 775 <p>
791 Public method to check, if the working directory is an uncommitted 776 Public method to check, if the working directory is an uncommitted
792 merge. 777 merge.
793 </p> 778 </p>
794 <dl> 779 <dl>
795 780 <dt>Return:</dt>
796 <dt><i>name</i> (str)</dt>
797 <dd>
798 file/directory name
799 </dd>
800 </dl>
801 <dl>
802 <dt>Returns:</dt>
803 <dd> 781 <dd>
804 flag indicating commit merge capability 782 flag indicating commit merge capability
805 </dd> 783 </dd>
806 </dl> 784 </dl>
807 <dl> 785 <dl>
816 794
817 <p> 795 <p>
818 Public method to check, if pull is possible. 796 Public method to check, if pull is possible.
819 </p> 797 </p>
820 <dl> 798 <dl>
821 <dt>Returns:</dt> 799 <dt>Return:</dt>
822 <dd> 800 <dd>
823 flag indicating pull capability (boolean) 801 flag indicating pull capability (boolean)
824 </dd> 802 </dd>
825 </dl> 803 </dl>
826 <a NAME="Hg.canPush" ID="Hg.canPush"></a> 804 <a NAME="Hg.canPush" ID="Hg.canPush"></a>
829 807
830 <p> 808 <p>
831 Public method to check, if push is possible. 809 Public method to check, if push is possible.
832 </p> 810 </p>
833 <dl> 811 <dl>
834 <dt>Returns:</dt> 812 <dt>Return:</dt>
835 <dd> 813 <dd>
836 flag indicating push capability (boolean) 814 flag indicating push capability (boolean)
837 </dd> 815 </dd>
838 </dl> 816 </dl>
839 <a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a> 817 <a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a>
849 827
850 <p> 828 <p>
851 Public method to get a reference to the command server interface. 829 Public method to get a reference to the command server interface.
852 </p> 830 </p>
853 <dl> 831 <dl>
854 <dt>Returns:</dt> 832 <dt>Return:</dt>
855 <dd> 833 <dd>
856 reference to the client (HgClient) 834 reference to the client (HgClient)
857 </dd> 835 </dd>
858 </dl> 836 </dl>
859 <a NAME="Hg.getEncoding" ID="Hg.getEncoding"></a> 837 <a NAME="Hg.getEncoding" ID="Hg.getEncoding"></a>
862 840
863 <p> 841 <p>
864 Public method to get the encoding to be used by Mercurial. 842 Public method to get the encoding to be used by Mercurial.
865 </p> 843 </p>
866 <dl> 844 <dl>
867 <dt>Returns:</dt> 845 <dt>Return:</dt>
868 <dd> 846 <dd>
869 encoding (string) 847 encoding (string)
870 </dd> 848 </dd>
871 </dl> 849 </dl>
872 <a NAME="Hg.getExtensionObject" ID="Hg.getExtensionObject"></a> 850 <a NAME="Hg.getExtensionObject" ID="Hg.getExtensionObject"></a>
882 <dd> 860 <dd>
883 name of the extension (string) 861 name of the extension (string)
884 </dd> 862 </dd>
885 </dl> 863 </dl>
886 <dl> 864 <dl>
887 <dt>Returns:</dt> 865 <dt>Return:</dt>
888 <dd> 866 <dd>
889 reference to the extension object (boolean) 867 reference to the extension object (boolean)
890 </dd> 868 </dd>
891 </dl> 869 </dl>
892 <a NAME="Hg.getHgSubPath" ID="Hg.getHgSubPath"></a> 870 <a NAME="Hg.getHgSubPath" ID="Hg.getHgSubPath"></a>
896 <p> 874 <p>
897 Public method to get the path to the .hgsub file containing the 875 Public method to get the path to the .hgsub file containing the
898 definitions of sub-repositories. 876 definitions of sub-repositories.
899 </p> 877 </p>
900 <dl> 878 <dl>
901 <dt>Returns:</dt> 879 <dt>Return:</dt>
902 <dd> 880 <dd>
903 full path of the .hgsub file (string) 881 full path of the .hgsub file (string)
904 </dd> 882 </dd>
905 </dl> 883 </dl>
906 <a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a> 884 <a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a>
909 887
910 <p> 888 <p>
911 Public method to get a reference to the plugin object. 889 Public method to get a reference to the plugin object.
912 </p> 890 </p>
913 <dl> 891 <dl>
914 <dt>Returns:</dt> 892 <dt>Return:</dt>
915 <dd> 893 <dd>
916 reference to the plugin object (VcsMercurialPlugin) 894 reference to the plugin object (VcsMercurialPlugin)
917 </dd> 895 </dd>
918 </dl> 896 </dl>
919 <a NAME="Hg.hasSubrepositories" ID="Hg.hasSubrepositories"></a> 897 <a NAME="Hg.hasSubrepositories" ID="Hg.hasSubrepositories"></a>
922 900
923 <p> 901 <p>
924 Public method to check, if the project might have sub-repositories. 902 Public method to check, if the project might have sub-repositories.
925 </p> 903 </p>
926 <dl> 904 <dl>
927 <dt>Returns:</dt> 905 <dt>Return:</dt>
928 <dd> 906 <dd>
929 flag indicating the existence of sub-repositories (boolean) 907 flag indicating the existence of sub-repositories (boolean)
930 </dd> 908 </dd>
931 </dl> 909 </dl>
932 <a NAME="Hg.hgAbortMerge" ID="Hg.hgAbortMerge"></a> 910 <a NAME="Hg.hgAbortMerge" ID="Hg.hgAbortMerge"></a>
933 <h4>Hg.hgAbortMerge</h4> 911 <h4>Hg.hgAbortMerge</h4>
934 <b>hgAbortMerge</b>(<i>name</i>) 912 <b>hgAbortMerge</b>(<i></i>)
935 913
936 <p> 914 <p>
937 Public method to abort an uncommitted merge. 915 Public method to abort an uncommitted merge.
938 </p> 916 </p>
939 <dl> 917 <dl>
940 918 <dt>Return:</dt>
941 <dt><i>name</i></dt>
942 <dd>
943 file/directory name (string)
944 </dd>
945 </dl>
946 <dl>
947 <dt>Returns:</dt>
948 <dd> 919 <dd>
949 flag indicating, that the abortion contained an add 920 flag indicating, that the abortion contained an add
950 or delete (boolean) 921 or delete (boolean)
951 </dd> 922 </dd>
952 </dl> 923 </dl>
978 <p> 949 <p>
979 Public method to create an unversioned archive from the repository. 950 Public method to create an unversioned archive from the repository.
980 </p> 951 </p>
981 <a NAME="Hg.hgBackout" ID="Hg.hgBackout"></a> 952 <a NAME="Hg.hgBackout" ID="Hg.hgBackout"></a>
982 <h4>Hg.hgBackout</h4> 953 <h4>Hg.hgBackout</h4>
983 <b>hgBackout</b>(<i>name</i>) 954 <b>hgBackout</b>(<i></i>)
984 955
985 <p> 956 <p>
986 Public method used to backout an earlier changeset from the Mercurial 957 Public method used to backout an earlier changeset from the Mercurial
987 repository. 958 repository.
988 </p> 959 </p>
989 <dl>
990
991 <dt><i>name</i></dt>
992 <dd>
993 directory name (string or list of strings)
994 </dd>
995 </dl>
996 <a NAME="Hg.hgBisect" ID="Hg.hgBisect"></a> 960 <a NAME="Hg.hgBisect" ID="Hg.hgBisect"></a>
997 <h4>Hg.hgBisect</h4> 961 <h4>Hg.hgBisect</h4>
998 <b>hgBisect</b>(<i>name, subcommand</i>) 962 <b>hgBisect</b>(<i>subcommand</i>)
999 963
1000 <p> 964 <p>
1001 Public method to perform bisect commands. 965 Public method to perform bisect commands.
1002 </p> 966 </p>
1003 <dl> 967 <dl>
1004 968
1005 <dt><i>name</i></dt> 969 <dt><i>subcommand</i> (str)</dt>
1006 <dd> 970 <dd>
1007 file/directory name (string) 971 name of the subcommand (one of 'good', 'bad',
1008 </dd>
1009 <dt><i>subcommand</i></dt>
1010 <dd>
1011 name of the subcommand (string, one of 'good', 'bad',
1012 'skip' or 'reset') 972 'skip' or 'reset')
1013 </dd> 973 </dd>
1014 </dl> 974 </dl>
1015 <dl> 975 <dl>
1016 976
1019 raised to indicate an invalid bisect subcommand 979 raised to indicate an invalid bisect subcommand
1020 </dd> 980 </dd>
1021 </dl> 981 </dl>
1022 <a NAME="Hg.hgBookmarkDefine" ID="Hg.hgBookmarkDefine"></a> 982 <a NAME="Hg.hgBookmarkDefine" ID="Hg.hgBookmarkDefine"></a>
1023 <h4>Hg.hgBookmarkDefine</h4> 983 <h4>Hg.hgBookmarkDefine</h4>
1024 <b>hgBookmarkDefine</b>(<i>name, revision=None, bookmark=None</i>) 984 <b>hgBookmarkDefine</b>(<i>revision=None, bookmark=None</i>)
1025 985
1026 <p> 986 <p>
1027 Public method to define a bookmark. 987 Public method to define a bookmark.
1028 </p> 988 </p>
1029 <dl> 989 <dl>
1030 990
1031 <dt><i>name</i></dt>
1032 <dd>
1033 file/directory name (string)
1034 </dd>
1035 <dt><i>revision</i></dt> 991 <dt><i>revision</i></dt>
1036 <dd> 992 <dd>
1037 revision to set bookmark for (string) 993 revision to set bookmark for (string)
1038 </dd> 994 </dd>
1039 <dt><i>bookmark</i></dt> 995 <dt><i>bookmark</i></dt>
1041 name of the bookmark (string) 997 name of the bookmark (string)
1042 </dd> 998 </dd>
1043 </dl> 999 </dl>
1044 <a NAME="Hg.hgBookmarkDelete" ID="Hg.hgBookmarkDelete"></a> 1000 <a NAME="Hg.hgBookmarkDelete" ID="Hg.hgBookmarkDelete"></a>
1045 <h4>Hg.hgBookmarkDelete</h4> 1001 <h4>Hg.hgBookmarkDelete</h4>
1046 <b>hgBookmarkDelete</b>(<i>name, bookmark=None</i>) 1002 <b>hgBookmarkDelete</b>(<i>bookmark=None</i>)
1047 1003
1048 <p> 1004 <p>
1049 Public method to delete a bookmark. 1005 Public method to delete a bookmark.
1050 </p> 1006 </p>
1051 <dl> 1007 <dl>
1052 1008
1053 <dt><i>name</i></dt>
1054 <dd>
1055 file/directory name (string)
1056 </dd>
1057 <dt><i>bookmark</i></dt> 1009 <dt><i>bookmark</i></dt>
1058 <dd> 1010 <dd>
1059 name of the bookmark (string) 1011 name of the bookmark (string)
1060 </dd> 1012 </dd>
1061 </dl> 1013 </dl>
1062 <a NAME="Hg.hgBookmarkIncoming" ID="Hg.hgBookmarkIncoming"></a> 1014 <a NAME="Hg.hgBookmarkIncoming" ID="Hg.hgBookmarkIncoming"></a>
1063 <h4>Hg.hgBookmarkIncoming</h4> 1015 <h4>Hg.hgBookmarkIncoming</h4>
1064 <b>hgBookmarkIncoming</b>(<i>name</i>) 1016 <b>hgBookmarkIncoming</b>(<i></i>)
1065 1017
1066 <p> 1018 <p>
1067 Public method to show a list of incoming bookmarks. 1019 Public method to show a list of incoming bookmarks.
1068 </p> 1020 </p>
1069 <dl>
1070
1071 <dt><i>name</i></dt>
1072 <dd>
1073 file/directory name (string)
1074 </dd>
1075 </dl>
1076 <a NAME="Hg.hgBookmarkMove" ID="Hg.hgBookmarkMove"></a> 1021 <a NAME="Hg.hgBookmarkMove" ID="Hg.hgBookmarkMove"></a>
1077 <h4>Hg.hgBookmarkMove</h4> 1022 <h4>Hg.hgBookmarkMove</h4>
1078 <b>hgBookmarkMove</b>(<i>name, revision=None, bookmark=None</i>) 1023 <b>hgBookmarkMove</b>(<i>revision=None, bookmark=None</i>)
1079 1024
1080 <p> 1025 <p>
1081 Public method to move a bookmark. 1026 Public method to move a bookmark.
1082 </p> 1027 </p>
1083 <dl> 1028 <dl>
1084 1029
1085 <dt><i>name</i></dt>
1086 <dd>
1087 file/directory name (string)
1088 </dd>
1089 <dt><i>revision</i></dt> 1030 <dt><i>revision</i></dt>
1090 <dd> 1031 <dd>
1091 revision to set bookmark for (string) 1032 revision to set bookmark for (string)
1092 </dd> 1033 </dd>
1093 <dt><i>bookmark</i></dt> 1034 <dt><i>bookmark</i></dt>
1095 name of the bookmark (string) 1036 name of the bookmark (string)
1096 </dd> 1037 </dd>
1097 </dl> 1038 </dl>
1098 <a NAME="Hg.hgBookmarkOutgoing" ID="Hg.hgBookmarkOutgoing"></a> 1039 <a NAME="Hg.hgBookmarkOutgoing" ID="Hg.hgBookmarkOutgoing"></a>
1099 <h4>Hg.hgBookmarkOutgoing</h4> 1040 <h4>Hg.hgBookmarkOutgoing</h4>
1100 <b>hgBookmarkOutgoing</b>(<i>name</i>) 1041 <b>hgBookmarkOutgoing</b>(<i></i>)
1101 1042
1102 <p> 1043 <p>
1103 Public method to show a list of outgoing bookmarks. 1044 Public method to show a list of outgoing bookmarks.
1104 </p> 1045 </p>
1105 <dl>
1106
1107 <dt><i>name</i></dt>
1108 <dd>
1109 file/directory name (string)
1110 </dd>
1111 </dl>
1112 <a NAME="Hg.hgBookmarkPull" ID="Hg.hgBookmarkPull"></a> 1046 <a NAME="Hg.hgBookmarkPull" ID="Hg.hgBookmarkPull"></a>
1113 <h4>Hg.hgBookmarkPull</h4> 1047 <h4>Hg.hgBookmarkPull</h4>
1114 <b>hgBookmarkPull</b>(<i>name, current=False, bookmark=None</i>) 1048 <b>hgBookmarkPull</b>(<i>current=False, bookmark=None</i>)
1115 1049
1116 <p> 1050 <p>
1117 Public method to pull a bookmark from a remote repository. 1051 Public method to pull a bookmark from a remote repository.
1118 </p> 1052 </p>
1119 <dl> 1053 <dl>
1120 1054
1121 <dt><i>name</i> (str)</dt>
1122 <dd>
1123 file/directory name
1124 </dd>
1125 <dt><i>current</i> (bool)</dt> 1055 <dt><i>current</i> (bool)</dt>
1126 <dd> 1056 <dd>
1127 flag indicating to pull the current bookmark 1057 flag indicating to pull the current bookmark
1128 </dd> 1058 </dd>
1129 <dt><i>bookmark</i> (str)</dt> 1059 <dt><i>bookmark</i> (str)</dt>
1131 name of the bookmark 1061 name of the bookmark
1132 </dd> 1062 </dd>
1133 </dl> 1063 </dl>
1134 <a NAME="Hg.hgBookmarkPush" ID="Hg.hgBookmarkPush"></a> 1064 <a NAME="Hg.hgBookmarkPush" ID="Hg.hgBookmarkPush"></a>
1135 <h4>Hg.hgBookmarkPush</h4> 1065 <h4>Hg.hgBookmarkPush</h4>
1136 <b>hgBookmarkPush</b>(<i>name, current=False, bookmark=None</i>) 1066 <b>hgBookmarkPush</b>(<i>current=False, bookmark=None</i>)
1137 1067
1138 <p> 1068 <p>
1139 Public method to push a bookmark to a remote repository. 1069 Public method to push a bookmark to a remote repository.
1140 </p> 1070 </p>
1141 <dl> 1071 <dl>
1142 1072
1143 <dt><i>name</i> (str)</dt>
1144 <dd>
1145 file/directory name
1146 </dd>
1147 <dt><i>current</i> (bool)</dt> 1073 <dt><i>current</i> (bool)</dt>
1148 <dd> 1074 <dd>
1149 flag indicating to push the current bookmark 1075 flag indicating to push the current bookmark
1150 </dd> 1076 </dd>
1151 <dt><i>bookmark</i> (str)</dt> 1077 <dt><i>bookmark</i> (str)</dt>
1153 name of the bookmark 1079 name of the bookmark
1154 </dd> 1080 </dd>
1155 </dl> 1081 </dl>
1156 <a NAME="Hg.hgBookmarkRename" ID="Hg.hgBookmarkRename"></a> 1082 <a NAME="Hg.hgBookmarkRename" ID="Hg.hgBookmarkRename"></a>
1157 <h4>Hg.hgBookmarkRename</h4> 1083 <h4>Hg.hgBookmarkRename</h4>
1158 <b>hgBookmarkRename</b>(<i>name, renameInfo=None</i>) 1084 <b>hgBookmarkRename</b>(<i>renameInfo=None</i>)
1159 1085
1160 <p> 1086 <p>
1161 Public method to rename a bookmark. 1087 Public method to rename a bookmark.
1162 </p> 1088 </p>
1163 <dl> 1089 <dl>
1164 1090
1165 <dt><i>name</i> (str)</dt>
1166 <dd>
1167 file/directory name
1168 </dd>
1169 <dt><i>renameInfo</i> (tuple of str and str)</dt> 1091 <dt><i>renameInfo</i> (tuple of str and str)</dt>
1170 <dd> 1092 <dd>
1171 old and new names of the bookmark 1093 old and new names of the bookmark
1172 </dd> 1094 </dd>
1173 </dl> 1095 </dl>
1174 <a NAME="Hg.hgBranch" ID="Hg.hgBranch"></a> 1096 <a NAME="Hg.hgBranch" ID="Hg.hgBranch"></a>
1175 <h4>Hg.hgBranch</h4> 1097 <h4>Hg.hgBranch</h4>
1176 <b>hgBranch</b>(<i>name</i>) 1098 <b>hgBranch</b>(<i></i>)
1177 1099
1178 <p> 1100 <p>
1179 Public method used to create a branch in the Mercurial repository. 1101 Public method used to create a branch in the Mercurial repository.
1180 </p> 1102 </p>
1181 <dl>
1182
1183 <dt><i>name</i></dt>
1184 <dd>
1185 file/directory name to be branched (string)
1186 </dd>
1187 </dl>
1188 <a NAME="Hg.hgBundle" ID="Hg.hgBundle"></a> 1103 <a NAME="Hg.hgBundle" ID="Hg.hgBundle"></a>
1189 <h4>Hg.hgBundle</h4> 1104 <h4>Hg.hgBundle</h4>
1190 <b>hgBundle</b>(<i>name, bundleData=None</i>) 1105 <b>hgBundle</b>(<i>bundleData=None</i>)
1191 1106
1192 <p> 1107 <p>
1193 Public method to create a changegroup file. 1108 Public method to create a changegroup file.
1194 </p> 1109 </p>
1195 <dl> 1110 <dl>
1196 1111
1197 <dt><i>name</i> (str)</dt>
1198 <dd>
1199 file/directory name
1200 </dd>
1201 <dt><i>bundleData</i> (dict)</dt> 1112 <dt><i>bundleData</i> (dict)</dt>
1202 <dd> 1113 <dd>
1203 dictionary containing the bundle creation information 1114 dictionary containing the bundle creation information
1204 </dd> 1115 </dd>
1205 </dl> 1116 </dl>
1206 <a NAME="Hg.hgConflicts" ID="Hg.hgConflicts"></a> 1117 <a NAME="Hg.hgConflicts" ID="Hg.hgConflicts"></a>
1207 <h4>Hg.hgConflicts</h4> 1118 <h4>Hg.hgConflicts</h4>
1208 <b>hgConflicts</b>(<i>name</i>) 1119 <b>hgConflicts</b>(<i></i>)
1209 1120
1210 <p> 1121 <p>
1211 Public method used to show a list of files containing conflicts. 1122 Public method used to show a list of files containing conflicts.
1212 </p> 1123 </p>
1213 <dl>
1214
1215 <dt><i>name</i></dt>
1216 <dd>
1217 file/directory name to be resolved (string)
1218 </dd>
1219 </dl>
1220 <a NAME="Hg.hgCopy" ID="Hg.hgCopy"></a> 1124 <a NAME="Hg.hgCopy" ID="Hg.hgCopy"></a>
1221 <h4>Hg.hgCopy</h4> 1125 <h4>Hg.hgCopy</h4>
1222 <b>hgCopy</b>(<i>name, project</i>) 1126 <b>hgCopy</b>(<i>name, project</i>)
1223 1127
1224 <p> 1128 <p>
1234 <dd> 1138 <dd>
1235 reference to the project object 1139 reference to the project object
1236 </dd> 1140 </dd>
1237 </dl> 1141 </dl>
1238 <dl> 1142 <dl>
1239 <dt>Returns:</dt> 1143 <dt>Return:</dt>
1240 <dd> 1144 <dd>
1241 flag indicating successful operation (boolean) 1145 flag indicating successful operation (boolean)
1242 </dd> 1146 </dd>
1243 </dl> 1147 </dl>
1244 <a NAME="Hg.hgCreateIgnoreFile" ID="Hg.hgCreateIgnoreFile"></a> 1148 <a NAME="Hg.hgCreateIgnoreFile" ID="Hg.hgCreateIgnoreFile"></a>
1258 <dd> 1162 <dd>
1259 flag indicating to add it automatically (boolean) 1163 flag indicating to add it automatically (boolean)
1260 </dd> 1164 </dd>
1261 </dl> 1165 </dl>
1262 <dl> 1166 <dl>
1263 <dt>Returns:</dt> 1167 <dt>Return:</dt>
1264 <dd> 1168 <dd>
1265 flag indicating success 1169 flag indicating success
1266 </dd> 1170 </dd>
1267 </dl> 1171 </dl>
1268 <a NAME="Hg.hgDeleteBackups" ID="Hg.hgDeleteBackups"></a> 1172 <a NAME="Hg.hgDeleteBackups" ID="Hg.hgDeleteBackups"></a>
1272 <p> 1176 <p>
1273 Public method to delete all backup bundles in the backup area. 1177 Public method to delete all backup bundles in the backup area.
1274 </p> 1178 </p>
1275 <a NAME="Hg.hgEditConfig" ID="Hg.hgEditConfig"></a> 1179 <a NAME="Hg.hgEditConfig" ID="Hg.hgEditConfig"></a>
1276 <h4>Hg.hgEditConfig</h4> 1180 <h4>Hg.hgEditConfig</h4>
1277 <b>hgEditConfig</b>(<i>name, withLargefiles=True, largefilesData=None</i>) 1181 <b>hgEditConfig</b>(<i>repoName=None, withLargefiles=True, largefilesData=None</i>)
1278 1182
1279 <p> 1183 <p>
1280 Public method used to edit the repository configuration file. 1184 Public method used to edit the repository configuration file.
1281 </p> 1185 </p>
1282 <dl> 1186 <dl>
1283 1187
1284 <dt><i>name</i></dt> 1188 <dt><i>repoName</i> (str)</dt>
1285 <dd> 1189 <dd>
1286 file/directory name (string) 1190 directory name containing the repository
1287 </dd> 1191 </dd>
1288 <dt><i>withLargefiles</i></dt> 1192 <dt><i>withLargefiles</i> (bool)</dt>
1289 <dd> 1193 <dd>
1290 flag indicating to configure the largefiles 1194 flag indicating to configure the largefiles
1291 section (boolean) 1195 section
1292 </dd> 1196 </dd>
1293 <dt><i>largefilesData</i></dt> 1197 <dt><i>largefilesData</i> (dict)</dt>
1294 <dd> 1198 <dd>
1295 dictionary with data for the largefiles 1199 dictionary with data for the largefiles
1296 section of the data dialog (dict) 1200 section of the data dialog
1297 </dd> 1201 </dd>
1298 </dl> 1202 </dl>
1299 <a NAME="Hg.hgEditUserConfig" ID="Hg.hgEditUserConfig"></a> 1203 <a NAME="Hg.hgEditUserConfig" ID="Hg.hgEditUserConfig"></a>
1300 <h4>Hg.hgEditUserConfig</h4> 1204 <h4>Hg.hgEditUserConfig</h4>
1301 <b>hgEditUserConfig</b>(<i></i>) 1205 <b>hgEditUserConfig</b>(<i></i>)
1303 <p> 1207 <p>
1304 Public method used to edit the user configuration file. 1208 Public method used to edit the user configuration file.
1305 </p> 1209 </p>
1306 <a NAME="Hg.hgExport" ID="Hg.hgExport"></a> 1210 <a NAME="Hg.hgExport" ID="Hg.hgExport"></a>
1307 <h4>Hg.hgExport</h4> 1211 <h4>Hg.hgExport</h4>
1308 <b>hgExport</b>(<i>name</i>) 1212 <b>hgExport</b>(<i></i>)
1309 1213
1310 <p> 1214 <p>
1311 Public method to export patches to files. 1215 Public method to export patches to files.
1312 </p> 1216 </p>
1313 <dl>
1314
1315 <dt><i>name</i></dt>
1316 <dd>
1317 directory name of the project to export from (string)
1318 </dd>
1319 </dl>
1320 <a NAME="Hg.hgExtendedDiff" ID="Hg.hgExtendedDiff"></a> 1217 <a NAME="Hg.hgExtendedDiff" ID="Hg.hgExtendedDiff"></a>
1321 <h4>Hg.hgExtendedDiff</h4> 1218 <h4>Hg.hgExtendedDiff</h4>
1322 <b>hgExtendedDiff</b>(<i>name</i>) 1219 <b>hgExtendedDiff</b>(<i>name</i>)
1323 1220
1324 <p> 1221 <p>
1359 strings)) 1256 strings))
1360 </dd> 1257 </dd>
1361 </dl> 1258 </dl>
1362 <a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a> 1259 <a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a>
1363 <h4>Hg.hgGetBookmarksList</h4> 1260 <h4>Hg.hgGetBookmarksList</h4>
1364 <b>hgGetBookmarksList</b>(<i>repodir</i>) 1261 <b>hgGetBookmarksList</b>(<i></i>)
1365 1262
1366 <p> 1263 <p>
1367 Public method to get the list of bookmarks. 1264 Public method to get the list of bookmarks.
1368 </p> 1265 </p>
1369 <dl> 1266 <dl>
1370 1267 <dt>Return:</dt>
1371 <dt><i>repodir</i></dt>
1372 <dd>
1373 directory name of the repository (string)
1374 </dd>
1375 </dl>
1376 <dl>
1377 <dt>Returns:</dt>
1378 <dd> 1268 <dd>
1379 list of bookmarks (list of string) 1269 list of bookmarks (list of string)
1380 </dd> 1270 </dd>
1381 </dl> 1271 </dl>
1382 <a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a> 1272 <a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a>
1383 <h4>Hg.hgGetBranchesList</h4> 1273 <h4>Hg.hgGetBranchesList</h4>
1384 <b>hgGetBranchesList</b>(<i>repodir</i>) 1274 <b>hgGetBranchesList</b>(<i></i>)
1385 1275
1386 <p> 1276 <p>
1387 Public method to get the list of branches. 1277 Public method to get the list of branches.
1388 </p> 1278 </p>
1389 <dl> 1279 <dl>
1390 1280 <dt>Return:</dt>
1391 <dt><i>repodir</i></dt>
1392 <dd>
1393 directory name of the repository (string)
1394 </dd>
1395 </dl>
1396 <dl>
1397 <dt>Returns:</dt>
1398 <dd> 1281 <dd>
1399 list of branches (list of string) 1282 list of branches (list of string)
1400 </dd> 1283 </dd>
1401 </dl> 1284 </dl>
1402 <a NAME="Hg.hgGetCurrentBranch" ID="Hg.hgGetCurrentBranch"></a> 1285 <a NAME="Hg.hgGetCurrentBranch" ID="Hg.hgGetCurrentBranch"></a>
1403 <h4>Hg.hgGetCurrentBranch</h4> 1286 <h4>Hg.hgGetCurrentBranch</h4>
1404 <b>hgGetCurrentBranch</b>(<i>repodir</i>) 1287 <b>hgGetCurrentBranch</b>(<i></i>)
1405 1288
1406 <p> 1289 <p>
1407 Public method to get the current branch of the working directory. 1290 Public method to get the current branch of the working directory.
1408 </p> 1291 </p>
1409 <dl> 1292 <dl>
1410 1293 <dt>Return:</dt>
1411 <dt><i>repodir</i> (str)</dt>
1412 <dd>
1413 directory name of the repository
1414 </dd>
1415 </dl>
1416 <dl>
1417 <dt>Returns:</dt>
1418 <dd> 1294 <dd>
1419 name of the current branch 1295 name of the current branch
1420 </dd> 1296 </dd>
1421 </dl> 1297 </dl>
1422 <dl> 1298 <dl>
1425 str 1301 str
1426 </dd> 1302 </dd>
1427 </dl> 1303 </dl>
1428 <a NAME="Hg.hgGetTagsList" ID="Hg.hgGetTagsList"></a> 1304 <a NAME="Hg.hgGetTagsList" ID="Hg.hgGetTagsList"></a>
1429 <h4>Hg.hgGetTagsList</h4> 1305 <h4>Hg.hgGetTagsList</h4>
1430 <b>hgGetTagsList</b>(<i>repodir, withType=False</i>) 1306 <b>hgGetTagsList</b>(<i>withType=False</i>)
1431 1307
1432 <p> 1308 <p>
1433 Public method to get the list of tags. 1309 Public method to get the list of tags.
1434 </p> 1310 </p>
1435 <dl> 1311 <dl>
1436 1312
1437 <dt><i>repodir</i></dt>
1438 <dd>
1439 directory name of the repository (string)
1440 </dd>
1441 <dt><i>withType</i></dt> 1313 <dt><i>withType</i></dt>
1442 <dd> 1314 <dd>
1443 flag indicating to get the tag type as well (boolean) 1315 flag indicating to get the tag type as well (boolean)
1444 </dd> 1316 </dd>
1445 </dl> 1317 </dl>
1446 <dl> 1318 <dl>
1447 <dt>Returns:</dt> 1319 <dt>Return:</dt>
1448 <dd> 1320 <dd>
1449 list of tags (list of string) or list of tuples of 1321 list of tags (list of string) or list of tuples of
1450 tag name and flag indicating a local tag (list of tuple of string 1322 tag name and flag indicating a local tag (list of tuple of string
1451 and boolean), if withType is True 1323 and boolean), if withType is True
1452 </dd> 1324 </dd>
1453 </dl> 1325 </dl>
1454 <a NAME="Hg.hgGraft" ID="Hg.hgGraft"></a> 1326 <a NAME="Hg.hgGraft" ID="Hg.hgGraft"></a>
1455 <h4>Hg.hgGraft</h4> 1327 <h4>Hg.hgGraft</h4>
1456 <b>hgGraft</b>(<i>path, revs=None</i>) 1328 <b>hgGraft</b>(<i>revs=None</i>)
1457 1329
1458 <p> 1330 <p>
1459 Public method to copy changesets from another branch. 1331 Public method to copy changesets from another branch.
1460 </p> 1332 </p>
1461 <dl> 1333 <dl>
1462 1334
1463 <dt><i>path</i></dt>
1464 <dd>
1465 directory name of the project (string)
1466 </dd>
1467 <dt><i>revs</i></dt> 1335 <dt><i>revs</i></dt>
1468 <dd> 1336 <dd>
1469 list of revisions to show in the revisions pane (list of 1337 list of revisions to show in the revisions pane (list of
1470 strings) 1338 strings)
1471 </dd> 1339 </dd>
1472 </dl> 1340 </dl>
1473 <dl> 1341 <dl>
1474 <dt>Returns:</dt> 1342 <dt>Return:</dt>
1475 <dd> 1343 <dd>
1476 flag indicating that the project should be reread (boolean) 1344 flag indicating that the project should be reread (boolean)
1477 </dd> 1345 </dd>
1478 </dl> 1346 </dl>
1479 <a NAME="Hg.hgGraftAbort" ID="Hg.hgGraftAbort"></a> 1347 <a NAME="Hg.hgGraftAbort" ID="Hg.hgGraftAbort"></a>
1490 <dd> 1358 <dd>
1491 directory name of the project 1359 directory name of the project
1492 </dd> 1360 </dd>
1493 </dl> 1361 </dl>
1494 <dl> 1362 <dl>
1495 <dt>Returns:</dt> 1363 <dt>Return:</dt>
1496 <dd> 1364 <dd>
1497 flag indicating that the project should be reread 1365 flag indicating that the project should be reread
1498 </dd> 1366 </dd>
1499 </dl> 1367 </dl>
1500 <dl> 1368 <dl>
1516 <dd> 1384 <dd>
1517 directory name of the project 1385 directory name of the project
1518 </dd> 1386 </dd>
1519 </dl> 1387 </dl>
1520 <dl> 1388 <dl>
1521 <dt>Returns:</dt> 1389 <dt>Return:</dt>
1522 <dd> 1390 <dd>
1523 flag indicating that the project should be reread 1391 flag indicating that the project should be reread
1524 </dd> 1392 </dd>
1525 </dl> 1393 </dl>
1526 <dl> 1394 <dl>
1542 <dd> 1410 <dd>
1543 directory name of the project 1411 directory name of the project
1544 </dd> 1412 </dd>
1545 </dl> 1413 </dl>
1546 <dl> 1414 <dl>
1547 <dt>Returns:</dt> 1415 <dt>Return:</dt>
1548 <dd> 1416 <dd>
1549 flag indicating that the project should be reread 1417 flag indicating that the project should be reread
1550 </dd> 1418 </dd>
1551 </dl> 1419 </dl>
1552 <dl> 1420 <dl>
1555 bool 1423 bool
1556 </dd> 1424 </dd>
1557 </dl> 1425 </dl>
1558 <a NAME="Hg.hgIdentify" ID="Hg.hgIdentify"></a> 1426 <a NAME="Hg.hgIdentify" ID="Hg.hgIdentify"></a>
1559 <h4>Hg.hgIdentify</h4> 1427 <h4>Hg.hgIdentify</h4>
1560 <b>hgIdentify</b>(<i>name</i>) 1428 <b>hgIdentify</b>(<i></i>)
1561 1429
1562 <p> 1430 <p>
1563 Public method to identify the current working directory. 1431 Public method to identify the current working directory.
1564 </p> 1432 </p>
1565 <dl>
1566
1567 <dt><i>name</i></dt>
1568 <dd>
1569 file/directory name (string)
1570 </dd>
1571 </dl>
1572 <a NAME="Hg.hgImport" ID="Hg.hgImport"></a> 1433 <a NAME="Hg.hgImport" ID="Hg.hgImport"></a>
1573 <h4>Hg.hgImport</h4> 1434 <h4>Hg.hgImport</h4>
1574 <b>hgImport</b>(<i>name</i>) 1435 <b>hgImport</b>(<i></i>)
1575 1436
1576 <p> 1437 <p>
1577 Public method to import a patch file. 1438 Public method to import a patch file.
1578 </p> 1439 </p>
1579 <dl> 1440 <dl>
1580 1441 <dt>Return:</dt>
1581 <dt><i>name</i></dt>
1582 <dd>
1583 directory name of the project to import into (string)
1584 </dd>
1585 </dl>
1586 <dl>
1587 <dt>Returns:</dt>
1588 <dd> 1442 <dd>
1589 flag indicating, that the import contained an add, a delete 1443 flag indicating, that the import contained an add, a delete
1590 or a change to the project file (boolean) 1444 or a change to the project file (boolean)
1591 </dd> 1445 </dd>
1592 </dl> 1446 </dl>
1593 <a NAME="Hg.hgIncoming" ID="Hg.hgIncoming"></a> 1447 <a NAME="Hg.hgIncoming" ID="Hg.hgIncoming"></a>
1594 <h4>Hg.hgIncoming</h4> 1448 <h4>Hg.hgIncoming</h4>
1595 <b>hgIncoming</b>(<i>name</i>) 1449 <b>hgIncoming</b>(<i></i>)
1596 1450
1597 <p> 1451 <p>
1598 Public method used to view the log of incoming changes from the 1452 Public method used to view the log of incoming changes from the
1599 Mercurial repository. 1453 Mercurial repository.
1600 </p> 1454 </p>
1601 <dl>
1602
1603 <dt><i>name</i></dt>
1604 <dd>
1605 file/directory name to show the log of (string)
1606 </dd>
1607 </dl>
1608 <a NAME="Hg.hgInfo" ID="Hg.hgInfo"></a> 1455 <a NAME="Hg.hgInfo" ID="Hg.hgInfo"></a>
1609 <h4>Hg.hgInfo</h4> 1456 <h4>Hg.hgInfo</h4>
1610 <b>hgInfo</b>(<i>ppath, mode="heads"</i>) 1457 <b>hgInfo</b>(<i>mode="heads"</i>)
1611 1458
1612 <p> 1459 <p>
1613 Public method to show information about the heads of the repository. 1460 Public method to show information about the heads of the repository.
1614 </p> 1461 </p>
1615 <dl> 1462 <dl>
1616 1463
1617 <dt><i>ppath</i></dt> 1464 <dt><i>mode</i></dt>
1618 <dd>
1619 local path to get the repository infos (string)
1620 </dd>
1621 <dt><i>mode=</i></dt>
1622 <dd> 1465 <dd>
1623 mode of the operation (string, one of heads, parents, 1466 mode of the operation (string, one of heads, parents,
1624 tip) 1467 tip)
1625 </dd> 1468 </dd>
1626 </dl> 1469 </dl>
1627 <a NAME="Hg.hgListBookmarks" ID="Hg.hgListBookmarks"></a> 1470 <a NAME="Hg.hgListBookmarks" ID="Hg.hgListBookmarks"></a>
1628 <h4>Hg.hgListBookmarks</h4> 1471 <h4>Hg.hgListBookmarks</h4>
1629 <b>hgListBookmarks</b>(<i>path</i>) 1472 <b>hgListBookmarks</b>(<i></i>)
1630 1473
1631 <p> 1474 <p>
1632 Public method used to list the available bookmarks. 1475 Public method used to list the available bookmarks.
1633 </p> 1476 </p>
1634 <dl>
1635
1636 <dt><i>path</i></dt>
1637 <dd>
1638 directory name of the project (string)
1639 </dd>
1640 </dl>
1641 <a NAME="Hg.hgListTagBranch" ID="Hg.hgListTagBranch"></a> 1477 <a NAME="Hg.hgListTagBranch" ID="Hg.hgListTagBranch"></a>
1642 <h4>Hg.hgListTagBranch</h4> 1478 <h4>Hg.hgListTagBranch</h4>
1643 <b>hgListTagBranch</b>(<i>path, tags=True</i>) 1479 <b>hgListTagBranch</b>(<i>tags=True</i>)
1644 1480
1645 <p> 1481 <p>
1646 Public method used to list the available tags or branches. 1482 Public method used to list the available tags or branches.
1647 </p> 1483 </p>
1648 <dl> 1484 <dl>
1649 1485
1650 <dt><i>path</i></dt>
1651 <dd>
1652 directory name of the project (string)
1653 </dd>
1654 <dt><i>tags</i></dt> 1486 <dt><i>tags</i></dt>
1655 <dd> 1487 <dd>
1656 flag indicating listing of branches or tags 1488 flag indicating listing of branches or tags
1657 (False = branches, True = tags) 1489 (False = branches, True = tags)
1658 </dd> 1490 </dd>
1670 <dd> 1502 <dd>
1671 url string (string) 1503 url string (string)
1672 </dd> 1504 </dd>
1673 </dl> 1505 </dl>
1674 <dl> 1506 <dl>
1675 <dt>Returns:</dt> 1507 <dt>Return:</dt>
1676 <dd> 1508 <dd>
1677 properly normalized url for mercurial (string) 1509 properly normalized url for mercurial (string)
1678 </dd> 1510 </dd>
1679 </dl> 1511 </dl>
1680 <a NAME="Hg.hgOutgoing" ID="Hg.hgOutgoing"></a> 1512 <a NAME="Hg.hgOutgoing" ID="Hg.hgOutgoing"></a>
1681 <h4>Hg.hgOutgoing</h4> 1513 <h4>Hg.hgOutgoing</h4>
1682 <b>hgOutgoing</b>(<i>name</i>) 1514 <b>hgOutgoing</b>(<i></i>)
1683 1515
1684 <p> 1516 <p>
1685 Public method used to view the log of outgoing changes from the 1517 Public method used to view the log of outgoing changes from the
1686 Mercurial repository. 1518 Mercurial repository.
1687 </p> 1519 </p>
1688 <dl>
1689
1690 <dt><i>name</i></dt>
1691 <dd>
1692 file/directory name to show the log of (string)
1693 </dd>
1694 </dl>
1695 <a NAME="Hg.hgPhase" ID="Hg.hgPhase"></a> 1520 <a NAME="Hg.hgPhase" ID="Hg.hgPhase"></a>
1696 <h4>Hg.hgPhase</h4> 1521 <h4>Hg.hgPhase</h4>
1697 <b>hgPhase</b>(<i>name, data=None</i>) 1522 <b>hgPhase</b>(<i>data=None</i>)
1698 1523
1699 <p> 1524 <p>
1700 Public method to change the phase of revisions. 1525 Public method to change the phase of revisions.
1701 </p> 1526 </p>
1702 <dl> 1527 <dl>
1703 1528
1704 <dt><i>name</i></dt>
1705 <dd>
1706 directory name of the project to export from (string)
1707 </dd>
1708 <dt><i>data</i></dt> 1529 <dt><i>data</i></dt>
1709 <dd> 1530 <dd>
1710 tuple giving phase data (list of revisions, phase, flag 1531 tuple giving phase data (list of revisions, phase, flag
1711 indicating a forced operation) (list of strings, string, boolean) 1532 indicating a forced operation) (list of strings, string, boolean)
1712 </dd> 1533 </dd>
1713 </dl> 1534 </dl>
1714 <dl> 1535 <dl>
1715 <dt>Returns:</dt> 1536 <dt>Return:</dt>
1716 <dd> 1537 <dd>
1717 flag indicating success (boolean) 1538 flag indicating success (boolean)
1718 </dd> 1539 </dd>
1719 </dl> 1540 </dl>
1720 <dl> 1541 <dl>
1724 raised to indicate an invalid phase 1545 raised to indicate an invalid phase
1725 </dd> 1546 </dd>
1726 </dl> 1547 </dl>
1727 <a NAME="Hg.hgPreviewBundle" ID="Hg.hgPreviewBundle"></a> 1548 <a NAME="Hg.hgPreviewBundle" ID="Hg.hgPreviewBundle"></a>
1728 <h4>Hg.hgPreviewBundle</h4> 1549 <h4>Hg.hgPreviewBundle</h4>
1729 <b>hgPreviewBundle</b>(<i>name</i>) 1550 <b>hgPreviewBundle</b>(<i></i>)
1730 1551
1731 <p> 1552 <p>
1732 Public method used to view the log of incoming changes from a 1553 Public method used to view the log of incoming changes from a
1733 changegroup file. 1554 changegroup file.
1734 </p> 1555 </p>
1735 <dl>
1736
1737 <dt><i>name</i></dt>
1738 <dd>
1739 directory name on which to base the changegroup (string)
1740 </dd>
1741 </dl>
1742 <a NAME="Hg.hgPull" ID="Hg.hgPull"></a> 1556 <a NAME="Hg.hgPull" ID="Hg.hgPull"></a>
1743 <h4>Hg.hgPull</h4> 1557 <h4>Hg.hgPull</h4>
1744 <b>hgPull</b>(<i>name, revisions=None</i>) 1558 <b>hgPull</b>(<i>revisions=None</i>)
1745 1559
1746 <p> 1560 <p>
1747 Public method used to pull changes from a remote Mercurial repository. 1561 Public method used to pull changes from a remote Mercurial repository.
1748 </p> 1562 </p>
1749 <dl> 1563 <dl>
1750 1564
1751 <dt><i>name</i> (str)</dt>
1752 <dd>
1753 directory name of the project to be pulled to
1754 </dd>
1755 <dt><i>revisions</i> (list of str)</dt> 1565 <dt><i>revisions</i> (list of str)</dt>
1756 <dd> 1566 <dd>
1757 list of revisions to be pulled 1567 list of revisions to be pulled
1758 </dd> 1568 </dd>
1759 </dl> 1569 </dl>
1760 <dl> 1570 <dl>
1761 <dt>Returns:</dt> 1571 <dt>Return:</dt>
1762 <dd> 1572 <dd>
1763 flag indicating, that the update contained an add 1573 flag indicating, that the update contained an add
1764 or delete 1574 or delete
1765 </dd> 1575 </dd>
1766 </dl> 1576 </dl>
1770 bool 1580 bool
1771 </dd> 1581 </dd>
1772 </dl> 1582 </dl>
1773 <a NAME="Hg.hgPush" ID="Hg.hgPush"></a> 1583 <a NAME="Hg.hgPush" ID="Hg.hgPush"></a>
1774 <h4>Hg.hgPush</h4> 1584 <h4>Hg.hgPush</h4>
1775 <b>hgPush</b>(<i>name, force=False, newBranch=False, rev=None</i>) 1585 <b>hgPush</b>(<i>force=False, newBranch=False, rev=None</i>)
1776 1586
1777 <p> 1587 <p>
1778 Public method used to push changes to a remote Mercurial repository. 1588 Public method used to push changes to a remote Mercurial repository.
1779 </p> 1589 </p>
1780 <dl> 1590 <dl>
1781 1591
1782 <dt><i>name</i></dt> 1592 <dt><i>force</i></dt>
1783 <dd>
1784 directory name of the project to be pushed from (string)
1785 </dd>
1786 <dt><i>force=</i></dt>
1787 <dd> 1593 <dd>
1788 flag indicating a forced push (boolean) 1594 flag indicating a forced push (boolean)
1789 </dd> 1595 </dd>
1790 <dt><i>newBranch=</i></dt> 1596 <dt><i>newBranch</i></dt>
1791 <dd> 1597 <dd>
1792 flag indicating to push a new branch (boolean) 1598 flag indicating to push a new branch (boolean)
1793 </dd> 1599 </dd>
1794 <dt><i>rev=</i></dt> 1600 <dt><i>rev</i></dt>
1795 <dd> 1601 <dd>
1796 revision to be pushed (including all ancestors) (string) 1602 revision to be pushed (including all ancestors) (string)
1797 </dd> 1603 </dd>
1798 </dl> 1604 </dl>
1799 <a NAME="Hg.hgReMerge" ID="Hg.hgReMerge"></a> 1605 <a NAME="Hg.hgReMerge" ID="Hg.hgReMerge"></a>
1810 file/directory name to be merged (string) 1616 file/directory name to be merged (string)
1811 </dd> 1617 </dd>
1812 </dl> 1618 </dl>
1813 <a NAME="Hg.hgRecover" ID="Hg.hgRecover"></a> 1619 <a NAME="Hg.hgRecover" ID="Hg.hgRecover"></a>
1814 <h4>Hg.hgRecover</h4> 1620 <h4>Hg.hgRecover</h4>
1815 <b>hgRecover</b>(<i>name</i>) 1621 <b>hgRecover</b>(<i></i>)
1816 1622
1817 <p> 1623 <p>
1818 Public method to recover an interrupted transaction. 1624 Public method to recover an interrupted transaction.
1819 </p> 1625 </p>
1820 <dl>
1821
1822 <dt><i>name</i></dt>
1823 <dd>
1824 file/directory name (string)
1825 </dd>
1826 </dl>
1827 <a NAME="Hg.hgRemoveSubrepositories" ID="Hg.hgRemoveSubrepositories"></a> 1626 <a NAME="Hg.hgRemoveSubrepositories" ID="Hg.hgRemoveSubrepositories"></a>
1828 <h4>Hg.hgRemoveSubrepositories</h4> 1627 <h4>Hg.hgRemoveSubrepositories</h4>
1829 <b>hgRemoveSubrepositories</b>(<i></i>) 1628 <b>hgRemoveSubrepositories</b>(<i></i>)
1830 1629
1831 <p> 1630 <p>
1863 <dd> 1662 <dd>
1864 file/directory name to be reverted (string) 1663 file/directory name to be reverted (string)
1865 </dd> 1664 </dd>
1866 </dl> 1665 </dl>
1867 <dl> 1666 <dl>
1868 <dt>Returns:</dt> 1667 <dt>Return:</dt>
1869 <dd> 1668 <dd>
1870 flag indicating, that the update contained an add 1669 flag indicating, that the update contained an add
1871 or delete (boolean) 1670 or delete (boolean)
1872 </dd> 1671 </dd>
1873 </dl> 1672 </dl>
1874 <a NAME="Hg.hgRollback" ID="Hg.hgRollback"></a> 1673 <a NAME="Hg.hgRollback" ID="Hg.hgRollback"></a>
1875 <h4>Hg.hgRollback</h4> 1674 <h4>Hg.hgRollback</h4>
1876 <b>hgRollback</b>(<i>name</i>) 1675 <b>hgRollback</b>(<i></i>)
1877 1676
1878 <p> 1677 <p>
1879 Public method used to rollback the last transaction. 1678 Public method used to rollback the last transaction.
1880 </p> 1679 </p>
1881 <dl>
1882
1883 <dt><i>name</i></dt>
1884 <dd>
1885 directory name (string or list of strings)
1886 </dd>
1887 </dl>
1888 <a NAME="Hg.hgSbsDiff" ID="Hg.hgSbsDiff"></a> 1680 <a NAME="Hg.hgSbsDiff" ID="Hg.hgSbsDiff"></a>
1889 <h4>Hg.hgSbsDiff</h4> 1681 <h4>Hg.hgSbsDiff</h4>
1890 <b>hgSbsDiff</b>(<i>name, extended=False, revisions=None</i>) 1682 <b>hgSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
1891 1683
1892 <p> 1684 <p>
1897 1689
1898 <dt><i>name</i></dt> 1690 <dt><i>name</i></dt>
1899 <dd> 1691 <dd>
1900 file name to be diffed (string) 1692 file name to be diffed (string)
1901 </dd> 1693 </dd>
1902 <dt><i>extended=</i></dt> 1694 <dt><i>extended</i></dt>
1903 <dd> 1695 <dd>
1904 flag indicating the extended variant (boolean) 1696 flag indicating the extended variant (boolean)
1905 </dd> 1697 </dd>
1906 <dt><i>revisions=</i></dt> 1698 <dt><i>revisions</i></dt>
1907 <dd> 1699 <dd>
1908 tuple of two revisions (tuple of strings) 1700 tuple of two revisions (tuple of strings)
1909 </dd> 1701 </dd>
1910 </dl> 1702 </dl>
1911 <dl> 1703 <dl>
1915 raised to indicate an invalid name parameter 1707 raised to indicate an invalid name parameter
1916 </dd> 1708 </dd>
1917 </dl> 1709 </dl>
1918 <a NAME="Hg.hgServe" ID="Hg.hgServe"></a> 1710 <a NAME="Hg.hgServe" ID="Hg.hgServe"></a>
1919 <h4>Hg.hgServe</h4> 1711 <h4>Hg.hgServe</h4>
1920 <b>hgServe</b>(<i>name</i>) 1712 <b>hgServe</b>(<i>repoPath</i>)
1921 1713
1922 <p> 1714 <p>
1923 Public method used to serve the project. 1715 Public method used to serve the project.
1924 </p> 1716 </p>
1925 <dl> 1717 <dl>
1926 1718
1927 <dt><i>name</i></dt> 1719 <dt><i>repoPath</i> (str)</dt>
1928 <dd> 1720 <dd>
1929 directory name (string) 1721 directory containing the repository
1930 </dd> 1722 </dd>
1931 </dl> 1723 </dl>
1932 <a NAME="Hg.hgShowBranch" ID="Hg.hgShowBranch"></a> 1724 <a NAME="Hg.hgShowBranch" ID="Hg.hgShowBranch"></a>
1933 <h4>Hg.hgShowBranch</h4> 1725 <h4>Hg.hgShowBranch</h4>
1934 <b>hgShowBranch</b>(<i>name</i>) 1726 <b>hgShowBranch</b>(<i></i>)
1935 1727
1936 <p> 1728 <p>
1937 Public method used to show the current branch of the working directory. 1729 Public method used to show the current branch of the working directory.
1938 </p> 1730 </p>
1939 <dl>
1940
1941 <dt><i>name</i></dt>
1942 <dd>
1943 file/directory name (string)
1944 </dd>
1945 </dl>
1946 <a NAME="Hg.hgShowConfig" ID="Hg.hgShowConfig"></a> 1731 <a NAME="Hg.hgShowConfig" ID="Hg.hgShowConfig"></a>
1947 <h4>Hg.hgShowConfig</h4> 1732 <h4>Hg.hgShowConfig</h4>
1948 <b>hgShowConfig</b>(<i>name</i>) 1733 <b>hgShowConfig</b>(<i></i>)
1949 1734
1950 <p> 1735 <p>
1951 Public method to show the combined configuration. 1736 Public method to show the combined configuration.
1952 </p> 1737 </p>
1953 <dl>
1954
1955 <dt><i>name</i></dt>
1956 <dd>
1957 file/directory name (string)
1958 </dd>
1959 </dl>
1960 <a NAME="Hg.hgShowPaths" ID="Hg.hgShowPaths"></a> 1738 <a NAME="Hg.hgShowPaths" ID="Hg.hgShowPaths"></a>
1961 <h4>Hg.hgShowPaths</h4> 1739 <h4>Hg.hgShowPaths</h4>
1962 <b>hgShowPaths</b>(<i>name</i>) 1740 <b>hgShowPaths</b>(<i></i>)
1963 1741
1964 <p> 1742 <p>
1965 Public method to show the path aliases for remote repositories. 1743 Public method to show the path aliases for remote repositories.
1966 </p> 1744 </p>
1967 <dl>
1968
1969 <dt><i>name</i></dt>
1970 <dd>
1971 file/directory name (string)
1972 </dd>
1973 </dl>
1974 <a NAME="Hg.hgSummary" ID="Hg.hgSummary"></a> 1745 <a NAME="Hg.hgSummary" ID="Hg.hgSummary"></a>
1975 <h4>Hg.hgSummary</h4> 1746 <h4>Hg.hgSummary</h4>
1976 <b>hgSummary</b>(<i>mq=False, largefiles=False</i>) 1747 <b>hgSummary</b>(<i>mq=False, largefiles=False</i>)
1977 1748
1978 <p> 1749 <p>
1991 well (boolean) 1762 well (boolean)
1992 </dd> 1763 </dd>
1993 </dl> 1764 </dl>
1994 <a NAME="Hg.hgUnbundle" ID="Hg.hgUnbundle"></a> 1765 <a NAME="Hg.hgUnbundle" ID="Hg.hgUnbundle"></a>
1995 <h4>Hg.hgUnbundle</h4> 1766 <h4>Hg.hgUnbundle</h4>
1996 <b>hgUnbundle</b>(<i>name, files=None</i>) 1767 <b>hgUnbundle</b>(<i>files=None</i>)
1997 1768
1998 <p> 1769 <p>
1999 Public method to apply changegroup files. 1770 Public method to apply changegroup files.
2000 </p> 1771 </p>
2001 <dl> 1772 <dl>
2002 1773
2003 <dt><i>name</i> (str)</dt>
2004 <dd>
2005 directory name
2006 </dd>
2007 <dt><i>files</i> (list of str)</dt> 1774 <dt><i>files</i> (list of str)</dt>
2008 <dd> 1775 <dd>
2009 list of bundle files to be applied 1776 list of bundle files to be applied
2010 </dd> 1777 </dd>
2011 </dl> 1778 </dl>
2012 <dl> 1779 <dl>
2013 <dt>Returns:</dt> 1780 <dt>Return:</dt>
2014 <dd> 1781 <dd>
2015 flag indicating, that the update contained an add 1782 flag indicating, that the update contained an add
2016 or delete 1783 or delete
2017 </dd> 1784 </dd>
2018 </dl> 1785 </dl>
2022 bool 1789 bool
2023 </dd> 1790 </dd>
2024 </dl> 1791 </dl>
2025 <a NAME="Hg.hgVerify" ID="Hg.hgVerify"></a> 1792 <a NAME="Hg.hgVerify" ID="Hg.hgVerify"></a>
2026 <h4>Hg.hgVerify</h4> 1793 <h4>Hg.hgVerify</h4>
2027 <b>hgVerify</b>(<i>name</i>) 1794 <b>hgVerify</b>(<i></i>)
2028 1795
2029 <p> 1796 <p>
2030 Public method to verify the integrity of the repository. 1797 Public method to verify the integrity of the repository.
2031 </p> 1798 </p>
2032 <dl>
2033
2034 <dt><i>name</i></dt>
2035 <dd>
2036 file/directory name (string)
2037 </dd>
2038 </dl>
2039 <a NAME="Hg.initCommand" ID="Hg.initCommand"></a> 1799 <a NAME="Hg.initCommand" ID="Hg.initCommand"></a>
2040 <h4>Hg.initCommand</h4> 1800 <h4>Hg.initCommand</h4>
2041 <b>initCommand</b>(<i>command</i>) 1801 <b>initCommand</b>(<i>command</i>)
2042 1802
2043 <p> 1803 <p>
2049 <dd> 1809 <dd>
2050 command name (string) 1810 command name (string)
2051 </dd> 1811 </dd>
2052 </dl> 1812 </dl>
2053 <dl> 1813 <dl>
2054 <dt>Returns:</dt> 1814 <dt>Return:</dt>
2055 <dd> 1815 <dd>
2056 list of command options (list of string) 1816 list of command options (list of string)
2057 </dd> 1817 </dd>
2058 </dl> 1818 </dl>
2059 <a NAME="Hg.isExtensionActive" ID="Hg.isExtensionActive"></a> 1819 <a NAME="Hg.isExtensionActive" ID="Hg.isExtensionActive"></a>
2069 <dd> 1829 <dd>
2070 name of the extension to check for (string) 1830 name of the extension to check for (string)
2071 </dd> 1831 </dd>
2072 </dl> 1832 </dl>
2073 <dl> 1833 <dl>
2074 <dt>Returns:</dt> 1834 <dt>Return:</dt>
2075 <dd> 1835 <dd>
2076 flag indicating an active extension (boolean) 1836 flag indicating an active extension (boolean)
2077 </dd> 1837 </dd>
2078 </dl> 1838 </dl>
2079 <a NAME="Hg.stopClient" ID="Hg.stopClient"></a> 1839 <a NAME="Hg.stopClient" ID="Hg.stopClient"></a>
2167 <dd> 1927 <dd>
2168 flag indicating a shortcut should be taken (boolean) 1928 flag indicating a shortcut should be taken (boolean)
2169 </dd> 1929 </dd>
2170 </dl> 1930 </dl>
2171 <dl> 1931 <dl>
2172 <dt>Returns:</dt> 1932 <dt>Return:</dt>
2173 <dd> 1933 <dd>
2174 the received dictionary completed with a combination of 1934 the received dictionary completed with a combination of
2175 canBeCommited and canBeAdded or None in order to signal an error 1935 canBeCommited and canBeAdded or None in order to signal an error
2176 </dd> 1936 </dd>
2177 </dl> 1937 </dl>
2197 <dd> 1957 <dd>
2198 flag indicating quiet operations 1958 flag indicating quiet operations
2199 </dd> 1959 </dd>
2200 </dl> 1960 </dl>
2201 <dl> 1961 <dl>
2202 <dt>Returns:</dt> 1962 <dt>Return:</dt>
2203 <dd> 1963 <dd>
2204 flag indicating an execution without errors (boolean) 1964 flag indicating an execution without errors (boolean)
2205 </dd> 1965 </dd>
2206 </dl> 1966 </dl>
2207 <a NAME="Hg.vcsCleanup" ID="Hg.vcsCleanup"></a> 1967 <a NAME="Hg.vcsCleanup" ID="Hg.vcsCleanup"></a>
2253 </dd> 2013 </dd>
2254 <dt><i>noDialog</i></dt> 2014 <dt><i>noDialog</i></dt>
2255 <dd> 2015 <dd>
2256 flag indicating quiet operations 2016 flag indicating quiet operations
2257 </dd> 2017 </dd>
2258 <dt><i>closeBranch=</i></dt> 2018 <dt><i>closeBranch</i></dt>
2259 <dd> 2019 <dd>
2260 flag indicating a close branch commit (boolean) 2020 flag indicating a close branch commit (boolean)
2261 </dd> 2021 </dd>
2262 <dt><i>mq=</i></dt> 2022 <dt><i>mq</i></dt>
2263 <dd> 2023 <dd>
2264 flag indicating a queue commit (boolean) 2024 flag indicating a queue commit (boolean)
2265 </dd> 2025 </dd>
2266 <dt><i>merge=</i></dt> 2026 <dt><i>merge</i></dt>
2267 <dd> 2027 <dd>
2268 flag indicating a merge commit (boolean) 2028 flag indicating a merge commit (boolean)
2269 </dd> 2029 </dd>
2270 </dl> 2030 </dl>
2271 <a NAME="Hg.vcsConvertProject" ID="Hg.vcsConvertProject"></a> 2031 <a NAME="Hg.vcsConvertProject" ID="Hg.vcsConvertProject"></a>
2318 2078
2319 <p> 2079 <p>
2320 Public method used to test for the presence of the hg executable. 2080 Public method used to test for the presence of the hg executable.
2321 </p> 2081 </p>
2322 <dl> 2082 <dl>
2323 <dt>Returns:</dt> 2083 <dt>Return:</dt>
2324 <dd> 2084 <dd>
2325 flag indicating the existence (boolean) and an error message 2085 flag indicating the existence (boolean) and an error message
2326 (string) 2086 (string)
2327 </dd> 2087 </dd>
2328 </dl> 2088 </dl>
2343 <dd> 2103 <dd>
2344 project directory to create (string) 2104 project directory to create (string)
2345 </dd> 2105 </dd>
2346 </dl> 2106 </dl>
2347 <dl> 2107 <dl>
2348 <dt>Returns:</dt> 2108 <dt>Return:</dt>
2349 <dd> 2109 <dd>
2350 flag indicating an execution without errors (boolean) 2110 flag indicating an execution without errors (boolean)
2351 </dd> 2111 </dd>
2352 </dl> 2112 </dl>
2353 <a NAME="Hg.vcsGetProjectBrowserHelper" ID="Hg.vcsGetProjectBrowserHelper"></a> 2113 <a NAME="Hg.vcsGetProjectBrowserHelper" ID="Hg.vcsGetProjectBrowserHelper"></a>
2373 flag indicating, the helper is requested 2133 flag indicating, the helper is requested
2374 for the translations browser (this needs some special treatment) 2134 for the translations browser (this needs some special treatment)
2375 </dd> 2135 </dd>
2376 </dl> 2136 </dl>
2377 <dl> 2137 <dl>
2378 <dt>Returns:</dt> 2138 <dt>Return:</dt>
2379 <dd> 2139 <dd>
2380 the project browser helper object 2140 the project browser helper object
2381 </dd> 2141 </dd>
2382 </dl> 2142 </dl>
2383 <a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a> 2143 <a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a>
2393 <dd> 2153 <dd>
2394 reference to the project object 2154 reference to the project object
2395 </dd> 2155 </dd>
2396 </dl> 2156 </dl>
2397 <dl> 2157 <dl>
2398 <dt>Returns:</dt> 2158 <dt>Return:</dt>
2399 <dd> 2159 <dd>
2400 the project helper object 2160 the project helper object
2401 </dd> 2161 </dd>
2402 </dl> 2162 </dl>
2403 <a NAME="Hg.vcsImport" ID="Hg.vcsImport"></a> 2163 <a NAME="Hg.vcsImport" ID="Hg.vcsImport"></a>
2425 <dd> 2185 <dd>
2426 flag indicating to add all files to the repository 2186 flag indicating to add all files to the repository
2427 </dd> 2187 </dd>
2428 </dl> 2188 </dl>
2429 <dl> 2189 <dl>
2430 <dt>Returns:</dt> 2190 <dt>Return:</dt>
2431 <dd> 2191 <dd>
2432 tuple containing a flag indicating an execution without errors 2192 tuple containing a flag indicating an execution without errors
2433 and a flag indicating the version controll status 2193 and a flag indicating the version controll status
2434 </dd> 2194 </dd>
2435 </dl> 2195 </dl>
2461 <dd> 2221 <dd>
2462 flag indicating quiet operations (boolean) 2222 flag indicating quiet operations (boolean)
2463 </dd> 2223 </dd>
2464 </dl> 2224 </dl>
2465 <dl> 2225 <dl>
2466 <dt>Returns:</dt> 2226 <dt>Return:</dt>
2467 <dd> 2227 <dd>
2468 always TRUE 2228 always TRUE
2469 </dd> 2229 </dd>
2470 </dl> 2230 </dl>
2471 <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a> 2231 <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a>
2485 reference to the project (Project) 2245 reference to the project (Project)
2486 </dd> 2246 </dd>
2487 </dl> 2247 </dl>
2488 <a NAME="Hg.vcsLogBrowser" ID="Hg.vcsLogBrowser"></a> 2248 <a NAME="Hg.vcsLogBrowser" ID="Hg.vcsLogBrowser"></a>
2489 <h4>Hg.vcsLogBrowser</h4> 2249 <h4>Hg.vcsLogBrowser</h4>
2490 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) 2250 <b>vcsLogBrowser</b>(<i>name=None, isFile=False</i>)
2491 2251
2492 <p> 2252 <p>
2493 Public method used to browse the log of a file/directory from the 2253 Public method used to browse the log of a file/directory from the
2494 Mercurial repository. 2254 Mercurial repository.
2495 </p> 2255 </p>
2497 2257
2498 <dt><i>name</i></dt> 2258 <dt><i>name</i></dt>
2499 <dd> 2259 <dd>
2500 file/directory name to show the log of (string) 2260 file/directory name to show the log of (string)
2501 </dd> 2261 </dd>
2502 <dt><i>isFile=</i></dt> 2262 <dt><i>isFile</i></dt>
2503 <dd> 2263 <dd>
2504 flag indicating log for a file is to be shown 2264 flag indicating log for a file is to be shown
2505 (boolean) 2265 (boolean)
2506 </dd> 2266 </dd>
2507 </dl> 2267 </dl>
2516 2276
2517 <dt><i>name</i> (str)</dt> 2277 <dt><i>name</i> (str)</dt>
2518 <dd> 2278 <dd>
2519 file/directory name to be merged 2279 file/directory name to be merged
2520 </dd> 2280 </dd>
2521 <dt><i>rev=</i> (str)</dt> 2281 <dt><i>rev</i> (str)</dt>
2522 <dd> 2282 <dd>
2523 revision to merge with 2283 revision to merge with
2524 </dd> 2284 </dd>
2525 </dl> 2285 </dl>
2526 <a NAME="Hg.vcsMove" ID="Hg.vcsMove"></a> 2286 <a NAME="Hg.vcsMove" ID="Hg.vcsMove"></a>
2548 <dd> 2308 <dd>
2549 flag indicating quiet operations 2309 flag indicating quiet operations
2550 </dd> 2310 </dd>
2551 </dl> 2311 </dl>
2552 <dl> 2312 <dl>
2553 <dt>Returns:</dt> 2313 <dt>Return:</dt>
2554 <dd> 2314 <dd>
2555 flag indicating successfull operation (boolean) 2315 flag indicating successfull operation (boolean)
2556 </dd> 2316 </dd>
2557 </dl> 2317 </dl>
2558 <a NAME="Hg.vcsName" ID="Hg.vcsName"></a> 2318 <a NAME="Hg.vcsName" ID="Hg.vcsName"></a>
2561 2321
2562 <p> 2322 <p>
2563 Public method returning the name of the vcs. 2323 Public method returning the name of the vcs.
2564 </p> 2324 </p>
2565 <dl> 2325 <dl>
2566 <dt>Returns:</dt> 2326 <dt>Return:</dt>
2567 <dd> 2327 <dd>
2568 always 'Mercurial' (string) 2328 always 'Mercurial' (string)
2569 </dd> 2329 </dd>
2570 </dl> 2330 </dl>
2571 <a NAME="Hg.vcsNewProjectOptionsDialog" ID="Hg.vcsNewProjectOptionsDialog"></a> 2331 <a NAME="Hg.vcsNewProjectOptionsDialog" ID="Hg.vcsNewProjectOptionsDialog"></a>
2582 <dd> 2342 <dd>
2583 parent widget (QWidget) 2343 parent widget (QWidget)
2584 </dd> 2344 </dd>
2585 </dl> 2345 </dl>
2586 <dl> 2346 <dl>
2587 <dt>Returns:</dt> 2347 <dt>Return:</dt>
2588 <dd> 2348 <dd>
2589 reference to the instantiated options dialog 2349 reference to the instantiated options dialog
2590 (HgNewProjectOptionsDialog) 2350 (HgNewProjectOptionsDialog)
2591 </dd> 2351 </dd>
2592 </dl> 2352 </dl>
2616 <dd> 2376 <dd>
2617 parent widget (QWidget) 2377 parent widget (QWidget)
2618 </dd> 2378 </dd>
2619 </dl> 2379 </dl>
2620 <dl> 2380 <dl>
2621 <dt>Returns:</dt> 2381 <dt>Return:</dt>
2622 <dd> 2382 <dd>
2623 reference to the instantiated options dialog (HgOptionsDialog) 2383 reference to the instantiated options dialog (HgOptionsDialog)
2624 </dd> 2384 </dd>
2625 </dl> 2385 </dl>
2626 <a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a> 2386 <a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a>
2630 <p> 2390 <p>
2631 Public method used to get the registered state of a file in the vcs. 2391 Public method used to get the registered state of a file in the vcs.
2632 </p> 2392 </p>
2633 <dl> 2393 <dl>
2634 2394
2635 <dt><i>name</i></dt> 2395 <dt><i>name</i> (str)</dt>
2636 <dd> 2396 <dd>
2637 filename to check (string) 2397 file or directory name to check
2638 </dd> 2398 </dd>
2639 </dl> 2399 </dl>
2640 <dl> 2400 <dl>
2641 <dt>Returns:</dt> 2401 <dt>Return:</dt>
2642 <dd> 2402 <dd>
2643 a combination of canBeCommited and canBeAdded 2403 a combination of canBeCommited and canBeAdded
2404 </dd>
2405 </dl>
2406 <dl>
2407 <dt>Return Type:</dt>
2408 <dd>
2409 int
2644 </dd> 2410 </dd>
2645 </dl> 2411 </dl>
2646 <a NAME="Hg.vcsRemove" ID="Hg.vcsRemove"></a> 2412 <a NAME="Hg.vcsRemove" ID="Hg.vcsRemove"></a>
2647 <h4>Hg.vcsRemove</h4> 2413 <h4>Hg.vcsRemove</h4>
2648 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) 2414 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
2670 <dd> 2436 <dd>
2671 flag indicating quiet operations 2437 flag indicating quiet operations
2672 </dd> 2438 </dd>
2673 </dl> 2439 </dl>
2674 <dl> 2440 <dl>
2675 <dt>Returns:</dt> 2441 <dt>Return:</dt>
2676 <dd> 2442 <dd>
2677 flag indicating successfull operation (boolean) 2443 flag indicating successfull operation (boolean)
2678 </dd> 2444 </dd>
2679 </dl> 2445 </dl>
2680 <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a> 2446 <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a>
2690 <dd> 2456 <dd>
2691 local path to get the repository infos (string) 2457 local path to get the repository infos (string)
2692 </dd> 2458 </dd>
2693 </dl> 2459 </dl>
2694 <dl> 2460 <dl>
2695 <dt>Returns:</dt> 2461 <dt>Return:</dt>
2696 <dd> 2462 <dd>
2697 string with ready formated info for display (string) 2463 string with ready formated info for display (string)
2698 </dd> 2464 </dd>
2699 </dl> 2465 </dl>
2700 <a NAME="Hg.vcsShutdown" ID="Hg.vcsShutdown"></a> 2466 <a NAME="Hg.vcsShutdown" ID="Hg.vcsShutdown"></a>
2726 2492
2727 <p> 2493 <p>
2728 Public method to signal the support of user settable command options. 2494 Public method to signal the support of user settable command options.
2729 </p> 2495 </p>
2730 <dl> 2496 <dl>
2731 <dt>Returns:</dt> 2497 <dt>Return:</dt>
2732 <dd> 2498 <dd>
2733 flag indicating the support of user settable command options 2499 flag indicating the support of user settable command options
2734 (boolean) 2500 (boolean)
2735 </dd> 2501 </dd>
2736 </dl> 2502 </dl>
2748 <dd> 2514 <dd>
2749 directory name to be switched (string) 2515 directory name to be switched (string)
2750 </dd> 2516 </dd>
2751 </dl> 2517 </dl>
2752 <dl> 2518 <dl>
2753 <dt>Returns:</dt> 2519 <dt>Return:</dt>
2754 <dd> 2520 <dd>
2755 flag indicating, that the switch contained an add 2521 flag indicating, that the switch contained an add
2756 or delete (boolean) 2522 or delete (boolean)
2757 </dd> 2523 </dd>
2758 </dl> 2524 </dl>
2759 <a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a> 2525 <a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a>
2760 <h4>Hg.vcsTag</h4> 2526 <h4>Hg.vcsTag</h4>
2761 <b>vcsTag</b>(<i>name, revision=None, tagName=None</i>) 2527 <b>vcsTag</b>(<i>name=None, revision=None, tagName=None</i>)
2762 2528
2763 <p> 2529 <p>
2764 Public method used to set/remove a tag in the Mercurial repository. 2530 Public method used to set/remove a tag in the Mercurial repository.
2765 </p> 2531 </p>
2766 <dl> 2532 <dl>
2778 <dd> 2544 <dd>
2779 name of the tag (string) 2545 name of the tag (string)
2780 </dd> 2546 </dd>
2781 </dl> 2547 </dl>
2782 <dl> 2548 <dl>
2783 <dt>Returns:</dt> 2549 <dt>Return:</dt>
2784 <dd> 2550 <dd>
2785 flag indicating a performed tag action (boolean) 2551 flag indicating a performed tag action (boolean)
2786 </dd> 2552 </dd>
2787 </dl> 2553 </dl>
2788 <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a> 2554 <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a>
2789 <h4>Hg.vcsUpdate</h4> 2555 <h4>Hg.vcsUpdate</h4>
2790 <b>vcsUpdate</b>(<i>name, noDialog=False, revision=None</i>) 2556 <b>vcsUpdate</b>(<i>name=None, noDialog=False, revision=None</i>)
2791 2557
2792 <p> 2558 <p>
2793 Public method used to update a file/directory with the Mercurial 2559 Public method used to update a file/directory with the Mercurial
2794 repository. 2560 repository.
2795 </p> 2561 </p>
2796 <dl> 2562 <dl>
2797 2563
2798 <dt><i>name</i></dt> 2564 <dt><i>name</i></dt>
2799 <dd> 2565 <dd>
2800 file/directory name to be updated (string or list of 2566 file/directory name to be updated (not used)
2801 strings)
2802 </dd> 2567 </dd>
2803 <dt><i>noDialog</i></dt> 2568 <dt><i>noDialog</i></dt>
2804 <dd> 2569 <dd>
2805 flag indicating quiet operations (boolean) 2570 flag indicating quiet operations (boolean)
2806 </dd> 2571 </dd>
2807 <dt><i>revision=</i></dt> 2572 <dt><i>revision</i></dt>
2808 <dd> 2573 <dd>
2809 revision to update to (string) 2574 revision to update to (string)
2810 </dd> 2575 </dd>
2811 </dl> 2576 </dl>
2812 <dl> 2577 <dl>
2813 <dt>Returns:</dt> 2578 <dt>Return:</dt>
2814 <dd> 2579 <dd>
2815 flag indicating, that the update contained an add 2580 flag indicating, that the update contained an add
2816 or delete (boolean) 2581 or delete (boolean)
2817 </dd> 2582 </dd>
2818 </dl> 2583 </dl>

Mercurial Repository: eric

eric ide

mercurial