16 |
16 |
17 a { color: #BA6D36; } |
17 a { color: #BA6D36; } |
18 |
18 |
19 </style> |
19 </style> |
20 </head> |
20 </head> |
21 <body><a NAME="top" ID="top"></a> |
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.hg</h1> |
23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.hg</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing the version control systems interface to Mercurial. |
26 Module implementing the version control systems interface to Mercurial. |
25 </p> |
27 </p> |
26 <h3>Global Attributes</h3> |
28 <h3>Global Attributes</h3> |
|
29 |
27 <table> |
30 <table> |
28 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
29 </table> |
32 </table> |
30 <h3>Classes</h3> |
33 <h3>Classes</h3> |
|
34 |
31 <table> |
35 <table> |
|
36 |
32 <tr> |
37 <tr> |
33 <td><a href="#Hg">Hg</a></td> |
38 <td><a href="#Hg">Hg</a></td> |
34 <td>Class implementing the version control systems interface to Mercurial.</td> |
39 <td>Class implementing the version control systems interface to Mercurial.</td> |
35 </tr> |
40 </tr> |
36 </table> |
41 </table> |
37 <h3>Functions</h3> |
42 <h3>Functions</h3> |
|
43 |
38 <table> |
44 <table> |
39 <tr><td>None</td></tr> |
45 <tr><td>None</td></tr> |
40 </table> |
46 </table> |
41 <hr /><hr /> |
47 <hr /> |
|
48 <hr /> |
42 <a NAME="Hg" ID="Hg"></a> |
49 <a NAME="Hg" ID="Hg"></a> |
43 <h2>Hg</h2> |
50 <h2>Hg</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing the version control systems interface to Mercurial. |
53 Class implementing the version control systems interface to Mercurial. |
46 </p><h3>Signals</h3> |
54 </p> |
47 <dl> |
55 <h3>Signals</h3> |
|
56 <dl> |
|
57 |
48 <dt>activeExtensionsChanged()</dt> |
58 <dt>activeExtensionsChanged()</dt> |
49 <dd> |
59 <dd> |
50 emitted when the list of active |
60 emitted when the list of active |
51 extensions has changed |
61 extensions has changed |
52 </dd><dt>committed()</dt> |
62 </dd> |
|
63 <dt>committed()</dt> |
53 <dd> |
64 <dd> |
54 emitted after the commit action has completed |
65 emitted after the commit action has completed |
55 </dd><dt>iniFileChanged()</dt> |
66 </dd> |
|
67 <dt>iniFileChanged()</dt> |
56 <dd> |
68 <dd> |
57 emitted when a Mercurial/repo configuration file |
69 emitted when a Mercurial/repo configuration file |
58 has changed |
70 has changed |
59 </dd> |
71 </dd> |
60 </dl> |
72 </dl> |
61 <h3>Derived from</h3> |
73 <h3>Derived from</h3> |
62 VersionControl |
74 VersionControl |
63 <h3>Class Attributes</h3> |
75 <h3>Class Attributes</h3> |
|
76 |
64 <table> |
77 <table> |
65 <tr><td>IgnoreFileName</td></tr> |
78 <tr><td>IgnoreFileName</td></tr> |
66 </table> |
79 </table> |
67 <h3>Class Methods</h3> |
80 <h3>Class Methods</h3> |
|
81 |
68 <table> |
82 <table> |
69 <tr><td>None</td></tr> |
83 <tr><td>None</td></tr> |
70 </table> |
84 </table> |
71 <h3>Methods</h3> |
85 <h3>Methods</h3> |
|
86 |
72 <table> |
87 <table> |
|
88 |
73 <tr> |
89 <tr> |
74 <td><a href="#Hg.__init__">Hg</a></td> |
90 <td><a href="#Hg.__init__">Hg</a></td> |
75 <td>Constructor</td> |
91 <td>Constructor</td> |
76 </tr><tr> |
92 </tr> |
|
93 <tr> |
77 <td><a href="#Hg.__checkDefaults">__checkDefaults</a></td> |
94 <td><a href="#Hg.__checkDefaults">__checkDefaults</a></td> |
78 <td>Private method to check, if the default and default-push URLs have been configured.</td> |
95 <td>Private method to check, if the default and default-push URLs have been configured.</td> |
79 </tr><tr> |
96 </tr> |
|
97 <tr> |
80 <td><a href="#Hg.__getExtensionsInfo">__getExtensionsInfo</a></td> |
98 <td><a href="#Hg.__getExtensionsInfo">__getExtensionsInfo</a></td> |
81 <td>Private method to get the active extensions from Mercurial.</td> |
99 <td>Private method to get the active extensions from Mercurial.</td> |
82 </tr><tr> |
100 </tr> |
|
101 <tr> |
83 <td><a href="#Hg.__getInOutBookmarks">__getInOutBookmarks</a></td> |
102 <td><a href="#Hg.__getInOutBookmarks">__getInOutBookmarks</a></td> |
84 <td>Private method to get the list of incoming or outgoing bookmarks.</td> |
103 <td>Private method to get the list of incoming or outgoing bookmarks.</td> |
85 </tr><tr> |
104 </tr> |
|
105 <tr> |
86 <td><a href="#Hg.__getMostRecentCommitMessage">__getMostRecentCommitMessage</a></td> |
106 <td><a href="#Hg.__getMostRecentCommitMessage">__getMostRecentCommitMessage</a></td> |
87 <td>Private method to get the most recent commit message.</td> |
107 <td>Private method to get the most recent commit message.</td> |
88 </tr><tr> |
108 </tr> |
|
109 <tr> |
89 <td><a href="#Hg.__hgGetFileForRevision">__hgGetFileForRevision</a></td> |
110 <td><a href="#Hg.__hgGetFileForRevision">__hgGetFileForRevision</a></td> |
90 <td>Private method to get a file for a specific revision from the repository.</td> |
111 <td>Private method to get a file for a specific revision from the repository.</td> |
91 </tr><tr> |
112 </tr> |
|
113 <tr> |
92 <td><a href="#Hg.__hgGraftSubCommand">__hgGraftSubCommand</a></td> |
114 <td><a href="#Hg.__hgGraftSubCommand">__hgGraftSubCommand</a></td> |
93 <td>Private method to perform a Mercurial graft subcommand.</td> |
115 <td>Private method to perform a Mercurial graft subcommand.</td> |
94 </tr><tr> |
116 </tr> |
|
117 <tr> |
95 <td><a href="#Hg.__iniFileChanged">__iniFileChanged</a></td> |
118 <td><a href="#Hg.__iniFileChanged">__iniFileChanged</a></td> |
96 <td>Private slot to handle a change of the Mercurial configuration file.</td> |
119 <td>Private slot to handle a change of the Mercurial configuration file.</td> |
97 </tr><tr> |
120 </tr> |
|
121 <tr> |
98 <td><a href="#Hg.__monitorRepoIniFile">__monitorRepoIniFile</a></td> |
122 <td><a href="#Hg.__monitorRepoIniFile">__monitorRepoIniFile</a></td> |
99 <td>Private slot to add a repository configuration file to the list of monitored files.</td> |
123 <td>Private slot to add a repository configuration file to the list of monitored files.</td> |
100 </tr><tr> |
124 </tr> |
|
125 <tr> |
101 <td><a href="#Hg.__vcsCommit_Step2">__vcsCommit_Step2</a></td> |
126 <td><a href="#Hg.__vcsCommit_Step2">__vcsCommit_Step2</a></td> |
102 <td>Private slot performing the second step of the commit action.</td> |
127 <td>Private slot performing the second step of the commit action.</td> |
103 </tr><tr> |
128 </tr> |
|
129 <tr> |
104 <td><a href="#Hg._createStatusMonitorThread">_createStatusMonitorThread</a></td> |
130 <td><a href="#Hg._createStatusMonitorThread">_createStatusMonitorThread</a></td> |
105 <td>Protected method to create an instance of the VCS status monitor thread.</td> |
131 <td>Protected method to create an instance of the VCS status monitor thread.</td> |
106 </tr><tr> |
132 </tr> |
|
133 <tr> |
107 <td><a href="#Hg.canCommitMerge">canCommitMerge</a></td> |
134 <td><a href="#Hg.canCommitMerge">canCommitMerge</a></td> |
108 <td>Public method to check, if the working directory is an uncommitted merge.</td> |
135 <td>Public method to check, if the working directory is an uncommitted merge.</td> |
109 </tr><tr> |
136 </tr> |
|
137 <tr> |
110 <td><a href="#Hg.canPull">canPull</a></td> |
138 <td><a href="#Hg.canPull">canPull</a></td> |
111 <td>Public method to check, if pull is possible.</td> |
139 <td>Public method to check, if pull is possible.</td> |
112 </tr><tr> |
140 </tr> |
|
141 <tr> |
113 <td><a href="#Hg.canPush">canPush</a></td> |
142 <td><a href="#Hg.canPush">canPush</a></td> |
114 <td>Public method to check, if push is possible.</td> |
143 <td>Public method to check, if push is possible.</td> |
115 </tr><tr> |
144 </tr> |
|
145 <tr> |
116 <td><a href="#Hg.clearStatusCache">clearStatusCache</a></td> |
146 <td><a href="#Hg.clearStatusCache">clearStatusCache</a></td> |
117 <td>Public method to clear the status cache.</td> |
147 <td>Public method to clear the status cache.</td> |
118 </tr><tr> |
148 </tr> |
|
149 <tr> |
119 <td><a href="#Hg.getClient">getClient</a></td> |
150 <td><a href="#Hg.getClient">getClient</a></td> |
120 <td>Public method to get a reference to the command server interface.</td> |
151 <td>Public method to get a reference to the command server interface.</td> |
121 </tr><tr> |
152 </tr> |
|
153 <tr> |
122 <td><a href="#Hg.getEncoding">getEncoding</a></td> |
154 <td><a href="#Hg.getEncoding">getEncoding</a></td> |
123 <td>Public method to get the encoding to be used by Mercurial.</td> |
155 <td>Public method to get the encoding to be used by Mercurial.</td> |
124 </tr><tr> |
156 </tr> |
|
157 <tr> |
125 <td><a href="#Hg.getExtensionObject">getExtensionObject</a></td> |
158 <td><a href="#Hg.getExtensionObject">getExtensionObject</a></td> |
126 <td>Public method to get a reference to an extension object.</td> |
159 <td>Public method to get a reference to an extension object.</td> |
127 </tr><tr> |
160 </tr> |
|
161 <tr> |
128 <td><a href="#Hg.getHgSubPath">getHgSubPath</a></td> |
162 <td><a href="#Hg.getHgSubPath">getHgSubPath</a></td> |
129 <td>Public method to get the path to the .hgsub file containing the definitions of sub-repositories.</td> |
163 <td>Public method to get the path to the .hgsub file containing the definitions of sub-repositories.</td> |
130 </tr><tr> |
164 </tr> |
|
165 <tr> |
131 <td><a href="#Hg.getPlugin">getPlugin</a></td> |
166 <td><a href="#Hg.getPlugin">getPlugin</a></td> |
132 <td>Public method to get a reference to the plugin object.</td> |
167 <td>Public method to get a reference to the plugin object.</td> |
133 </tr><tr> |
168 </tr> |
|
169 <tr> |
134 <td><a href="#Hg.hasSubrepositories">hasSubrepositories</a></td> |
170 <td><a href="#Hg.hasSubrepositories">hasSubrepositories</a></td> |
135 <td>Public method to check, if the project might have sub-repositories.</td> |
171 <td>Public method to check, if the project might have sub-repositories.</td> |
136 </tr><tr> |
172 </tr> |
|
173 <tr> |
137 <td><a href="#Hg.hgAbortMerge">hgAbortMerge</a></td> |
174 <td><a href="#Hg.hgAbortMerge">hgAbortMerge</a></td> |
138 <td>Public method to abort an uncommitted merge.</td> |
175 <td>Public method to abort an uncommitted merge.</td> |
139 </tr><tr> |
176 </tr> |
|
177 <tr> |
140 <td><a href="#Hg.hgAddSubrepository">hgAddSubrepository</a></td> |
178 <td><a href="#Hg.hgAddSubrepository">hgAddSubrepository</a></td> |
141 <td>Public method to add a sub-repository.</td> |
179 <td>Public method to add a sub-repository.</td> |
142 </tr><tr> |
180 </tr> |
|
181 <tr> |
143 <td><a href="#Hg.hgAnnotate">hgAnnotate</a></td> |
182 <td><a href="#Hg.hgAnnotate">hgAnnotate</a></td> |
144 <td>Public method to show the output of the hg annotate command.</td> |
183 <td>Public method to show the output of the hg annotate command.</td> |
145 </tr><tr> |
184 </tr> |
|
185 <tr> |
146 <td><a href="#Hg.hgArchive">hgArchive</a></td> |
186 <td><a href="#Hg.hgArchive">hgArchive</a></td> |
147 <td>Public method to create an unversioned archive from the repository.</td> |
187 <td>Public method to create an unversioned archive from the repository.</td> |
148 </tr><tr> |
188 </tr> |
|
189 <tr> |
149 <td><a href="#Hg.hgBackout">hgBackout</a></td> |
190 <td><a href="#Hg.hgBackout">hgBackout</a></td> |
150 <td>Public method used to backout an earlier changeset from the Mercurial repository.</td> |
191 <td>Public method used to backout an earlier changeset from the Mercurial repository.</td> |
151 </tr><tr> |
192 </tr> |
|
193 <tr> |
152 <td><a href="#Hg.hgBisect">hgBisect</a></td> |
194 <td><a href="#Hg.hgBisect">hgBisect</a></td> |
153 <td>Public method to perform bisect commands.</td> |
195 <td>Public method to perform bisect commands.</td> |
154 </tr><tr> |
196 </tr> |
|
197 <tr> |
155 <td><a href="#Hg.hgBookmarkDefine">hgBookmarkDefine</a></td> |
198 <td><a href="#Hg.hgBookmarkDefine">hgBookmarkDefine</a></td> |
156 <td>Public method to define a bookmark.</td> |
199 <td>Public method to define a bookmark.</td> |
157 </tr><tr> |
200 </tr> |
|
201 <tr> |
158 <td><a href="#Hg.hgBookmarkDelete">hgBookmarkDelete</a></td> |
202 <td><a href="#Hg.hgBookmarkDelete">hgBookmarkDelete</a></td> |
159 <td>Public method to delete a bookmark.</td> |
203 <td>Public method to delete a bookmark.</td> |
160 </tr><tr> |
204 </tr> |
|
205 <tr> |
161 <td><a href="#Hg.hgBookmarkIncoming">hgBookmarkIncoming</a></td> |
206 <td><a href="#Hg.hgBookmarkIncoming">hgBookmarkIncoming</a></td> |
162 <td>Public method to show a list of incoming bookmarks.</td> |
207 <td>Public method to show a list of incoming bookmarks.</td> |
163 </tr><tr> |
208 </tr> |
|
209 <tr> |
164 <td><a href="#Hg.hgBookmarkMove">hgBookmarkMove</a></td> |
210 <td><a href="#Hg.hgBookmarkMove">hgBookmarkMove</a></td> |
165 <td>Public method to move a bookmark.</td> |
211 <td>Public method to move a bookmark.</td> |
166 </tr><tr> |
212 </tr> |
|
213 <tr> |
167 <td><a href="#Hg.hgBookmarkOutgoing">hgBookmarkOutgoing</a></td> |
214 <td><a href="#Hg.hgBookmarkOutgoing">hgBookmarkOutgoing</a></td> |
168 <td>Public method to show a list of outgoing bookmarks.</td> |
215 <td>Public method to show a list of outgoing bookmarks.</td> |
169 </tr><tr> |
216 </tr> |
|
217 <tr> |
170 <td><a href="#Hg.hgBookmarkPull">hgBookmarkPull</a></td> |
218 <td><a href="#Hg.hgBookmarkPull">hgBookmarkPull</a></td> |
171 <td>Public method to pull a bookmark from a remote repository.</td> |
219 <td>Public method to pull a bookmark from a remote repository.</td> |
172 </tr><tr> |
220 </tr> |
|
221 <tr> |
173 <td><a href="#Hg.hgBookmarkPush">hgBookmarkPush</a></td> |
222 <td><a href="#Hg.hgBookmarkPush">hgBookmarkPush</a></td> |
174 <td>Public method to push a bookmark to a remote repository.</td> |
223 <td>Public method to push a bookmark to a remote repository.</td> |
175 </tr><tr> |
224 </tr> |
|
225 <tr> |
176 <td><a href="#Hg.hgBookmarkRename">hgBookmarkRename</a></td> |
226 <td><a href="#Hg.hgBookmarkRename">hgBookmarkRename</a></td> |
177 <td>Public method to rename a bookmark.</td> |
227 <td>Public method to rename a bookmark.</td> |
178 </tr><tr> |
228 </tr> |
|
229 <tr> |
179 <td><a href="#Hg.hgBranch">hgBranch</a></td> |
230 <td><a href="#Hg.hgBranch">hgBranch</a></td> |
180 <td>Public method used to create a branch in the Mercurial repository.</td> |
231 <td>Public method used to create a branch in the Mercurial repository.</td> |
181 </tr><tr> |
232 </tr> |
|
233 <tr> |
182 <td><a href="#Hg.hgBundle">hgBundle</a></td> |
234 <td><a href="#Hg.hgBundle">hgBundle</a></td> |
183 <td>Public method to create a changegroup file.</td> |
235 <td>Public method to create a changegroup file.</td> |
184 </tr><tr> |
236 </tr> |
|
237 <tr> |
185 <td><a href="#Hg.hgConflicts">hgConflicts</a></td> |
238 <td><a href="#Hg.hgConflicts">hgConflicts</a></td> |
186 <td>Public method used to show a list of files containing conflicts.</td> |
239 <td>Public method used to show a list of files containing conflicts.</td> |
187 </tr><tr> |
240 </tr> |
|
241 <tr> |
188 <td><a href="#Hg.hgCopy">hgCopy</a></td> |
242 <td><a href="#Hg.hgCopy">hgCopy</a></td> |
189 <td>Public method used to copy a file/directory.</td> |
243 <td>Public method used to copy a file/directory.</td> |
190 </tr><tr> |
244 </tr> |
|
245 <tr> |
191 <td><a href="#Hg.hgCreateIgnoreFile">hgCreateIgnoreFile</a></td> |
246 <td><a href="#Hg.hgCreateIgnoreFile">hgCreateIgnoreFile</a></td> |
192 <td>Public method to create the ignore file.</td> |
247 <td>Public method to create the ignore file.</td> |
193 </tr><tr> |
248 </tr> |
|
249 <tr> |
194 <td><a href="#Hg.hgDeleteBackups">hgDeleteBackups</a></td> |
250 <td><a href="#Hg.hgDeleteBackups">hgDeleteBackups</a></td> |
195 <td>Public method to delete all backup bundles in the backup area.</td> |
251 <td>Public method to delete all backup bundles in the backup area.</td> |
196 </tr><tr> |
252 </tr> |
|
253 <tr> |
197 <td><a href="#Hg.hgEditConfig">hgEditConfig</a></td> |
254 <td><a href="#Hg.hgEditConfig">hgEditConfig</a></td> |
198 <td>Public method used to edit the repository configuration file.</td> |
255 <td>Public method used to edit the repository configuration file.</td> |
199 </tr><tr> |
256 </tr> |
|
257 <tr> |
200 <td><a href="#Hg.hgEditUserConfig">hgEditUserConfig</a></td> |
258 <td><a href="#Hg.hgEditUserConfig">hgEditUserConfig</a></td> |
201 <td>Public method used to edit the user configuration file.</td> |
259 <td>Public method used to edit the user configuration file.</td> |
202 </tr><tr> |
260 </tr> |
|
261 <tr> |
203 <td><a href="#Hg.hgExport">hgExport</a></td> |
262 <td><a href="#Hg.hgExport">hgExport</a></td> |
204 <td>Public method to export patches to files.</td> |
263 <td>Public method to export patches to files.</td> |
205 </tr><tr> |
264 </tr> |
|
265 <tr> |
206 <td><a href="#Hg.hgExtendedDiff">hgExtendedDiff</a></td> |
266 <td><a href="#Hg.hgExtendedDiff">hgExtendedDiff</a></td> |
207 <td>Public method used to view the difference of a file/directory to the Mercurial repository.</td> |
267 <td>Public method used to view the difference of a file/directory to the Mercurial repository.</td> |
208 </tr><tr> |
268 </tr> |
|
269 <tr> |
209 <td><a href="#Hg.hgForget">hgForget</a></td> |
270 <td><a href="#Hg.hgForget">hgForget</a></td> |
210 <td>Public method used to remove a file from the Mercurial repository.</td> |
271 <td>Public method used to remove a file from the Mercurial repository.</td> |
211 </tr><tr> |
272 </tr> |
|
273 <tr> |
212 <td><a href="#Hg.hgGetBookmarksList">hgGetBookmarksList</a></td> |
274 <td><a href="#Hg.hgGetBookmarksList">hgGetBookmarksList</a></td> |
213 <td>Public method to get the list of bookmarks.</td> |
275 <td>Public method to get the list of bookmarks.</td> |
214 </tr><tr> |
276 </tr> |
|
277 <tr> |
215 <td><a href="#Hg.hgGetBranchesList">hgGetBranchesList</a></td> |
278 <td><a href="#Hg.hgGetBranchesList">hgGetBranchesList</a></td> |
216 <td>Public method to get the list of branches.</td> |
279 <td>Public method to get the list of branches.</td> |
217 </tr><tr> |
280 </tr> |
|
281 <tr> |
218 <td><a href="#Hg.hgGetCurrentBranch">hgGetCurrentBranch</a></td> |
282 <td><a href="#Hg.hgGetCurrentBranch">hgGetCurrentBranch</a></td> |
219 <td>Public method to get the current branch of the working directory.</td> |
283 <td>Public method to get the current branch of the working directory.</td> |
220 </tr><tr> |
284 </tr> |
|
285 <tr> |
221 <td><a href="#Hg.hgGetTagsList">hgGetTagsList</a></td> |
286 <td><a href="#Hg.hgGetTagsList">hgGetTagsList</a></td> |
222 <td>Public method to get the list of tags.</td> |
287 <td>Public method to get the list of tags.</td> |
223 </tr><tr> |
288 </tr> |
|
289 <tr> |
224 <td><a href="#Hg.hgGraft">hgGraft</a></td> |
290 <td><a href="#Hg.hgGraft">hgGraft</a></td> |
225 <td>Public method to copy changesets from another branch.</td> |
291 <td>Public method to copy changesets from another branch.</td> |
226 </tr><tr> |
292 </tr> |
|
293 <tr> |
227 <td><a href="#Hg.hgGraftAbort">hgGraftAbort</a></td> |
294 <td><a href="#Hg.hgGraftAbort">hgGraftAbort</a></td> |
228 <td>Public method to abort an interrupted copying session and perform a rollback.</td> |
295 <td>Public method to abort an interrupted copying session and perform a rollback.</td> |
229 </tr><tr> |
296 </tr> |
|
297 <tr> |
230 <td><a href="#Hg.hgGraftContinue">hgGraftContinue</a></td> |
298 <td><a href="#Hg.hgGraftContinue">hgGraftContinue</a></td> |
231 <td>Public method to continue copying changesets from another branch.</td> |
299 <td>Public method to continue copying changesets from another branch.</td> |
232 </tr><tr> |
300 </tr> |
|
301 <tr> |
233 <td><a href="#Hg.hgGraftStop">hgGraftStop</a></td> |
302 <td><a href="#Hg.hgGraftStop">hgGraftStop</a></td> |
234 <td>Public method to stop an interrupted copying session.</td> |
303 <td>Public method to stop an interrupted copying session.</td> |
235 </tr><tr> |
304 </tr> |
|
305 <tr> |
236 <td><a href="#Hg.hgIdentify">hgIdentify</a></td> |
306 <td><a href="#Hg.hgIdentify">hgIdentify</a></td> |
237 <td>Public method to identify the current working directory.</td> |
307 <td>Public method to identify the current working directory.</td> |
238 </tr><tr> |
308 </tr> |
|
309 <tr> |
239 <td><a href="#Hg.hgImport">hgImport</a></td> |
310 <td><a href="#Hg.hgImport">hgImport</a></td> |
240 <td>Public method to import a patch file.</td> |
311 <td>Public method to import a patch file.</td> |
241 </tr><tr> |
312 </tr> |
|
313 <tr> |
242 <td><a href="#Hg.hgIncoming">hgIncoming</a></td> |
314 <td><a href="#Hg.hgIncoming">hgIncoming</a></td> |
243 <td>Public method used to view the log of incoming changes from the Mercurial repository.</td> |
315 <td>Public method used to view the log of incoming changes from the Mercurial repository.</td> |
244 </tr><tr> |
316 </tr> |
|
317 <tr> |
245 <td><a href="#Hg.hgInfo">hgInfo</a></td> |
318 <td><a href="#Hg.hgInfo">hgInfo</a></td> |
246 <td>Public method to show information about the heads of the repository.</td> |
319 <td>Public method to show information about the heads of the repository.</td> |
247 </tr><tr> |
320 </tr> |
|
321 <tr> |
248 <td><a href="#Hg.hgListBookmarks">hgListBookmarks</a></td> |
322 <td><a href="#Hg.hgListBookmarks">hgListBookmarks</a></td> |
249 <td>Public method used to list the available bookmarks.</td> |
323 <td>Public method used to list the available bookmarks.</td> |
250 </tr><tr> |
324 </tr> |
|
325 <tr> |
251 <td><a href="#Hg.hgListTagBranch">hgListTagBranch</a></td> |
326 <td><a href="#Hg.hgListTagBranch">hgListTagBranch</a></td> |
252 <td>Public method used to list the available tags or branches.</td> |
327 <td>Public method used to list the available tags or branches.</td> |
253 </tr><tr> |
328 </tr> |
|
329 <tr> |
254 <td><a href="#Hg.hgNormalizeURL">hgNormalizeURL</a></td> |
330 <td><a href="#Hg.hgNormalizeURL">hgNormalizeURL</a></td> |
255 <td>Public method to normalize a url for Mercurial.</td> |
331 <td>Public method to normalize a url for Mercurial.</td> |
256 </tr><tr> |
332 </tr> |
|
333 <tr> |
257 <td><a href="#Hg.hgOutgoing">hgOutgoing</a></td> |
334 <td><a href="#Hg.hgOutgoing">hgOutgoing</a></td> |
258 <td>Public method used to view the log of outgoing changes from the Mercurial repository.</td> |
335 <td>Public method used to view the log of outgoing changes from the Mercurial repository.</td> |
259 </tr><tr> |
336 </tr> |
|
337 <tr> |
260 <td><a href="#Hg.hgPhase">hgPhase</a></td> |
338 <td><a href="#Hg.hgPhase">hgPhase</a></td> |
261 <td>Public method to change the phase of revisions.</td> |
339 <td>Public method to change the phase of revisions.</td> |
262 </tr><tr> |
340 </tr> |
|
341 <tr> |
263 <td><a href="#Hg.hgPreviewBundle">hgPreviewBundle</a></td> |
342 <td><a href="#Hg.hgPreviewBundle">hgPreviewBundle</a></td> |
264 <td>Public method used to view the log of incoming changes from a changegroup file.</td> |
343 <td>Public method used to view the log of incoming changes from a changegroup file.</td> |
265 </tr><tr> |
344 </tr> |
|
345 <tr> |
266 <td><a href="#Hg.hgPull">hgPull</a></td> |
346 <td><a href="#Hg.hgPull">hgPull</a></td> |
267 <td>Public method used to pull changes from a remote Mercurial repository.</td> |
347 <td>Public method used to pull changes from a remote Mercurial repository.</td> |
268 </tr><tr> |
348 </tr> |
|
349 <tr> |
269 <td><a href="#Hg.hgPush">hgPush</a></td> |
350 <td><a href="#Hg.hgPush">hgPush</a></td> |
270 <td>Public method used to push changes to a remote Mercurial repository.</td> |
351 <td>Public method used to push changes to a remote Mercurial repository.</td> |
271 </tr><tr> |
352 </tr> |
|
353 <tr> |
272 <td><a href="#Hg.hgReMerge">hgReMerge</a></td> |
354 <td><a href="#Hg.hgReMerge">hgReMerge</a></td> |
273 <td>Public method used to merge a URL/revision into the local project.</td> |
355 <td>Public method used to merge a URL/revision into the local project.</td> |
274 </tr><tr> |
356 </tr> |
|
357 <tr> |
275 <td><a href="#Hg.hgRecover">hgRecover</a></td> |
358 <td><a href="#Hg.hgRecover">hgRecover</a></td> |
276 <td>Public method to recover an interrupted transaction.</td> |
359 <td>Public method to recover an interrupted transaction.</td> |
277 </tr><tr> |
360 </tr> |
|
361 <tr> |
278 <td><a href="#Hg.hgRemoveSubrepositories">hgRemoveSubrepositories</a></td> |
362 <td><a href="#Hg.hgRemoveSubrepositories">hgRemoveSubrepositories</a></td> |
279 <td>Public method to remove sub-repositories.</td> |
363 <td>Public method to remove sub-repositories.</td> |
280 </tr><tr> |
364 </tr> |
|
365 <tr> |
281 <td><a href="#Hg.hgResolved">hgResolved</a></td> |
366 <td><a href="#Hg.hgResolved">hgResolved</a></td> |
282 <td>Public method used to resolve conflicts of a file/directory.</td> |
367 <td>Public method used to resolve conflicts of a file/directory.</td> |
283 </tr><tr> |
368 </tr> |
|
369 <tr> |
284 <td><a href="#Hg.hgRevert">hgRevert</a></td> |
370 <td><a href="#Hg.hgRevert">hgRevert</a></td> |
285 <td>Public method used to revert changes made to a file/directory.</td> |
371 <td>Public method used to revert changes made to a file/directory.</td> |
286 </tr><tr> |
372 </tr> |
|
373 <tr> |
287 <td><a href="#Hg.hgRollback">hgRollback</a></td> |
374 <td><a href="#Hg.hgRollback">hgRollback</a></td> |
288 <td>Public method used to rollback the last transaction.</td> |
375 <td>Public method used to rollback the last transaction.</td> |
289 </tr><tr> |
376 </tr> |
|
377 <tr> |
290 <td><a href="#Hg.hgSbsDiff">hgSbsDiff</a></td> |
378 <td><a href="#Hg.hgSbsDiff">hgSbsDiff</a></td> |
291 <td>Public method used to view the difference of a file to the Mercurial repository side-by-side.</td> |
379 <td>Public method used to view the difference of a file to the Mercurial repository side-by-side.</td> |
292 </tr><tr> |
380 </tr> |
|
381 <tr> |
293 <td><a href="#Hg.hgServe">hgServe</a></td> |
382 <td><a href="#Hg.hgServe">hgServe</a></td> |
294 <td>Public method used to serve the project.</td> |
383 <td>Public method used to serve the project.</td> |
295 </tr><tr> |
384 </tr> |
|
385 <tr> |
296 <td><a href="#Hg.hgShowBranch">hgShowBranch</a></td> |
386 <td><a href="#Hg.hgShowBranch">hgShowBranch</a></td> |
297 <td>Public method used to show the current branch of the working directory.</td> |
387 <td>Public method used to show the current branch of the working directory.</td> |
298 </tr><tr> |
388 </tr> |
|
389 <tr> |
299 <td><a href="#Hg.hgShowConfig">hgShowConfig</a></td> |
390 <td><a href="#Hg.hgShowConfig">hgShowConfig</a></td> |
300 <td>Public method to show the combined configuration.</td> |
391 <td>Public method to show the combined configuration.</td> |
301 </tr><tr> |
392 </tr> |
|
393 <tr> |
302 <td><a href="#Hg.hgShowPaths">hgShowPaths</a></td> |
394 <td><a href="#Hg.hgShowPaths">hgShowPaths</a></td> |
303 <td>Public method to show the path aliases for remote repositories.</td> |
395 <td>Public method to show the path aliases for remote repositories.</td> |
304 </tr><tr> |
396 </tr> |
|
397 <tr> |
305 <td><a href="#Hg.hgSummary">hgSummary</a></td> |
398 <td><a href="#Hg.hgSummary">hgSummary</a></td> |
306 <td>Public method used to show some summary information of the working directory state.</td> |
399 <td>Public method used to show some summary information of the working directory state.</td> |
307 </tr><tr> |
400 </tr> |
|
401 <tr> |
308 <td><a href="#Hg.hgUnbundle">hgUnbundle</a></td> |
402 <td><a href="#Hg.hgUnbundle">hgUnbundle</a></td> |
309 <td>Public method to apply changegroup files.</td> |
403 <td>Public method to apply changegroup files.</td> |
310 </tr><tr> |
404 </tr> |
|
405 <tr> |
311 <td><a href="#Hg.hgVerify">hgVerify</a></td> |
406 <td><a href="#Hg.hgVerify">hgVerify</a></td> |
312 <td>Public method to verify the integrity of the repository.</td> |
407 <td>Public method to verify the integrity of the repository.</td> |
313 </tr><tr> |
408 </tr> |
|
409 <tr> |
314 <td><a href="#Hg.initCommand">initCommand</a></td> |
410 <td><a href="#Hg.initCommand">initCommand</a></td> |
315 <td>Public method to initialize a command arguments list.</td> |
411 <td>Public method to initialize a command arguments list.</td> |
316 </tr><tr> |
412 </tr> |
|
413 <tr> |
317 <td><a href="#Hg.isExtensionActive">isExtensionActive</a></td> |
414 <td><a href="#Hg.isExtensionActive">isExtensionActive</a></td> |
318 <td>Public method to check, if an extension is active.</td> |
415 <td>Public method to check, if an extension is active.</td> |
319 </tr><tr> |
416 </tr> |
|
417 <tr> |
320 <td><a href="#Hg.vcsAdd">vcsAdd</a></td> |
418 <td><a href="#Hg.vcsAdd">vcsAdd</a></td> |
321 <td>Public method used to add a file/directory to the Mercurial repository.</td> |
419 <td>Public method used to add a file/directory to the Mercurial repository.</td> |
322 </tr><tr> |
420 </tr> |
|
421 <tr> |
323 <td><a href="#Hg.vcsAddBinary">vcsAddBinary</a></td> |
422 <td><a href="#Hg.vcsAddBinary">vcsAddBinary</a></td> |
324 <td>Public method used to add a file/directory in binary mode to the Mercurial repository.</td> |
423 <td>Public method used to add a file/directory in binary mode to the Mercurial repository.</td> |
325 </tr><tr> |
424 </tr> |
|
425 <tr> |
326 <td><a href="#Hg.vcsAddTree">vcsAddTree</a></td> |
426 <td><a href="#Hg.vcsAddTree">vcsAddTree</a></td> |
327 <td>Public method to add a directory tree rooted at path to the Mercurial repository.</td> |
427 <td>Public method to add a directory tree rooted at path to the Mercurial repository.</td> |
328 </tr><tr> |
428 </tr> |
|
429 <tr> |
329 <td><a href="#Hg.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td> |
430 <td><a href="#Hg.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td> |
330 <td>Public method used to get the registered states of a number of files in the vcs.</td> |
431 <td>Public method used to get the registered states of a number of files in the vcs.</td> |
331 </tr><tr> |
432 </tr> |
|
433 <tr> |
332 <td><a href="#Hg.vcsCheckout">vcsCheckout</a></td> |
434 <td><a href="#Hg.vcsCheckout">vcsCheckout</a></td> |
333 <td>Public method used to check the project out of a Mercurial repository (clone).</td> |
435 <td>Public method used to check the project out of a Mercurial repository (clone).</td> |
334 </tr><tr> |
436 </tr> |
|
437 <tr> |
335 <td><a href="#Hg.vcsCleanup">vcsCleanup</a></td> |
438 <td><a href="#Hg.vcsCleanup">vcsCleanup</a></td> |
336 <td>Public method used to cleanup the working directory.</td> |
439 <td>Public method used to cleanup the working directory.</td> |
337 </tr><tr> |
440 </tr> |
|
441 <tr> |
338 <td><a href="#Hg.vcsCommandLine">vcsCommandLine</a></td> |
442 <td><a href="#Hg.vcsCommandLine">vcsCommandLine</a></td> |
339 <td>Public method used to execute arbitrary mercurial commands.</td> |
443 <td>Public method used to execute arbitrary mercurial commands.</td> |
340 </tr><tr> |
444 </tr> |
|
445 <tr> |
341 <td><a href="#Hg.vcsCommit">vcsCommit</a></td> |
446 <td><a href="#Hg.vcsCommit">vcsCommit</a></td> |
342 <td>Public method used to make the change of a file/directory permanent in the Mercurial repository.</td> |
447 <td>Public method used to make the change of a file/directory permanent in the Mercurial repository.</td> |
343 </tr><tr> |
448 </tr> |
|
449 <tr> |
344 <td><a href="#Hg.vcsConvertProject">vcsConvertProject</a></td> |
450 <td><a href="#Hg.vcsConvertProject">vcsConvertProject</a></td> |
345 <td>Public method to convert an uncontrolled project to a version controlled project.</td> |
451 <td>Public method to convert an uncontrolled project to a version controlled project.</td> |
346 </tr><tr> |
452 </tr> |
|
453 <tr> |
347 <td><a href="#Hg.vcsDiff">vcsDiff</a></td> |
454 <td><a href="#Hg.vcsDiff">vcsDiff</a></td> |
348 <td>Public method used to view the difference of a file/directory to the Mercurial repository.</td> |
455 <td>Public method used to view the difference of a file/directory to the Mercurial repository.</td> |
349 </tr><tr> |
456 </tr> |
|
457 <tr> |
350 <td><a href="#Hg.vcsExists">vcsExists</a></td> |
458 <td><a href="#Hg.vcsExists">vcsExists</a></td> |
351 <td>Public method used to test for the presence of the hg executable.</td> |
459 <td>Public method used to test for the presence of the hg executable.</td> |
352 </tr><tr> |
460 </tr> |
|
461 <tr> |
353 <td><a href="#Hg.vcsExport">vcsExport</a></td> |
462 <td><a href="#Hg.vcsExport">vcsExport</a></td> |
354 <td>Public method used to export a directory from the Mercurial repository.</td> |
463 <td>Public method used to export a directory from the Mercurial repository.</td> |
355 </tr><tr> |
464 </tr> |
|
465 <tr> |
356 <td><a href="#Hg.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td> |
466 <td><a href="#Hg.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td> |
357 <td>Public method to instantiate a helper object for the different project browsers.</td> |
467 <td>Public method to instantiate a helper object for the different project browsers.</td> |
358 </tr><tr> |
468 </tr> |
|
469 <tr> |
359 <td><a href="#Hg.vcsGetProjectHelper">vcsGetProjectHelper</a></td> |
470 <td><a href="#Hg.vcsGetProjectHelper">vcsGetProjectHelper</a></td> |
360 <td>Public method to instantiate a helper object for the project.</td> |
471 <td>Public method to instantiate a helper object for the project.</td> |
361 </tr><tr> |
472 </tr> |
|
473 <tr> |
362 <td><a href="#Hg.vcsImport">vcsImport</a></td> |
474 <td><a href="#Hg.vcsImport">vcsImport</a></td> |
363 <td>Public method used to import the project into the Mercurial repository.</td> |
475 <td>Public method used to import the project into the Mercurial repository.</td> |
364 </tr><tr> |
476 </tr> |
|
477 <tr> |
365 <td><a href="#Hg.vcsInit">vcsInit</a></td> |
478 <td><a href="#Hg.vcsInit">vcsInit</a></td> |
366 <td>Public method used to initialize the mercurial repository.</td> |
479 <td>Public method used to initialize the mercurial repository.</td> |
367 </tr><tr> |
480 </tr> |
|
481 <tr> |
368 <td><a href="#Hg.vcsInitConfig">vcsInitConfig</a></td> |
482 <td><a href="#Hg.vcsInitConfig">vcsInitConfig</a></td> |
369 <td>Public method to initialize the VCS configuration.</td> |
483 <td>Public method to initialize the VCS configuration.</td> |
370 </tr><tr> |
484 </tr> |
|
485 <tr> |
371 <td><a href="#Hg.vcsLogBrowser">vcsLogBrowser</a></td> |
486 <td><a href="#Hg.vcsLogBrowser">vcsLogBrowser</a></td> |
372 <td>Public method used to browse the log of a file/directory from the Mercurial repository.</td> |
487 <td>Public method used to browse the log of a file/directory from the Mercurial repository.</td> |
373 </tr><tr> |
488 </tr> |
|
489 <tr> |
374 <td><a href="#Hg.vcsMerge">vcsMerge</a></td> |
490 <td><a href="#Hg.vcsMerge">vcsMerge</a></td> |
375 <td>Public method used to merge a URL/revision into the local project.</td> |
491 <td>Public method used to merge a URL/revision into the local project.</td> |
376 </tr><tr> |
492 </tr> |
|
493 <tr> |
377 <td><a href="#Hg.vcsMove">vcsMove</a></td> |
494 <td><a href="#Hg.vcsMove">vcsMove</a></td> |
378 <td>Public method used to move a file/directory.</td> |
495 <td>Public method used to move a file/directory.</td> |
379 </tr><tr> |
496 </tr> |
|
497 <tr> |
380 <td><a href="#Hg.vcsName">vcsName</a></td> |
498 <td><a href="#Hg.vcsName">vcsName</a></td> |
381 <td>Public method returning the name of the vcs.</td> |
499 <td>Public method returning the name of the vcs.</td> |
382 </tr><tr> |
500 </tr> |
|
501 <tr> |
383 <td><a href="#Hg.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td> |
502 <td><a href="#Hg.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td> |
384 <td>Public method to get a dialog to enter repository info for getting a new project.</td> |
503 <td>Public method to get a dialog to enter repository info for getting a new project.</td> |
385 </tr><tr> |
504 </tr> |
|
505 <tr> |
386 <td><a href="#Hg.vcsOptionsDialog">vcsOptionsDialog</a></td> |
506 <td><a href="#Hg.vcsOptionsDialog">vcsOptionsDialog</a></td> |
387 <td>Public method to get a dialog to enter repository info.</td> |
507 <td>Public method to get a dialog to enter repository info.</td> |
388 </tr><tr> |
508 </tr> |
|
509 <tr> |
389 <td><a href="#Hg.vcsRegisteredState">vcsRegisteredState</a></td> |
510 <td><a href="#Hg.vcsRegisteredState">vcsRegisteredState</a></td> |
390 <td>Public method used to get the registered state of a file in the vcs.</td> |
511 <td>Public method used to get the registered state of a file in the vcs.</td> |
391 </tr><tr> |
512 </tr> |
|
513 <tr> |
392 <td><a href="#Hg.vcsRemove">vcsRemove</a></td> |
514 <td><a href="#Hg.vcsRemove">vcsRemove</a></td> |
393 <td>Public method used to remove a file/directory from the Mercurial repository.</td> |
515 <td>Public method used to remove a file/directory from the Mercurial repository.</td> |
394 </tr><tr> |
516 </tr> |
|
517 <tr> |
395 <td><a href="#Hg.vcsRepositoryInfos">vcsRepositoryInfos</a></td> |
518 <td><a href="#Hg.vcsRepositoryInfos">vcsRepositoryInfos</a></td> |
396 <td>Public method to retrieve information about the repository.</td> |
519 <td>Public method to retrieve information about the repository.</td> |
397 </tr><tr> |
520 </tr> |
|
521 <tr> |
398 <td><a href="#Hg.vcsShutdown">vcsShutdown</a></td> |
522 <td><a href="#Hg.vcsShutdown">vcsShutdown</a></td> |
399 <td>Public method used to shutdown the Mercurial interface.</td> |
523 <td>Public method used to shutdown the Mercurial interface.</td> |
400 </tr><tr> |
524 </tr> |
|
525 <tr> |
401 <td><a href="#Hg.vcsStatus">vcsStatus</a></td> |
526 <td><a href="#Hg.vcsStatus">vcsStatus</a></td> |
402 <td>Public method used to view the status of files/directories in the Mercurial repository.</td> |
527 <td>Public method used to view the status of files/directories in the Mercurial repository.</td> |
403 </tr><tr> |
528 </tr> |
|
529 <tr> |
404 <td><a href="#Hg.vcsSupportCommandOptions">vcsSupportCommandOptions</a></td> |
530 <td><a href="#Hg.vcsSupportCommandOptions">vcsSupportCommandOptions</a></td> |
405 <td>Public method to signal the support of user settable command options.</td> |
531 <td>Public method to signal the support of user settable command options.</td> |
406 </tr><tr> |
532 </tr> |
|
533 <tr> |
407 <td><a href="#Hg.vcsSwitch">vcsSwitch</a></td> |
534 <td><a href="#Hg.vcsSwitch">vcsSwitch</a></td> |
408 <td>Public method used to switch a working directory to a different revision.</td> |
535 <td>Public method used to switch a working directory to a different revision.</td> |
409 </tr><tr> |
536 </tr> |
|
537 <tr> |
410 <td><a href="#Hg.vcsTag">vcsTag</a></td> |
538 <td><a href="#Hg.vcsTag">vcsTag</a></td> |
411 <td>Public method used to set/remove a tag in the Mercurial repository.</td> |
539 <td>Public method used to set/remove a tag in the Mercurial repository.</td> |
412 </tr><tr> |
540 </tr> |
|
541 <tr> |
413 <td><a href="#Hg.vcsUpdate">vcsUpdate</a></td> |
542 <td><a href="#Hg.vcsUpdate">vcsUpdate</a></td> |
414 <td>Public method used to update a file/directory with the Mercurial repository.</td> |
543 <td>Public method used to update a file/directory with the Mercurial repository.</td> |
415 </tr> |
544 </tr> |
416 </table> |
545 </table> |
417 <h3>Static Methods</h3> |
546 <h3>Static Methods</h3> |
|
547 |
418 <table> |
548 <table> |
419 <tr><td>None</td></tr> |
549 <tr><td>None</td></tr> |
420 </table> |
550 </table> |
|
551 |
421 <a NAME="Hg.__init__" ID="Hg.__init__"></a> |
552 <a NAME="Hg.__init__" ID="Hg.__init__"></a> |
422 <h4>Hg (Constructor)</h4> |
553 <h4>Hg (Constructor)</h4> |
423 <b>Hg</b>(<i>plugin, parent=None, name=None</i>) |
554 <b>Hg</b>(<i>plugin, parent=None, name=None</i>) |
|
555 |
424 <p> |
556 <p> |
425 Constructor |
557 Constructor |
426 </p><dl> |
558 </p> |
|
559 <dl> |
|
560 |
427 <dt><i>plugin</i></dt> |
561 <dt><i>plugin</i></dt> |
428 <dd> |
562 <dd> |
429 reference to the plugin object |
563 reference to the plugin object |
430 </dd><dt><i>parent</i></dt> |
564 </dd> |
|
565 <dt><i>parent</i></dt> |
431 <dd> |
566 <dd> |
432 parent widget (QWidget) |
567 parent widget (QWidget) |
433 </dd><dt><i>name</i></dt> |
568 </dd> |
|
569 <dt><i>name</i></dt> |
434 <dd> |
570 <dd> |
435 name of this object (string) |
571 name of this object (string) |
436 </dd> |
572 </dd> |
437 </dl><a NAME="Hg.__checkDefaults" ID="Hg.__checkDefaults"></a> |
573 </dl> |
|
574 <a NAME="Hg.__checkDefaults" ID="Hg.__checkDefaults"></a> |
438 <h4>Hg.__checkDefaults</h4> |
575 <h4>Hg.__checkDefaults</h4> |
439 <b>__checkDefaults</b>(<i></i>) |
576 <b>__checkDefaults</b>(<i></i>) |
|
577 |
440 <p> |
578 <p> |
441 Private method to check, if the default and default-push URLs |
579 Private method to check, if the default and default-push URLs |
442 have been configured. |
580 have been configured. |
443 </p><a NAME="Hg.__getExtensionsInfo" ID="Hg.__getExtensionsInfo"></a> |
581 </p> |
|
582 <a NAME="Hg.__getExtensionsInfo" ID="Hg.__getExtensionsInfo"></a> |
444 <h4>Hg.__getExtensionsInfo</h4> |
583 <h4>Hg.__getExtensionsInfo</h4> |
445 <b>__getExtensionsInfo</b>(<i></i>) |
584 <b>__getExtensionsInfo</b>(<i></i>) |
|
585 |
446 <p> |
586 <p> |
447 Private method to get the active extensions from Mercurial. |
587 Private method to get the active extensions from Mercurial. |
448 </p><a NAME="Hg.__getInOutBookmarks" ID="Hg.__getInOutBookmarks"></a> |
588 </p> |
|
589 <a NAME="Hg.__getInOutBookmarks" ID="Hg.__getInOutBookmarks"></a> |
449 <h4>Hg.__getInOutBookmarks</h4> |
590 <h4>Hg.__getInOutBookmarks</h4> |
450 <b>__getInOutBookmarks</b>(<i>repodir, incoming</i>) |
591 <b>__getInOutBookmarks</b>(<i>repodir, incoming</i>) |
|
592 |
451 <p> |
593 <p> |
452 Private method to get the list of incoming or outgoing bookmarks. |
594 Private method to get the list of incoming or outgoing bookmarks. |
453 </p><dl> |
595 </p> |
|
596 <dl> |
|
597 |
454 <dt><i>repodir</i></dt> |
598 <dt><i>repodir</i></dt> |
455 <dd> |
599 <dd> |
456 directory name of the repository (string) |
600 directory name of the repository (string) |
457 </dd><dt><i>incoming</i></dt> |
601 </dd> |
|
602 <dt><i>incoming</i></dt> |
458 <dd> |
603 <dd> |
459 flag indicating to get incoming bookmarks (boolean) |
604 flag indicating to get incoming bookmarks (boolean) |
460 </dd> |
605 </dd> |
461 </dl><dl> |
606 </dl> |
|
607 <dl> |
462 <dt>Returns:</dt> |
608 <dt>Returns:</dt> |
463 <dd> |
609 <dd> |
464 list of bookmarks (list of string) |
610 list of bookmarks (list of string) |
465 </dd> |
611 </dd> |
466 </dl><a NAME="Hg.__getMostRecentCommitMessage" ID="Hg.__getMostRecentCommitMessage"></a> |
612 </dl> |
|
613 <a NAME="Hg.__getMostRecentCommitMessage" ID="Hg.__getMostRecentCommitMessage"></a> |
467 <h4>Hg.__getMostRecentCommitMessage</h4> |
614 <h4>Hg.__getMostRecentCommitMessage</h4> |
468 <b>__getMostRecentCommitMessage</b>(<i>repodir</i>) |
615 <b>__getMostRecentCommitMessage</b>(<i>repodir</i>) |
|
616 |
469 <p> |
617 <p> |
470 Private method to get the most recent commit message. |
618 Private method to get the most recent commit message. |
471 </p><p> |
619 </p> |
|
620 <p> |
472 Note: This message is extracted from the parent commit of the |
621 Note: This message is extracted from the parent commit of the |
473 working directory. |
622 working directory. |
474 </p><dl> |
623 </p> |
|
624 <dl> |
|
625 |
475 <dt><i>repodir</i> (str)</dt> |
626 <dt><i>repodir</i> (str)</dt> |
476 <dd> |
627 <dd> |
477 path containing the repository |
628 path containing the repository |
478 </dd> |
629 </dd> |
479 </dl><dl> |
630 </dl> |
|
631 <dl> |
480 <dt>Returns:</dt> |
632 <dt>Returns:</dt> |
481 <dd> |
633 <dd> |
482 most recent commit message |
634 most recent commit message |
483 </dd> |
635 </dd> |
484 </dl><dl> |
636 </dl> |
|
637 <dl> |
485 <dt>Return Type:</dt> |
638 <dt>Return Type:</dt> |
486 <dd> |
639 <dd> |
487 str |
640 str |
488 </dd> |
641 </dd> |
489 </dl><a NAME="Hg.__hgGetFileForRevision" ID="Hg.__hgGetFileForRevision"></a> |
642 </dl> |
|
643 <a NAME="Hg.__hgGetFileForRevision" ID="Hg.__hgGetFileForRevision"></a> |
490 <h4>Hg.__hgGetFileForRevision</h4> |
644 <h4>Hg.__hgGetFileForRevision</h4> |
491 <b>__hgGetFileForRevision</b>(<i>name, rev=""</i>) |
645 <b>__hgGetFileForRevision</b>(<i>name, rev=""</i>) |
|
646 |
492 <p> |
647 <p> |
493 Private method to get a file for a specific revision from the |
648 Private method to get a file for a specific revision from the |
494 repository. |
649 repository. |
495 </p><dl> |
650 </p> |
|
651 <dl> |
|
652 |
496 <dt><i>name</i></dt> |
653 <dt><i>name</i></dt> |
497 <dd> |
654 <dd> |
498 file name to get from the repository (string) |
655 file name to get from the repository (string) |
499 </dd><dt><i>rev=</i></dt> |
656 </dd> |
|
657 <dt><i>rev=</i></dt> |
500 <dd> |
658 <dd> |
501 revision to retrieve (string) |
659 revision to retrieve (string) |
502 </dd> |
660 </dd> |
503 </dl><dl> |
661 </dl> |
|
662 <dl> |
504 <dt>Returns:</dt> |
663 <dt>Returns:</dt> |
505 <dd> |
664 <dd> |
506 contents of the file (string) and an error message (string) |
665 contents of the file (string) and an error message (string) |
507 </dd> |
666 </dd> |
508 </dl><a NAME="Hg.__hgGraftSubCommand" ID="Hg.__hgGraftSubCommand"></a> |
667 </dl> |
|
668 <a NAME="Hg.__hgGraftSubCommand" ID="Hg.__hgGraftSubCommand"></a> |
509 <h4>Hg.__hgGraftSubCommand</h4> |
669 <h4>Hg.__hgGraftSubCommand</h4> |
510 <b>__hgGraftSubCommand</b>(<i>path, subcommand, title</i>) |
670 <b>__hgGraftSubCommand</b>(<i>path, subcommand, title</i>) |
|
671 |
511 <p> |
672 <p> |
512 Private method to perform a Mercurial graft subcommand. |
673 Private method to perform a Mercurial graft subcommand. |
513 </p><dl> |
674 </p> |
|
675 <dl> |
|
676 |
514 <dt><i>path</i> (str)</dt> |
677 <dt><i>path</i> (str)</dt> |
515 <dd> |
678 <dd> |
516 directory name of the project |
679 directory name of the project |
517 </dd><dt><i>subcommand</i> (str)</dt> |
680 </dd> |
|
681 <dt><i>subcommand</i> (str)</dt> |
518 <dd> |
682 <dd> |
519 subcommand flag |
683 subcommand flag |
520 </dd><dt><i>title</i> (str)</dt> |
684 </dd> |
|
685 <dt><i>title</i> (str)</dt> |
521 <dd> |
686 <dd> |
522 tirle of the dialog |
687 tirle of the dialog |
523 </dd> |
688 </dd> |
524 </dl><dl> |
689 </dl> |
|
690 <dl> |
525 <dt>Returns:</dt> |
691 <dt>Returns:</dt> |
526 <dd> |
692 <dd> |
527 flag indicating that the project should be reread |
693 flag indicating that the project should be reread |
528 </dd> |
694 </dd> |
529 </dl><dl> |
695 </dl> |
|
696 <dl> |
530 <dt>Return Type:</dt> |
697 <dt>Return Type:</dt> |
531 <dd> |
698 <dd> |
532 bool |
699 bool |
533 </dd> |
700 </dd> |
534 </dl><a NAME="Hg.__iniFileChanged" ID="Hg.__iniFileChanged"></a> |
701 </dl> |
|
702 <a NAME="Hg.__iniFileChanged" ID="Hg.__iniFileChanged"></a> |
535 <h4>Hg.__iniFileChanged</h4> |
703 <h4>Hg.__iniFileChanged</h4> |
536 <b>__iniFileChanged</b>(<i>path</i>) |
704 <b>__iniFileChanged</b>(<i>path</i>) |
|
705 |
537 <p> |
706 <p> |
538 Private slot to handle a change of the Mercurial configuration file. |
707 Private slot to handle a change of the Mercurial configuration file. |
539 </p><dl> |
708 </p> |
|
709 <dl> |
|
710 |
540 <dt><i>path</i></dt> |
711 <dt><i>path</i></dt> |
541 <dd> |
712 <dd> |
542 name of the changed file (string) |
713 name of the changed file (string) |
543 </dd> |
714 </dd> |
544 </dl><a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a> |
715 </dl> |
|
716 <a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a> |
545 <h4>Hg.__monitorRepoIniFile</h4> |
717 <h4>Hg.__monitorRepoIniFile</h4> |
546 <b>__monitorRepoIniFile</b>(<i>name</i>) |
718 <b>__monitorRepoIniFile</b>(<i>name</i>) |
|
719 |
547 <p> |
720 <p> |
548 Private slot to add a repository configuration file to the list of |
721 Private slot to add a repository configuration file to the list of |
549 monitored files. |
722 monitored files. |
550 </p><dl> |
723 </p> |
|
724 <dl> |
|
725 |
551 <dt><i>name</i></dt> |
726 <dt><i>name</i></dt> |
552 <dd> |
727 <dd> |
553 directory name pointing into the repository (string) |
728 directory name pointing into the repository (string) |
554 </dd> |
729 </dd> |
555 </dl><a NAME="Hg.__vcsCommit_Step2" ID="Hg.__vcsCommit_Step2"></a> |
730 </dl> |
|
731 <a NAME="Hg.__vcsCommit_Step2" ID="Hg.__vcsCommit_Step2"></a> |
556 <h4>Hg.__vcsCommit_Step2</h4> |
732 <h4>Hg.__vcsCommit_Step2</h4> |
557 <b>__vcsCommit_Step2</b>(<i></i>) |
733 <b>__vcsCommit_Step2</b>(<i></i>) |
|
734 |
558 <p> |
735 <p> |
559 Private slot performing the second step of the commit action. |
736 Private slot performing the second step of the commit action. |
560 </p><a NAME="Hg._createStatusMonitorThread" ID="Hg._createStatusMonitorThread"></a> |
737 </p> |
|
738 <a NAME="Hg._createStatusMonitorThread" ID="Hg._createStatusMonitorThread"></a> |
561 <h4>Hg._createStatusMonitorThread</h4> |
739 <h4>Hg._createStatusMonitorThread</h4> |
562 <b>_createStatusMonitorThread</b>(<i>interval, project</i>) |
740 <b>_createStatusMonitorThread</b>(<i>interval, project</i>) |
|
741 |
563 <p> |
742 <p> |
564 Protected method to create an instance of the VCS status monitor |
743 Protected method to create an instance of the VCS status monitor |
565 thread. |
744 thread. |
566 </p><dl> |
745 </p> |
|
746 <dl> |
|
747 |
567 <dt><i>interval</i></dt> |
748 <dt><i>interval</i></dt> |
568 <dd> |
749 <dd> |
569 check interval for the monitor thread in seconds |
750 check interval for the monitor thread in seconds |
570 (integer) |
751 (integer) |
571 </dd><dt><i>project</i></dt> |
752 </dd> |
|
753 <dt><i>project</i></dt> |
572 <dd> |
754 <dd> |
573 reference to the project object (Project) |
755 reference to the project object (Project) |
574 </dd> |
756 </dd> |
575 </dl><dl> |
757 </dl> |
|
758 <dl> |
576 <dt>Returns:</dt> |
759 <dt>Returns:</dt> |
577 <dd> |
760 <dd> |
578 reference to the monitor thread (QThread) |
761 reference to the monitor thread (QThread) |
579 </dd> |
762 </dd> |
580 </dl><a NAME="Hg.canCommitMerge" ID="Hg.canCommitMerge"></a> |
763 </dl> |
|
764 <a NAME="Hg.canCommitMerge" ID="Hg.canCommitMerge"></a> |
581 <h4>Hg.canCommitMerge</h4> |
765 <h4>Hg.canCommitMerge</h4> |
582 <b>canCommitMerge</b>(<i>name</i>) |
766 <b>canCommitMerge</b>(<i>name</i>) |
|
767 |
583 <p> |
768 <p> |
584 Public method to check, if the working directory is an uncommitted |
769 Public method to check, if the working directory is an uncommitted |
585 merge. |
770 merge. |
586 </p><dl> |
771 </p> |
|
772 <dl> |
|
773 |
587 <dt><i>name</i> (str)</dt> |
774 <dt><i>name</i> (str)</dt> |
588 <dd> |
775 <dd> |
589 file/directory name |
776 file/directory name |
590 </dd> |
777 </dd> |
591 </dl><dl> |
778 </dl> |
|
779 <dl> |
592 <dt>Returns:</dt> |
780 <dt>Returns:</dt> |
593 <dd> |
781 <dd> |
594 flag indicating commit merge capability |
782 flag indicating commit merge capability |
595 </dd> |
783 </dd> |
596 </dl><dl> |
784 </dl> |
|
785 <dl> |
597 <dt>Return Type:</dt> |
786 <dt>Return Type:</dt> |
598 <dd> |
787 <dd> |
599 bool |
788 bool |
600 </dd> |
789 </dd> |
601 </dl><a NAME="Hg.canPull" ID="Hg.canPull"></a> |
790 </dl> |
|
791 <a NAME="Hg.canPull" ID="Hg.canPull"></a> |
602 <h4>Hg.canPull</h4> |
792 <h4>Hg.canPull</h4> |
603 <b>canPull</b>(<i></i>) |
793 <b>canPull</b>(<i></i>) |
|
794 |
604 <p> |
795 <p> |
605 Public method to check, if pull is possible. |
796 Public method to check, if pull is possible. |
606 </p><dl> |
797 </p> |
|
798 <dl> |
607 <dt>Returns:</dt> |
799 <dt>Returns:</dt> |
608 <dd> |
800 <dd> |
609 flag indicating pull capability (boolean) |
801 flag indicating pull capability (boolean) |
610 </dd> |
802 </dd> |
611 </dl><a NAME="Hg.canPush" ID="Hg.canPush"></a> |
803 </dl> |
|
804 <a NAME="Hg.canPush" ID="Hg.canPush"></a> |
612 <h4>Hg.canPush</h4> |
805 <h4>Hg.canPush</h4> |
613 <b>canPush</b>(<i></i>) |
806 <b>canPush</b>(<i></i>) |
|
807 |
614 <p> |
808 <p> |
615 Public method to check, if push is possible. |
809 Public method to check, if push is possible. |
616 </p><dl> |
810 </p> |
|
811 <dl> |
617 <dt>Returns:</dt> |
812 <dt>Returns:</dt> |
618 <dd> |
813 <dd> |
619 flag indicating push capability (boolean) |
814 flag indicating push capability (boolean) |
620 </dd> |
815 </dd> |
621 </dl><a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a> |
816 </dl> |
|
817 <a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a> |
622 <h4>Hg.clearStatusCache</h4> |
818 <h4>Hg.clearStatusCache</h4> |
623 <b>clearStatusCache</b>(<i></i>) |
819 <b>clearStatusCache</b>(<i></i>) |
|
820 |
624 <p> |
821 <p> |
625 Public method to clear the status cache. |
822 Public method to clear the status cache. |
626 </p><a NAME="Hg.getClient" ID="Hg.getClient"></a> |
823 </p> |
|
824 <a NAME="Hg.getClient" ID="Hg.getClient"></a> |
627 <h4>Hg.getClient</h4> |
825 <h4>Hg.getClient</h4> |
628 <b>getClient</b>(<i></i>) |
826 <b>getClient</b>(<i></i>) |
|
827 |
629 <p> |
828 <p> |
630 Public method to get a reference to the command server interface. |
829 Public method to get a reference to the command server interface. |
631 </p><dl> |
830 </p> |
|
831 <dl> |
632 <dt>Returns:</dt> |
832 <dt>Returns:</dt> |
633 <dd> |
833 <dd> |
634 reference to the client (HgClient) |
834 reference to the client (HgClient) |
635 </dd> |
835 </dd> |
636 </dl><a NAME="Hg.getEncoding" ID="Hg.getEncoding"></a> |
836 </dl> |
|
837 <a NAME="Hg.getEncoding" ID="Hg.getEncoding"></a> |
637 <h4>Hg.getEncoding</h4> |
838 <h4>Hg.getEncoding</h4> |
638 <b>getEncoding</b>(<i></i>) |
839 <b>getEncoding</b>(<i></i>) |
|
840 |
639 <p> |
841 <p> |
640 Public method to get the encoding to be used by Mercurial. |
842 Public method to get the encoding to be used by Mercurial. |
641 </p><dl> |
843 </p> |
|
844 <dl> |
642 <dt>Returns:</dt> |
845 <dt>Returns:</dt> |
643 <dd> |
846 <dd> |
644 encoding (string) |
847 encoding (string) |
645 </dd> |
848 </dd> |
646 </dl><a NAME="Hg.getExtensionObject" ID="Hg.getExtensionObject"></a> |
849 </dl> |
|
850 <a NAME="Hg.getExtensionObject" ID="Hg.getExtensionObject"></a> |
647 <h4>Hg.getExtensionObject</h4> |
851 <h4>Hg.getExtensionObject</h4> |
648 <b>getExtensionObject</b>(<i>extensionName</i>) |
852 <b>getExtensionObject</b>(<i>extensionName</i>) |
|
853 |
649 <p> |
854 <p> |
650 Public method to get a reference to an extension object. |
855 Public method to get a reference to an extension object. |
651 </p><dl> |
856 </p> |
|
857 <dl> |
|
858 |
652 <dt><i>extensionName</i></dt> |
859 <dt><i>extensionName</i></dt> |
653 <dd> |
860 <dd> |
654 name of the extension (string) |
861 name of the extension (string) |
655 </dd> |
862 </dd> |
656 </dl><dl> |
863 </dl> |
|
864 <dl> |
657 <dt>Returns:</dt> |
865 <dt>Returns:</dt> |
658 <dd> |
866 <dd> |
659 reference to the extension object (boolean) |
867 reference to the extension object (boolean) |
660 </dd> |
868 </dd> |
661 </dl><a NAME="Hg.getHgSubPath" ID="Hg.getHgSubPath"></a> |
869 </dl> |
|
870 <a NAME="Hg.getHgSubPath" ID="Hg.getHgSubPath"></a> |
662 <h4>Hg.getHgSubPath</h4> |
871 <h4>Hg.getHgSubPath</h4> |
663 <b>getHgSubPath</b>(<i></i>) |
872 <b>getHgSubPath</b>(<i></i>) |
|
873 |
664 <p> |
874 <p> |
665 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 |
666 definitions of sub-repositories. |
876 definitions of sub-repositories. |
667 </p><dl> |
877 </p> |
|
878 <dl> |
668 <dt>Returns:</dt> |
879 <dt>Returns:</dt> |
669 <dd> |
880 <dd> |
670 full path of the .hgsub file (string) |
881 full path of the .hgsub file (string) |
671 </dd> |
882 </dd> |
672 </dl><a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a> |
883 </dl> |
|
884 <a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a> |
673 <h4>Hg.getPlugin</h4> |
885 <h4>Hg.getPlugin</h4> |
674 <b>getPlugin</b>(<i></i>) |
886 <b>getPlugin</b>(<i></i>) |
|
887 |
675 <p> |
888 <p> |
676 Public method to get a reference to the plugin object. |
889 Public method to get a reference to the plugin object. |
677 </p><dl> |
890 </p> |
|
891 <dl> |
678 <dt>Returns:</dt> |
892 <dt>Returns:</dt> |
679 <dd> |
893 <dd> |
680 reference to the plugin object (VcsMercurialPlugin) |
894 reference to the plugin object (VcsMercurialPlugin) |
681 </dd> |
895 </dd> |
682 </dl><a NAME="Hg.hasSubrepositories" ID="Hg.hasSubrepositories"></a> |
896 </dl> |
|
897 <a NAME="Hg.hasSubrepositories" ID="Hg.hasSubrepositories"></a> |
683 <h4>Hg.hasSubrepositories</h4> |
898 <h4>Hg.hasSubrepositories</h4> |
684 <b>hasSubrepositories</b>(<i></i>) |
899 <b>hasSubrepositories</b>(<i></i>) |
|
900 |
685 <p> |
901 <p> |
686 Public method to check, if the project might have sub-repositories. |
902 Public method to check, if the project might have sub-repositories. |
687 </p><dl> |
903 </p> |
|
904 <dl> |
688 <dt>Returns:</dt> |
905 <dt>Returns:</dt> |
689 <dd> |
906 <dd> |
690 flag indicating the existence of sub-repositories (boolean) |
907 flag indicating the existence of sub-repositories (boolean) |
691 </dd> |
908 </dd> |
692 </dl><a NAME="Hg.hgAbortMerge" ID="Hg.hgAbortMerge"></a> |
909 </dl> |
|
910 <a NAME="Hg.hgAbortMerge" ID="Hg.hgAbortMerge"></a> |
693 <h4>Hg.hgAbortMerge</h4> |
911 <h4>Hg.hgAbortMerge</h4> |
694 <b>hgAbortMerge</b>(<i>name</i>) |
912 <b>hgAbortMerge</b>(<i>name</i>) |
|
913 |
695 <p> |
914 <p> |
696 Public method to abort an uncommitted merge. |
915 Public method to abort an uncommitted merge. |
697 </p><dl> |
916 </p> |
|
917 <dl> |
|
918 |
698 <dt><i>name</i></dt> |
919 <dt><i>name</i></dt> |
699 <dd> |
920 <dd> |
700 file/directory name (string) |
921 file/directory name (string) |
701 </dd> |
922 </dd> |
702 </dl><dl> |
923 </dl> |
|
924 <dl> |
703 <dt>Returns:</dt> |
925 <dt>Returns:</dt> |
704 <dd> |
926 <dd> |
705 flag indicating, that the abortion contained an add |
927 flag indicating, that the abortion contained an add |
706 or delete (boolean) |
928 or delete (boolean) |
707 </dd> |
929 </dd> |
708 </dl><a NAME="Hg.hgAddSubrepository" ID="Hg.hgAddSubrepository"></a> |
930 </dl> |
|
931 <a NAME="Hg.hgAddSubrepository" ID="Hg.hgAddSubrepository"></a> |
709 <h4>Hg.hgAddSubrepository</h4> |
932 <h4>Hg.hgAddSubrepository</h4> |
710 <b>hgAddSubrepository</b>(<i></i>) |
933 <b>hgAddSubrepository</b>(<i></i>) |
|
934 |
711 <p> |
935 <p> |
712 Public method to add a sub-repository. |
936 Public method to add a sub-repository. |
713 </p><a NAME="Hg.hgAnnotate" ID="Hg.hgAnnotate"></a> |
937 </p> |
|
938 <a NAME="Hg.hgAnnotate" ID="Hg.hgAnnotate"></a> |
714 <h4>Hg.hgAnnotate</h4> |
939 <h4>Hg.hgAnnotate</h4> |
715 <b>hgAnnotate</b>(<i>name</i>) |
940 <b>hgAnnotate</b>(<i>name</i>) |
|
941 |
716 <p> |
942 <p> |
717 Public method to show the output of the hg annotate command. |
943 Public method to show the output of the hg annotate command. |
718 </p><dl> |
944 </p> |
|
945 <dl> |
|
946 |
719 <dt><i>name</i></dt> |
947 <dt><i>name</i></dt> |
720 <dd> |
948 <dd> |
721 file name to show the annotations for (string) |
949 file name to show the annotations for (string) |
722 </dd> |
950 </dd> |
723 </dl><a NAME="Hg.hgArchive" ID="Hg.hgArchive"></a> |
951 </dl> |
|
952 <a NAME="Hg.hgArchive" ID="Hg.hgArchive"></a> |
724 <h4>Hg.hgArchive</h4> |
953 <h4>Hg.hgArchive</h4> |
725 <b>hgArchive</b>(<i></i>) |
954 <b>hgArchive</b>(<i></i>) |
|
955 |
726 <p> |
956 <p> |
727 Public method to create an unversioned archive from the repository. |
957 Public method to create an unversioned archive from the repository. |
728 </p><a NAME="Hg.hgBackout" ID="Hg.hgBackout"></a> |
958 </p> |
|
959 <a NAME="Hg.hgBackout" ID="Hg.hgBackout"></a> |
729 <h4>Hg.hgBackout</h4> |
960 <h4>Hg.hgBackout</h4> |
730 <b>hgBackout</b>(<i>name</i>) |
961 <b>hgBackout</b>(<i>name</i>) |
|
962 |
731 <p> |
963 <p> |
732 Public method used to backout an earlier changeset from the Mercurial |
964 Public method used to backout an earlier changeset from the Mercurial |
733 repository. |
965 repository. |
734 </p><dl> |
966 </p> |
|
967 <dl> |
|
968 |
735 <dt><i>name</i></dt> |
969 <dt><i>name</i></dt> |
736 <dd> |
970 <dd> |
737 directory name (string or list of strings) |
971 directory name (string or list of strings) |
738 </dd> |
972 </dd> |
739 </dl><a NAME="Hg.hgBisect" ID="Hg.hgBisect"></a> |
973 </dl> |
|
974 <a NAME="Hg.hgBisect" ID="Hg.hgBisect"></a> |
740 <h4>Hg.hgBisect</h4> |
975 <h4>Hg.hgBisect</h4> |
741 <b>hgBisect</b>(<i>name, subcommand</i>) |
976 <b>hgBisect</b>(<i>name, subcommand</i>) |
|
977 |
742 <p> |
978 <p> |
743 Public method to perform bisect commands. |
979 Public method to perform bisect commands. |
744 </p><dl> |
980 </p> |
|
981 <dl> |
|
982 |
745 <dt><i>name</i></dt> |
983 <dt><i>name</i></dt> |
746 <dd> |
984 <dd> |
747 file/directory name (string) |
985 file/directory name (string) |
748 </dd><dt><i>subcommand</i></dt> |
986 </dd> |
|
987 <dt><i>subcommand</i></dt> |
749 <dd> |
988 <dd> |
750 name of the subcommand (string, one of 'good', 'bad', |
989 name of the subcommand (string, one of 'good', 'bad', |
751 'skip' or 'reset') |
990 'skip' or 'reset') |
752 </dd> |
991 </dd> |
753 </dl><dl> |
992 </dl> |
|
993 <dl> |
|
994 |
754 <dt>Raises <b>ValueError</b>:</dt> |
995 <dt>Raises <b>ValueError</b>:</dt> |
755 <dd> |
996 <dd> |
756 raised to indicate an invalid bisect subcommand |
997 raised to indicate an invalid bisect subcommand |
757 </dd> |
998 </dd> |
758 </dl><a NAME="Hg.hgBookmarkDefine" ID="Hg.hgBookmarkDefine"></a> |
999 </dl> |
|
1000 <a NAME="Hg.hgBookmarkDefine" ID="Hg.hgBookmarkDefine"></a> |
759 <h4>Hg.hgBookmarkDefine</h4> |
1001 <h4>Hg.hgBookmarkDefine</h4> |
760 <b>hgBookmarkDefine</b>(<i>name, revision=None, bookmark=None</i>) |
1002 <b>hgBookmarkDefine</b>(<i>name, revision=None, bookmark=None</i>) |
|
1003 |
761 <p> |
1004 <p> |
762 Public method to define a bookmark. |
1005 Public method to define a bookmark. |
763 </p><dl> |
1006 </p> |
|
1007 <dl> |
|
1008 |
764 <dt><i>name</i></dt> |
1009 <dt><i>name</i></dt> |
765 <dd> |
1010 <dd> |
766 file/directory name (string) |
1011 file/directory name (string) |
767 </dd><dt><i>revision</i></dt> |
1012 </dd> |
|
1013 <dt><i>revision</i></dt> |
768 <dd> |
1014 <dd> |
769 revision to set bookmark for (string) |
1015 revision to set bookmark for (string) |
770 </dd><dt><i>bookmark</i></dt> |
1016 </dd> |
|
1017 <dt><i>bookmark</i></dt> |
771 <dd> |
1018 <dd> |
772 name of the bookmark (string) |
1019 name of the bookmark (string) |
773 </dd> |
1020 </dd> |
774 </dl><a NAME="Hg.hgBookmarkDelete" ID="Hg.hgBookmarkDelete"></a> |
1021 </dl> |
|
1022 <a NAME="Hg.hgBookmarkDelete" ID="Hg.hgBookmarkDelete"></a> |
775 <h4>Hg.hgBookmarkDelete</h4> |
1023 <h4>Hg.hgBookmarkDelete</h4> |
776 <b>hgBookmarkDelete</b>(<i>name, bookmark=None</i>) |
1024 <b>hgBookmarkDelete</b>(<i>name, bookmark=None</i>) |
|
1025 |
777 <p> |
1026 <p> |
778 Public method to delete a bookmark. |
1027 Public method to delete a bookmark. |
779 </p><dl> |
1028 </p> |
|
1029 <dl> |
|
1030 |
780 <dt><i>name</i></dt> |
1031 <dt><i>name</i></dt> |
781 <dd> |
1032 <dd> |
782 file/directory name (string) |
1033 file/directory name (string) |
783 </dd><dt><i>bookmark</i></dt> |
1034 </dd> |
|
1035 <dt><i>bookmark</i></dt> |
784 <dd> |
1036 <dd> |
785 name of the bookmark (string) |
1037 name of the bookmark (string) |
786 </dd> |
1038 </dd> |
787 </dl><a NAME="Hg.hgBookmarkIncoming" ID="Hg.hgBookmarkIncoming"></a> |
1039 </dl> |
|
1040 <a NAME="Hg.hgBookmarkIncoming" ID="Hg.hgBookmarkIncoming"></a> |
788 <h4>Hg.hgBookmarkIncoming</h4> |
1041 <h4>Hg.hgBookmarkIncoming</h4> |
789 <b>hgBookmarkIncoming</b>(<i>name</i>) |
1042 <b>hgBookmarkIncoming</b>(<i>name</i>) |
|
1043 |
790 <p> |
1044 <p> |
791 Public method to show a list of incoming bookmarks. |
1045 Public method to show a list of incoming bookmarks. |
792 </p><dl> |
1046 </p> |
|
1047 <dl> |
|
1048 |
793 <dt><i>name</i></dt> |
1049 <dt><i>name</i></dt> |
794 <dd> |
1050 <dd> |
795 file/directory name (string) |
1051 file/directory name (string) |
796 </dd> |
1052 </dd> |
797 </dl><a NAME="Hg.hgBookmarkMove" ID="Hg.hgBookmarkMove"></a> |
1053 </dl> |
|
1054 <a NAME="Hg.hgBookmarkMove" ID="Hg.hgBookmarkMove"></a> |
798 <h4>Hg.hgBookmarkMove</h4> |
1055 <h4>Hg.hgBookmarkMove</h4> |
799 <b>hgBookmarkMove</b>(<i>name, revision=None, bookmark=None</i>) |
1056 <b>hgBookmarkMove</b>(<i>name, revision=None, bookmark=None</i>) |
|
1057 |
800 <p> |
1058 <p> |
801 Public method to move a bookmark. |
1059 Public method to move a bookmark. |
802 </p><dl> |
1060 </p> |
|
1061 <dl> |
|
1062 |
803 <dt><i>name</i></dt> |
1063 <dt><i>name</i></dt> |
804 <dd> |
1064 <dd> |
805 file/directory name (string) |
1065 file/directory name (string) |
806 </dd><dt><i>revision</i></dt> |
1066 </dd> |
|
1067 <dt><i>revision</i></dt> |
807 <dd> |
1068 <dd> |
808 revision to set bookmark for (string) |
1069 revision to set bookmark for (string) |
809 </dd><dt><i>bookmark</i></dt> |
1070 </dd> |
|
1071 <dt><i>bookmark</i></dt> |
810 <dd> |
1072 <dd> |
811 name of the bookmark (string) |
1073 name of the bookmark (string) |
812 </dd> |
1074 </dd> |
813 </dl><a NAME="Hg.hgBookmarkOutgoing" ID="Hg.hgBookmarkOutgoing"></a> |
1075 </dl> |
|
1076 <a NAME="Hg.hgBookmarkOutgoing" ID="Hg.hgBookmarkOutgoing"></a> |
814 <h4>Hg.hgBookmarkOutgoing</h4> |
1077 <h4>Hg.hgBookmarkOutgoing</h4> |
815 <b>hgBookmarkOutgoing</b>(<i>name</i>) |
1078 <b>hgBookmarkOutgoing</b>(<i>name</i>) |
|
1079 |
816 <p> |
1080 <p> |
817 Public method to show a list of outgoing bookmarks. |
1081 Public method to show a list of outgoing bookmarks. |
818 </p><dl> |
1082 </p> |
|
1083 <dl> |
|
1084 |
819 <dt><i>name</i></dt> |
1085 <dt><i>name</i></dt> |
820 <dd> |
1086 <dd> |
821 file/directory name (string) |
1087 file/directory name (string) |
822 </dd> |
1088 </dd> |
823 </dl><a NAME="Hg.hgBookmarkPull" ID="Hg.hgBookmarkPull"></a> |
1089 </dl> |
|
1090 <a NAME="Hg.hgBookmarkPull" ID="Hg.hgBookmarkPull"></a> |
824 <h4>Hg.hgBookmarkPull</h4> |
1091 <h4>Hg.hgBookmarkPull</h4> |
825 <b>hgBookmarkPull</b>(<i>name, current=False, bookmark=None</i>) |
1092 <b>hgBookmarkPull</b>(<i>name, current=False, bookmark=None</i>) |
|
1093 |
826 <p> |
1094 <p> |
827 Public method to pull a bookmark from a remote repository. |
1095 Public method to pull a bookmark from a remote repository. |
828 </p><dl> |
1096 </p> |
|
1097 <dl> |
|
1098 |
829 <dt><i>name</i> (str)</dt> |
1099 <dt><i>name</i> (str)</dt> |
830 <dd> |
1100 <dd> |
831 file/directory name |
1101 file/directory name |
832 </dd><dt><i>current</i> (bool)</dt> |
1102 </dd> |
|
1103 <dt><i>current</i> (bool)</dt> |
833 <dd> |
1104 <dd> |
834 flag indicating to pull the current bookmark |
1105 flag indicating to pull the current bookmark |
835 </dd><dt><i>bookmark</i> (str)</dt> |
1106 </dd> |
|
1107 <dt><i>bookmark</i> (str)</dt> |
836 <dd> |
1108 <dd> |
837 name of the bookmark |
1109 name of the bookmark |
838 </dd> |
1110 </dd> |
839 </dl><a NAME="Hg.hgBookmarkPush" ID="Hg.hgBookmarkPush"></a> |
1111 </dl> |
|
1112 <a NAME="Hg.hgBookmarkPush" ID="Hg.hgBookmarkPush"></a> |
840 <h4>Hg.hgBookmarkPush</h4> |
1113 <h4>Hg.hgBookmarkPush</h4> |
841 <b>hgBookmarkPush</b>(<i>name, current=False, bookmark=None</i>) |
1114 <b>hgBookmarkPush</b>(<i>name, current=False, bookmark=None</i>) |
|
1115 |
842 <p> |
1116 <p> |
843 Public method to push a bookmark to a remote repository. |
1117 Public method to push a bookmark to a remote repository. |
844 </p><dl> |
1118 </p> |
|
1119 <dl> |
|
1120 |
845 <dt><i>name</i> (str)</dt> |
1121 <dt><i>name</i> (str)</dt> |
846 <dd> |
1122 <dd> |
847 file/directory name |
1123 file/directory name |
848 </dd><dt><i>current</i> (bool)</dt> |
1124 </dd> |
|
1125 <dt><i>current</i> (bool)</dt> |
849 <dd> |
1126 <dd> |
850 flag indicating to push the current bookmark |
1127 flag indicating to push the current bookmark |
851 </dd><dt><i>bookmark</i> (str)</dt> |
1128 </dd> |
|
1129 <dt><i>bookmark</i> (str)</dt> |
852 <dd> |
1130 <dd> |
853 name of the bookmark |
1131 name of the bookmark |
854 </dd> |
1132 </dd> |
855 </dl><a NAME="Hg.hgBookmarkRename" ID="Hg.hgBookmarkRename"></a> |
1133 </dl> |
|
1134 <a NAME="Hg.hgBookmarkRename" ID="Hg.hgBookmarkRename"></a> |
856 <h4>Hg.hgBookmarkRename</h4> |
1135 <h4>Hg.hgBookmarkRename</h4> |
857 <b>hgBookmarkRename</b>(<i>name, renameInfo=None</i>) |
1136 <b>hgBookmarkRename</b>(<i>name, renameInfo=None</i>) |
|
1137 |
858 <p> |
1138 <p> |
859 Public method to rename a bookmark. |
1139 Public method to rename a bookmark. |
860 </p><dl> |
1140 </p> |
|
1141 <dl> |
|
1142 |
861 <dt><i>name</i> (str)</dt> |
1143 <dt><i>name</i> (str)</dt> |
862 <dd> |
1144 <dd> |
863 file/directory name |
1145 file/directory name |
864 </dd><dt><i>renameInfo</i> (tuple of str and str)</dt> |
1146 </dd> |
|
1147 <dt><i>renameInfo</i> (tuple of str and str)</dt> |
865 <dd> |
1148 <dd> |
866 old and new names of the bookmark |
1149 old and new names of the bookmark |
867 </dd> |
1150 </dd> |
868 </dl><a NAME="Hg.hgBranch" ID="Hg.hgBranch"></a> |
1151 </dl> |
|
1152 <a NAME="Hg.hgBranch" ID="Hg.hgBranch"></a> |
869 <h4>Hg.hgBranch</h4> |
1153 <h4>Hg.hgBranch</h4> |
870 <b>hgBranch</b>(<i>name</i>) |
1154 <b>hgBranch</b>(<i>name</i>) |
|
1155 |
871 <p> |
1156 <p> |
872 Public method used to create a branch in the Mercurial repository. |
1157 Public method used to create a branch in the Mercurial repository. |
873 </p><dl> |
1158 </p> |
|
1159 <dl> |
|
1160 |
874 <dt><i>name</i></dt> |
1161 <dt><i>name</i></dt> |
875 <dd> |
1162 <dd> |
876 file/directory name to be branched (string) |
1163 file/directory name to be branched (string) |
877 </dd> |
1164 </dd> |
878 </dl><a NAME="Hg.hgBundle" ID="Hg.hgBundle"></a> |
1165 </dl> |
|
1166 <a NAME="Hg.hgBundle" ID="Hg.hgBundle"></a> |
879 <h4>Hg.hgBundle</h4> |
1167 <h4>Hg.hgBundle</h4> |
880 <b>hgBundle</b>(<i>name, bundleData=None</i>) |
1168 <b>hgBundle</b>(<i>name, bundleData=None</i>) |
|
1169 |
881 <p> |
1170 <p> |
882 Public method to create a changegroup file. |
1171 Public method to create a changegroup file. |
883 </p><dl> |
1172 </p> |
|
1173 <dl> |
|
1174 |
884 <dt><i>name</i> (str)</dt> |
1175 <dt><i>name</i> (str)</dt> |
885 <dd> |
1176 <dd> |
886 file/directory name |
1177 file/directory name |
887 </dd><dt><i>bundleData</i> (dict)</dt> |
1178 </dd> |
|
1179 <dt><i>bundleData</i> (dict)</dt> |
888 <dd> |
1180 <dd> |
889 dictionary containing the bundle creation information |
1181 dictionary containing the bundle creation information |
890 </dd> |
1182 </dd> |
891 </dl><a NAME="Hg.hgConflicts" ID="Hg.hgConflicts"></a> |
1183 </dl> |
|
1184 <a NAME="Hg.hgConflicts" ID="Hg.hgConflicts"></a> |
892 <h4>Hg.hgConflicts</h4> |
1185 <h4>Hg.hgConflicts</h4> |
893 <b>hgConflicts</b>(<i>name</i>) |
1186 <b>hgConflicts</b>(<i>name</i>) |
|
1187 |
894 <p> |
1188 <p> |
895 Public method used to show a list of files containing conflicts. |
1189 Public method used to show a list of files containing conflicts. |
896 </p><dl> |
1190 </p> |
|
1191 <dl> |
|
1192 |
897 <dt><i>name</i></dt> |
1193 <dt><i>name</i></dt> |
898 <dd> |
1194 <dd> |
899 file/directory name to be resolved (string) |
1195 file/directory name to be resolved (string) |
900 </dd> |
1196 </dd> |
901 </dl><a NAME="Hg.hgCopy" ID="Hg.hgCopy"></a> |
1197 </dl> |
|
1198 <a NAME="Hg.hgCopy" ID="Hg.hgCopy"></a> |
902 <h4>Hg.hgCopy</h4> |
1199 <h4>Hg.hgCopy</h4> |
903 <b>hgCopy</b>(<i>name, project</i>) |
1200 <b>hgCopy</b>(<i>name, project</i>) |
|
1201 |
904 <p> |
1202 <p> |
905 Public method used to copy a file/directory. |
1203 Public method used to copy a file/directory. |
906 </p><dl> |
1204 </p> |
|
1205 <dl> |
|
1206 |
907 <dt><i>name</i></dt> |
1207 <dt><i>name</i></dt> |
908 <dd> |
1208 <dd> |
909 file/directory name to be copied (string) |
1209 file/directory name to be copied (string) |
910 </dd><dt><i>project</i></dt> |
1210 </dd> |
|
1211 <dt><i>project</i></dt> |
911 <dd> |
1212 <dd> |
912 reference to the project object |
1213 reference to the project object |
913 </dd> |
1214 </dd> |
914 </dl><dl> |
1215 </dl> |
|
1216 <dl> |
915 <dt>Returns:</dt> |
1217 <dt>Returns:</dt> |
916 <dd> |
1218 <dd> |
917 flag indicating successful operation (boolean) |
1219 flag indicating successful operation (boolean) |
918 </dd> |
1220 </dd> |
919 </dl><a NAME="Hg.hgCreateIgnoreFile" ID="Hg.hgCreateIgnoreFile"></a> |
1221 </dl> |
|
1222 <a NAME="Hg.hgCreateIgnoreFile" ID="Hg.hgCreateIgnoreFile"></a> |
920 <h4>Hg.hgCreateIgnoreFile</h4> |
1223 <h4>Hg.hgCreateIgnoreFile</h4> |
921 <b>hgCreateIgnoreFile</b>(<i>name, autoAdd=False</i>) |
1224 <b>hgCreateIgnoreFile</b>(<i>name, autoAdd=False</i>) |
|
1225 |
922 <p> |
1226 <p> |
923 Public method to create the ignore file. |
1227 Public method to create the ignore file. |
924 </p><dl> |
1228 </p> |
|
1229 <dl> |
|
1230 |
925 <dt><i>name</i></dt> |
1231 <dt><i>name</i></dt> |
926 <dd> |
1232 <dd> |
927 directory name to create the ignore file in (string) |
1233 directory name to create the ignore file in (string) |
928 </dd><dt><i>autoAdd</i></dt> |
1234 </dd> |
|
1235 <dt><i>autoAdd</i></dt> |
929 <dd> |
1236 <dd> |
930 flag indicating to add it automatically (boolean) |
1237 flag indicating to add it automatically (boolean) |
931 </dd> |
1238 </dd> |
932 </dl><dl> |
1239 </dl> |
|
1240 <dl> |
933 <dt>Returns:</dt> |
1241 <dt>Returns:</dt> |
934 <dd> |
1242 <dd> |
935 flag indicating success |
1243 flag indicating success |
936 </dd> |
1244 </dd> |
937 </dl><a NAME="Hg.hgDeleteBackups" ID="Hg.hgDeleteBackups"></a> |
1245 </dl> |
|
1246 <a NAME="Hg.hgDeleteBackups" ID="Hg.hgDeleteBackups"></a> |
938 <h4>Hg.hgDeleteBackups</h4> |
1247 <h4>Hg.hgDeleteBackups</h4> |
939 <b>hgDeleteBackups</b>(<i></i>) |
1248 <b>hgDeleteBackups</b>(<i></i>) |
|
1249 |
940 <p> |
1250 <p> |
941 Public method to delete all backup bundles in the backup area. |
1251 Public method to delete all backup bundles in the backup area. |
942 </p><a NAME="Hg.hgEditConfig" ID="Hg.hgEditConfig"></a> |
1252 </p> |
|
1253 <a NAME="Hg.hgEditConfig" ID="Hg.hgEditConfig"></a> |
943 <h4>Hg.hgEditConfig</h4> |
1254 <h4>Hg.hgEditConfig</h4> |
944 <b>hgEditConfig</b>(<i>name, withLargefiles=True, largefilesData=None</i>) |
1255 <b>hgEditConfig</b>(<i>name, withLargefiles=True, largefilesData=None</i>) |
|
1256 |
945 <p> |
1257 <p> |
946 Public method used to edit the repository configuration file. |
1258 Public method used to edit the repository configuration file. |
947 </p><dl> |
1259 </p> |
|
1260 <dl> |
|
1261 |
948 <dt><i>name</i></dt> |
1262 <dt><i>name</i></dt> |
949 <dd> |
1263 <dd> |
950 file/directory name (string) |
1264 file/directory name (string) |
951 </dd><dt><i>withLargefiles</i></dt> |
1265 </dd> |
|
1266 <dt><i>withLargefiles</i></dt> |
952 <dd> |
1267 <dd> |
953 flag indicating to configure the largefiles |
1268 flag indicating to configure the largefiles |
954 section (boolean) |
1269 section (boolean) |
955 </dd><dt><i>largefilesData</i></dt> |
1270 </dd> |
|
1271 <dt><i>largefilesData</i></dt> |
956 <dd> |
1272 <dd> |
957 dictionary with data for the largefiles |
1273 dictionary with data for the largefiles |
958 section of the data dialog (dict) |
1274 section of the data dialog (dict) |
959 </dd> |
1275 </dd> |
960 </dl><a NAME="Hg.hgEditUserConfig" ID="Hg.hgEditUserConfig"></a> |
1276 </dl> |
|
1277 <a NAME="Hg.hgEditUserConfig" ID="Hg.hgEditUserConfig"></a> |
961 <h4>Hg.hgEditUserConfig</h4> |
1278 <h4>Hg.hgEditUserConfig</h4> |
962 <b>hgEditUserConfig</b>(<i></i>) |
1279 <b>hgEditUserConfig</b>(<i></i>) |
|
1280 |
963 <p> |
1281 <p> |
964 Public method used to edit the user configuration file. |
1282 Public method used to edit the user configuration file. |
965 </p><a NAME="Hg.hgExport" ID="Hg.hgExport"></a> |
1283 </p> |
|
1284 <a NAME="Hg.hgExport" ID="Hg.hgExport"></a> |
966 <h4>Hg.hgExport</h4> |
1285 <h4>Hg.hgExport</h4> |
967 <b>hgExport</b>(<i>name</i>) |
1286 <b>hgExport</b>(<i>name</i>) |
|
1287 |
968 <p> |
1288 <p> |
969 Public method to export patches to files. |
1289 Public method to export patches to files. |
970 </p><dl> |
1290 </p> |
|
1291 <dl> |
|
1292 |
971 <dt><i>name</i></dt> |
1293 <dt><i>name</i></dt> |
972 <dd> |
1294 <dd> |
973 directory name of the project to export from (string) |
1295 directory name of the project to export from (string) |
974 </dd> |
1296 </dd> |
975 </dl><a NAME="Hg.hgExtendedDiff" ID="Hg.hgExtendedDiff"></a> |
1297 </dl> |
|
1298 <a NAME="Hg.hgExtendedDiff" ID="Hg.hgExtendedDiff"></a> |
976 <h4>Hg.hgExtendedDiff</h4> |
1299 <h4>Hg.hgExtendedDiff</h4> |
977 <b>hgExtendedDiff</b>(<i>name</i>) |
1300 <b>hgExtendedDiff</b>(<i>name</i>) |
|
1301 |
978 <p> |
1302 <p> |
979 Public method used to view the difference of a file/directory to the |
1303 Public method used to view the difference of a file/directory to the |
980 Mercurial repository. |
1304 Mercurial repository. |
981 </p><p> |
1305 </p> |
|
1306 <p> |
982 If name is a directory and is the project directory, all project files |
1307 If name is a directory and is the project directory, all project files |
983 are saved first. If name is a file (or list of files), which is/are |
1308 are saved first. If name is a file (or list of files), which is/are |
984 being edited and has unsaved modification, they can be saved or the |
1309 being edited and has unsaved modification, they can be saved or the |
985 operation may be aborted. |
1310 operation may be aborted. |
986 </p><p> |
1311 </p> |
|
1312 <p> |
987 This method gives the chance to enter the revisions to be compared. |
1313 This method gives the chance to enter the revisions to be compared. |
988 </p><dl> |
1314 </p> |
|
1315 <dl> |
|
1316 |
989 <dt><i>name</i></dt> |
1317 <dt><i>name</i></dt> |
990 <dd> |
1318 <dd> |
991 file/directory name to be diffed (string) |
1319 file/directory name to be diffed (string) |
992 </dd> |
1320 </dd> |
993 </dl><a NAME="Hg.hgForget" ID="Hg.hgForget"></a> |
1321 </dl> |
|
1322 <a NAME="Hg.hgForget" ID="Hg.hgForget"></a> |
994 <h4>Hg.hgForget</h4> |
1323 <h4>Hg.hgForget</h4> |
995 <b>hgForget</b>(<i>name</i>) |
1324 <b>hgForget</b>(<i>name</i>) |
|
1325 |
996 <p> |
1326 <p> |
997 Public method used to remove a file from the Mercurial repository. |
1327 Public method used to remove a file from the Mercurial repository. |
998 </p><p> |
1328 </p> |
|
1329 <p> |
999 This will not remove the file from the project directory. |
1330 This will not remove the file from the project directory. |
1000 </p><dl> |
1331 </p> |
|
1332 <dl> |
|
1333 |
1001 <dt><i>name</i></dt> |
1334 <dt><i>name</i></dt> |
1002 <dd> |
1335 <dd> |
1003 file/directory name to be removed (string or list of |
1336 file/directory name to be removed (string or list of |
1004 strings)) |
1337 strings)) |
1005 </dd> |
1338 </dd> |
1006 </dl><a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a> |
1339 </dl> |
|
1340 <a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a> |
1007 <h4>Hg.hgGetBookmarksList</h4> |
1341 <h4>Hg.hgGetBookmarksList</h4> |
1008 <b>hgGetBookmarksList</b>(<i>repodir</i>) |
1342 <b>hgGetBookmarksList</b>(<i>repodir</i>) |
|
1343 |
1009 <p> |
1344 <p> |
1010 Public method to get the list of bookmarks. |
1345 Public method to get the list of bookmarks. |
1011 </p><dl> |
1346 </p> |
|
1347 <dl> |
|
1348 |
1012 <dt><i>repodir</i></dt> |
1349 <dt><i>repodir</i></dt> |
1013 <dd> |
1350 <dd> |
1014 directory name of the repository (string) |
1351 directory name of the repository (string) |
1015 </dd> |
1352 </dd> |
1016 </dl><dl> |
1353 </dl> |
|
1354 <dl> |
1017 <dt>Returns:</dt> |
1355 <dt>Returns:</dt> |
1018 <dd> |
1356 <dd> |
1019 list of bookmarks (list of string) |
1357 list of bookmarks (list of string) |
1020 </dd> |
1358 </dd> |
1021 </dl><a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a> |
1359 </dl> |
|
1360 <a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a> |
1022 <h4>Hg.hgGetBranchesList</h4> |
1361 <h4>Hg.hgGetBranchesList</h4> |
1023 <b>hgGetBranchesList</b>(<i>repodir</i>) |
1362 <b>hgGetBranchesList</b>(<i>repodir</i>) |
|
1363 |
1024 <p> |
1364 <p> |
1025 Public method to get the list of branches. |
1365 Public method to get the list of branches. |
1026 </p><dl> |
1366 </p> |
|
1367 <dl> |
|
1368 |
1027 <dt><i>repodir</i></dt> |
1369 <dt><i>repodir</i></dt> |
1028 <dd> |
1370 <dd> |
1029 directory name of the repository (string) |
1371 directory name of the repository (string) |
1030 </dd> |
1372 </dd> |
1031 </dl><dl> |
1373 </dl> |
|
1374 <dl> |
1032 <dt>Returns:</dt> |
1375 <dt>Returns:</dt> |
1033 <dd> |
1376 <dd> |
1034 list of branches (list of string) |
1377 list of branches (list of string) |
1035 </dd> |
1378 </dd> |
1036 </dl><a NAME="Hg.hgGetCurrentBranch" ID="Hg.hgGetCurrentBranch"></a> |
1379 </dl> |
|
1380 <a NAME="Hg.hgGetCurrentBranch" ID="Hg.hgGetCurrentBranch"></a> |
1037 <h4>Hg.hgGetCurrentBranch</h4> |
1381 <h4>Hg.hgGetCurrentBranch</h4> |
1038 <b>hgGetCurrentBranch</b>(<i>repodir</i>) |
1382 <b>hgGetCurrentBranch</b>(<i>repodir</i>) |
|
1383 |
1039 <p> |
1384 <p> |
1040 Public method to get the current branch of the working directory. |
1385 Public method to get the current branch of the working directory. |
1041 </p><dl> |
1386 </p> |
|
1387 <dl> |
|
1388 |
1042 <dt><i>repodir</i> (str)</dt> |
1389 <dt><i>repodir</i> (str)</dt> |
1043 <dd> |
1390 <dd> |
1044 directory name of the repository |
1391 directory name of the repository |
1045 </dd> |
1392 </dd> |
1046 </dl><dl> |
1393 </dl> |
|
1394 <dl> |
1047 <dt>Returns:</dt> |
1395 <dt>Returns:</dt> |
1048 <dd> |
1396 <dd> |
1049 name of the current branch |
1397 name of the current branch |
1050 </dd> |
1398 </dd> |
1051 </dl><dl> |
1399 </dl> |
|
1400 <dl> |
1052 <dt>Return Type:</dt> |
1401 <dt>Return Type:</dt> |
1053 <dd> |
1402 <dd> |
1054 str |
1403 str |
1055 </dd> |
1404 </dd> |
1056 </dl><a NAME="Hg.hgGetTagsList" ID="Hg.hgGetTagsList"></a> |
1405 </dl> |
|
1406 <a NAME="Hg.hgGetTagsList" ID="Hg.hgGetTagsList"></a> |
1057 <h4>Hg.hgGetTagsList</h4> |
1407 <h4>Hg.hgGetTagsList</h4> |
1058 <b>hgGetTagsList</b>(<i>repodir, withType=False</i>) |
1408 <b>hgGetTagsList</b>(<i>repodir, withType=False</i>) |
|
1409 |
1059 <p> |
1410 <p> |
1060 Public method to get the list of tags. |
1411 Public method to get the list of tags. |
1061 </p><dl> |
1412 </p> |
|
1413 <dl> |
|
1414 |
1062 <dt><i>repodir</i></dt> |
1415 <dt><i>repodir</i></dt> |
1063 <dd> |
1416 <dd> |
1064 directory name of the repository (string) |
1417 directory name of the repository (string) |
1065 </dd><dt><i>withType</i></dt> |
1418 </dd> |
|
1419 <dt><i>withType</i></dt> |
1066 <dd> |
1420 <dd> |
1067 flag indicating to get the tag type as well (boolean) |
1421 flag indicating to get the tag type as well (boolean) |
1068 </dd> |
1422 </dd> |
1069 </dl><dl> |
1423 </dl> |
|
1424 <dl> |
1070 <dt>Returns:</dt> |
1425 <dt>Returns:</dt> |
1071 <dd> |
1426 <dd> |
1072 list of tags (list of string) or list of tuples of |
1427 list of tags (list of string) or list of tuples of |
1073 tag name and flag indicating a local tag (list of tuple of string |
1428 tag name and flag indicating a local tag (list of tuple of string |
1074 and boolean), if withType is True |
1429 and boolean), if withType is True |
1075 </dd> |
1430 </dd> |
1076 </dl><a NAME="Hg.hgGraft" ID="Hg.hgGraft"></a> |
1431 </dl> |
|
1432 <a NAME="Hg.hgGraft" ID="Hg.hgGraft"></a> |
1077 <h4>Hg.hgGraft</h4> |
1433 <h4>Hg.hgGraft</h4> |
1078 <b>hgGraft</b>(<i>path, revs=None</i>) |
1434 <b>hgGraft</b>(<i>path, revs=None</i>) |
|
1435 |
1079 <p> |
1436 <p> |
1080 Public method to copy changesets from another branch. |
1437 Public method to copy changesets from another branch. |
1081 </p><dl> |
1438 </p> |
|
1439 <dl> |
|
1440 |
1082 <dt><i>path</i></dt> |
1441 <dt><i>path</i></dt> |
1083 <dd> |
1442 <dd> |
1084 directory name of the project (string) |
1443 directory name of the project (string) |
1085 </dd><dt><i>revs</i></dt> |
1444 </dd> |
|
1445 <dt><i>revs</i></dt> |
1086 <dd> |
1446 <dd> |
1087 list of revisions to show in the revisions pane (list of |
1447 list of revisions to show in the revisions pane (list of |
1088 strings) |
1448 strings) |
1089 </dd> |
1449 </dd> |
1090 </dl><dl> |
1450 </dl> |
|
1451 <dl> |
1091 <dt>Returns:</dt> |
1452 <dt>Returns:</dt> |
1092 <dd> |
1453 <dd> |
1093 flag indicating that the project should be reread (boolean) |
1454 flag indicating that the project should be reread (boolean) |
1094 </dd> |
1455 </dd> |
1095 </dl><a NAME="Hg.hgGraftAbort" ID="Hg.hgGraftAbort"></a> |
1456 </dl> |
|
1457 <a NAME="Hg.hgGraftAbort" ID="Hg.hgGraftAbort"></a> |
1096 <h4>Hg.hgGraftAbort</h4> |
1458 <h4>Hg.hgGraftAbort</h4> |
1097 <b>hgGraftAbort</b>(<i>path</i>) |
1459 <b>hgGraftAbort</b>(<i>path</i>) |
|
1460 |
1098 <p> |
1461 <p> |
1099 Public method to abort an interrupted copying session and perform |
1462 Public method to abort an interrupted copying session and perform |
1100 a rollback. |
1463 a rollback. |
1101 </p><dl> |
1464 </p> |
|
1465 <dl> |
|
1466 |
1102 <dt><i>path</i> (str)</dt> |
1467 <dt><i>path</i> (str)</dt> |
1103 <dd> |
1468 <dd> |
1104 directory name of the project |
1469 directory name of the project |
1105 </dd> |
1470 </dd> |
1106 </dl><dl> |
1471 </dl> |
|
1472 <dl> |
1107 <dt>Returns:</dt> |
1473 <dt>Returns:</dt> |
1108 <dd> |
1474 <dd> |
1109 flag indicating that the project should be reread |
1475 flag indicating that the project should be reread |
1110 </dd> |
1476 </dd> |
1111 </dl><dl> |
1477 </dl> |
|
1478 <dl> |
1112 <dt>Return Type:</dt> |
1479 <dt>Return Type:</dt> |
1113 <dd> |
1480 <dd> |
1114 bool |
1481 bool |
1115 </dd> |
1482 </dd> |
1116 </dl><a NAME="Hg.hgGraftContinue" ID="Hg.hgGraftContinue"></a> |
1483 </dl> |
|
1484 <a NAME="Hg.hgGraftContinue" ID="Hg.hgGraftContinue"></a> |
1117 <h4>Hg.hgGraftContinue</h4> |
1485 <h4>Hg.hgGraftContinue</h4> |
1118 <b>hgGraftContinue</b>(<i>path</i>) |
1486 <b>hgGraftContinue</b>(<i>path</i>) |
|
1487 |
1119 <p> |
1488 <p> |
1120 Public method to continue copying changesets from another branch. |
1489 Public method to continue copying changesets from another branch. |
1121 </p><dl> |
1490 </p> |
|
1491 <dl> |
|
1492 |
1122 <dt><i>path</i> (str)</dt> |
1493 <dt><i>path</i> (str)</dt> |
1123 <dd> |
1494 <dd> |
1124 directory name of the project |
1495 directory name of the project |
1125 </dd> |
1496 </dd> |
1126 </dl><dl> |
1497 </dl> |
|
1498 <dl> |
1127 <dt>Returns:</dt> |
1499 <dt>Returns:</dt> |
1128 <dd> |
1500 <dd> |
1129 flag indicating that the project should be reread |
1501 flag indicating that the project should be reread |
1130 </dd> |
1502 </dd> |
1131 </dl><dl> |
1503 </dl> |
|
1504 <dl> |
1132 <dt>Return Type:</dt> |
1505 <dt>Return Type:</dt> |
1133 <dd> |
1506 <dd> |
1134 bool |
1507 bool |
1135 </dd> |
1508 </dd> |
1136 </dl><a NAME="Hg.hgGraftStop" ID="Hg.hgGraftStop"></a> |
1509 </dl> |
|
1510 <a NAME="Hg.hgGraftStop" ID="Hg.hgGraftStop"></a> |
1137 <h4>Hg.hgGraftStop</h4> |
1511 <h4>Hg.hgGraftStop</h4> |
1138 <b>hgGraftStop</b>(<i>path</i>) |
1512 <b>hgGraftStop</b>(<i>path</i>) |
|
1513 |
1139 <p> |
1514 <p> |
1140 Public method to stop an interrupted copying session. |
1515 Public method to stop an interrupted copying session. |
1141 </p><dl> |
1516 </p> |
|
1517 <dl> |
|
1518 |
1142 <dt><i>path</i> (str)</dt> |
1519 <dt><i>path</i> (str)</dt> |
1143 <dd> |
1520 <dd> |
1144 directory name of the project |
1521 directory name of the project |
1145 </dd> |
1522 </dd> |
1146 </dl><dl> |
1523 </dl> |
|
1524 <dl> |
1147 <dt>Returns:</dt> |
1525 <dt>Returns:</dt> |
1148 <dd> |
1526 <dd> |
1149 flag indicating that the project should be reread |
1527 flag indicating that the project should be reread |
1150 </dd> |
1528 </dd> |
1151 </dl><dl> |
1529 </dl> |
|
1530 <dl> |
1152 <dt>Return Type:</dt> |
1531 <dt>Return Type:</dt> |
1153 <dd> |
1532 <dd> |
1154 bool |
1533 bool |
1155 </dd> |
1534 </dd> |
1156 </dl><a NAME="Hg.hgIdentify" ID="Hg.hgIdentify"></a> |
1535 </dl> |
|
1536 <a NAME="Hg.hgIdentify" ID="Hg.hgIdentify"></a> |
1157 <h4>Hg.hgIdentify</h4> |
1537 <h4>Hg.hgIdentify</h4> |
1158 <b>hgIdentify</b>(<i>name</i>) |
1538 <b>hgIdentify</b>(<i>name</i>) |
|
1539 |
1159 <p> |
1540 <p> |
1160 Public method to identify the current working directory. |
1541 Public method to identify the current working directory. |
1161 </p><dl> |
1542 </p> |
|
1543 <dl> |
|
1544 |
1162 <dt><i>name</i></dt> |
1545 <dt><i>name</i></dt> |
1163 <dd> |
1546 <dd> |
1164 file/directory name (string) |
1547 file/directory name (string) |
1165 </dd> |
1548 </dd> |
1166 </dl><a NAME="Hg.hgImport" ID="Hg.hgImport"></a> |
1549 </dl> |
|
1550 <a NAME="Hg.hgImport" ID="Hg.hgImport"></a> |
1167 <h4>Hg.hgImport</h4> |
1551 <h4>Hg.hgImport</h4> |
1168 <b>hgImport</b>(<i>name</i>) |
1552 <b>hgImport</b>(<i>name</i>) |
|
1553 |
1169 <p> |
1554 <p> |
1170 Public method to import a patch file. |
1555 Public method to import a patch file. |
1171 </p><dl> |
1556 </p> |
|
1557 <dl> |
|
1558 |
1172 <dt><i>name</i></dt> |
1559 <dt><i>name</i></dt> |
1173 <dd> |
1560 <dd> |
1174 directory name of the project to import into (string) |
1561 directory name of the project to import into (string) |
1175 </dd> |
1562 </dd> |
1176 </dl><dl> |
1563 </dl> |
|
1564 <dl> |
1177 <dt>Returns:</dt> |
1565 <dt>Returns:</dt> |
1178 <dd> |
1566 <dd> |
1179 flag indicating, that the import contained an add, a delete |
1567 flag indicating, that the import contained an add, a delete |
1180 or a change to the project file (boolean) |
1568 or a change to the project file (boolean) |
1181 </dd> |
1569 </dd> |
1182 </dl><a NAME="Hg.hgIncoming" ID="Hg.hgIncoming"></a> |
1570 </dl> |
|
1571 <a NAME="Hg.hgIncoming" ID="Hg.hgIncoming"></a> |
1183 <h4>Hg.hgIncoming</h4> |
1572 <h4>Hg.hgIncoming</h4> |
1184 <b>hgIncoming</b>(<i>name</i>) |
1573 <b>hgIncoming</b>(<i>name</i>) |
|
1574 |
1185 <p> |
1575 <p> |
1186 Public method used to view the log of incoming changes from the |
1576 Public method used to view the log of incoming changes from the |
1187 Mercurial repository. |
1577 Mercurial repository. |
1188 </p><dl> |
1578 </p> |
|
1579 <dl> |
|
1580 |
1189 <dt><i>name</i></dt> |
1581 <dt><i>name</i></dt> |
1190 <dd> |
1582 <dd> |
1191 file/directory name to show the log of (string) |
1583 file/directory name to show the log of (string) |
1192 </dd> |
1584 </dd> |
1193 </dl><a NAME="Hg.hgInfo" ID="Hg.hgInfo"></a> |
1585 </dl> |
|
1586 <a NAME="Hg.hgInfo" ID="Hg.hgInfo"></a> |
1194 <h4>Hg.hgInfo</h4> |
1587 <h4>Hg.hgInfo</h4> |
1195 <b>hgInfo</b>(<i>ppath, mode="heads"</i>) |
1588 <b>hgInfo</b>(<i>ppath, mode="heads"</i>) |
|
1589 |
1196 <p> |
1590 <p> |
1197 Public method to show information about the heads of the repository. |
1591 Public method to show information about the heads of the repository. |
1198 </p><dl> |
1592 </p> |
|
1593 <dl> |
|
1594 |
1199 <dt><i>ppath</i></dt> |
1595 <dt><i>ppath</i></dt> |
1200 <dd> |
1596 <dd> |
1201 local path to get the repository infos (string) |
1597 local path to get the repository infos (string) |
1202 </dd><dt><i>mode=</i></dt> |
1598 </dd> |
|
1599 <dt><i>mode=</i></dt> |
1203 <dd> |
1600 <dd> |
1204 mode of the operation (string, one of heads, parents, |
1601 mode of the operation (string, one of heads, parents, |
1205 tip) |
1602 tip) |
1206 </dd> |
1603 </dd> |
1207 </dl><a NAME="Hg.hgListBookmarks" ID="Hg.hgListBookmarks"></a> |
1604 </dl> |
|
1605 <a NAME="Hg.hgListBookmarks" ID="Hg.hgListBookmarks"></a> |
1208 <h4>Hg.hgListBookmarks</h4> |
1606 <h4>Hg.hgListBookmarks</h4> |
1209 <b>hgListBookmarks</b>(<i>path</i>) |
1607 <b>hgListBookmarks</b>(<i>path</i>) |
|
1608 |
1210 <p> |
1609 <p> |
1211 Public method used to list the available bookmarks. |
1610 Public method used to list the available bookmarks. |
1212 </p><dl> |
1611 </p> |
|
1612 <dl> |
|
1613 |
1213 <dt><i>path</i></dt> |
1614 <dt><i>path</i></dt> |
1214 <dd> |
1615 <dd> |
1215 directory name of the project (string) |
1616 directory name of the project (string) |
1216 </dd> |
1617 </dd> |
1217 </dl><a NAME="Hg.hgListTagBranch" ID="Hg.hgListTagBranch"></a> |
1618 </dl> |
|
1619 <a NAME="Hg.hgListTagBranch" ID="Hg.hgListTagBranch"></a> |
1218 <h4>Hg.hgListTagBranch</h4> |
1620 <h4>Hg.hgListTagBranch</h4> |
1219 <b>hgListTagBranch</b>(<i>path, tags=True</i>) |
1621 <b>hgListTagBranch</b>(<i>path, tags=True</i>) |
|
1622 |
1220 <p> |
1623 <p> |
1221 Public method used to list the available tags or branches. |
1624 Public method used to list the available tags or branches. |
1222 </p><dl> |
1625 </p> |
|
1626 <dl> |
|
1627 |
1223 <dt><i>path</i></dt> |
1628 <dt><i>path</i></dt> |
1224 <dd> |
1629 <dd> |
1225 directory name of the project (string) |
1630 directory name of the project (string) |
1226 </dd><dt><i>tags</i></dt> |
1631 </dd> |
|
1632 <dt><i>tags</i></dt> |
1227 <dd> |
1633 <dd> |
1228 flag indicating listing of branches or tags |
1634 flag indicating listing of branches or tags |
1229 (False = branches, True = tags) |
1635 (False = branches, True = tags) |
1230 </dd> |
1636 </dd> |
1231 </dl><a NAME="Hg.hgNormalizeURL" ID="Hg.hgNormalizeURL"></a> |
1637 </dl> |
|
1638 <a NAME="Hg.hgNormalizeURL" ID="Hg.hgNormalizeURL"></a> |
1232 <h4>Hg.hgNormalizeURL</h4> |
1639 <h4>Hg.hgNormalizeURL</h4> |
1233 <b>hgNormalizeURL</b>(<i>url</i>) |
1640 <b>hgNormalizeURL</b>(<i>url</i>) |
|
1641 |
1234 <p> |
1642 <p> |
1235 Public method to normalize a url for Mercurial. |
1643 Public method to normalize a url for Mercurial. |
1236 </p><dl> |
1644 </p> |
|
1645 <dl> |
|
1646 |
1237 <dt><i>url</i></dt> |
1647 <dt><i>url</i></dt> |
1238 <dd> |
1648 <dd> |
1239 url string (string) |
1649 url string (string) |
1240 </dd> |
1650 </dd> |
1241 </dl><dl> |
1651 </dl> |
|
1652 <dl> |
1242 <dt>Returns:</dt> |
1653 <dt>Returns:</dt> |
1243 <dd> |
1654 <dd> |
1244 properly normalized url for mercurial (string) |
1655 properly normalized url for mercurial (string) |
1245 </dd> |
1656 </dd> |
1246 </dl><a NAME="Hg.hgOutgoing" ID="Hg.hgOutgoing"></a> |
1657 </dl> |
|
1658 <a NAME="Hg.hgOutgoing" ID="Hg.hgOutgoing"></a> |
1247 <h4>Hg.hgOutgoing</h4> |
1659 <h4>Hg.hgOutgoing</h4> |
1248 <b>hgOutgoing</b>(<i>name</i>) |
1660 <b>hgOutgoing</b>(<i>name</i>) |
|
1661 |
1249 <p> |
1662 <p> |
1250 Public method used to view the log of outgoing changes from the |
1663 Public method used to view the log of outgoing changes from the |
1251 Mercurial repository. |
1664 Mercurial repository. |
1252 </p><dl> |
1665 </p> |
|
1666 <dl> |
|
1667 |
1253 <dt><i>name</i></dt> |
1668 <dt><i>name</i></dt> |
1254 <dd> |
1669 <dd> |
1255 file/directory name to show the log of (string) |
1670 file/directory name to show the log of (string) |
1256 </dd> |
1671 </dd> |
1257 </dl><a NAME="Hg.hgPhase" ID="Hg.hgPhase"></a> |
1672 </dl> |
|
1673 <a NAME="Hg.hgPhase" ID="Hg.hgPhase"></a> |
1258 <h4>Hg.hgPhase</h4> |
1674 <h4>Hg.hgPhase</h4> |
1259 <b>hgPhase</b>(<i>name, data=None</i>) |
1675 <b>hgPhase</b>(<i>name, data=None</i>) |
|
1676 |
1260 <p> |
1677 <p> |
1261 Public method to change the phase of revisions. |
1678 Public method to change the phase of revisions. |
1262 </p><dl> |
1679 </p> |
|
1680 <dl> |
|
1681 |
1263 <dt><i>name</i></dt> |
1682 <dt><i>name</i></dt> |
1264 <dd> |
1683 <dd> |
1265 directory name of the project to export from (string) |
1684 directory name of the project to export from (string) |
1266 </dd><dt><i>data</i></dt> |
1685 </dd> |
|
1686 <dt><i>data</i></dt> |
1267 <dd> |
1687 <dd> |
1268 tuple giving phase data (list of revisions, phase, flag |
1688 tuple giving phase data (list of revisions, phase, flag |
1269 indicating a forced operation) (list of strings, string, boolean) |
1689 indicating a forced operation) (list of strings, string, boolean) |
1270 </dd> |
1690 </dd> |
1271 </dl><dl> |
1691 </dl> |
|
1692 <dl> |
1272 <dt>Returns:</dt> |
1693 <dt>Returns:</dt> |
1273 <dd> |
1694 <dd> |
1274 flag indicating success (boolean) |
1695 flag indicating success (boolean) |
1275 </dd> |
1696 </dd> |
1276 </dl><dl> |
1697 </dl> |
|
1698 <dl> |
|
1699 |
1277 <dt>Raises <b>ValueError</b>:</dt> |
1700 <dt>Raises <b>ValueError</b>:</dt> |
1278 <dd> |
1701 <dd> |
1279 raised to indicate an invalid phase |
1702 raised to indicate an invalid phase |
1280 </dd> |
1703 </dd> |
1281 </dl><a NAME="Hg.hgPreviewBundle" ID="Hg.hgPreviewBundle"></a> |
1704 </dl> |
|
1705 <a NAME="Hg.hgPreviewBundle" ID="Hg.hgPreviewBundle"></a> |
1282 <h4>Hg.hgPreviewBundle</h4> |
1706 <h4>Hg.hgPreviewBundle</h4> |
1283 <b>hgPreviewBundle</b>(<i>name</i>) |
1707 <b>hgPreviewBundle</b>(<i>name</i>) |
|
1708 |
1284 <p> |
1709 <p> |
1285 Public method used to view the log of incoming changes from a |
1710 Public method used to view the log of incoming changes from a |
1286 changegroup file. |
1711 changegroup file. |
1287 </p><dl> |
1712 </p> |
|
1713 <dl> |
|
1714 |
1288 <dt><i>name</i></dt> |
1715 <dt><i>name</i></dt> |
1289 <dd> |
1716 <dd> |
1290 directory name on which to base the changegroup (string) |
1717 directory name on which to base the changegroup (string) |
1291 </dd> |
1718 </dd> |
1292 </dl><a NAME="Hg.hgPull" ID="Hg.hgPull"></a> |
1719 </dl> |
|
1720 <a NAME="Hg.hgPull" ID="Hg.hgPull"></a> |
1293 <h4>Hg.hgPull</h4> |
1721 <h4>Hg.hgPull</h4> |
1294 <b>hgPull</b>(<i>name, revisions=None</i>) |
1722 <b>hgPull</b>(<i>name, revisions=None</i>) |
|
1723 |
1295 <p> |
1724 <p> |
1296 Public method used to pull changes from a remote Mercurial repository. |
1725 Public method used to pull changes from a remote Mercurial repository. |
1297 </p><dl> |
1726 </p> |
|
1727 <dl> |
|
1728 |
1298 <dt><i>name</i> (str)</dt> |
1729 <dt><i>name</i> (str)</dt> |
1299 <dd> |
1730 <dd> |
1300 directory name of the project to be pulled to |
1731 directory name of the project to be pulled to |
1301 </dd><dt><i>revisions</i> (list of str)</dt> |
1732 </dd> |
|
1733 <dt><i>revisions</i> (list of str)</dt> |
1302 <dd> |
1734 <dd> |
1303 list of revisions to be pulled |
1735 list of revisions to be pulled |
1304 </dd> |
1736 </dd> |
1305 </dl><dl> |
1737 </dl> |
|
1738 <dl> |
1306 <dt>Returns:</dt> |
1739 <dt>Returns:</dt> |
1307 <dd> |
1740 <dd> |
1308 flag indicating, that the update contained an add |
1741 flag indicating, that the update contained an add |
1309 or delete |
1742 or delete |
1310 </dd> |
1743 </dd> |
1311 </dl><dl> |
1744 </dl> |
|
1745 <dl> |
1312 <dt>Return Type:</dt> |
1746 <dt>Return Type:</dt> |
1313 <dd> |
1747 <dd> |
1314 bool |
1748 bool |
1315 </dd> |
1749 </dd> |
1316 </dl><a NAME="Hg.hgPush" ID="Hg.hgPush"></a> |
1750 </dl> |
|
1751 <a NAME="Hg.hgPush" ID="Hg.hgPush"></a> |
1317 <h4>Hg.hgPush</h4> |
1752 <h4>Hg.hgPush</h4> |
1318 <b>hgPush</b>(<i>name, force=False, newBranch=False, rev=None</i>) |
1753 <b>hgPush</b>(<i>name, force=False, newBranch=False, rev=None</i>) |
|
1754 |
1319 <p> |
1755 <p> |
1320 Public method used to push changes to a remote Mercurial repository. |
1756 Public method used to push changes to a remote Mercurial repository. |
1321 </p><dl> |
1757 </p> |
|
1758 <dl> |
|
1759 |
1322 <dt><i>name</i></dt> |
1760 <dt><i>name</i></dt> |
1323 <dd> |
1761 <dd> |
1324 directory name of the project to be pushed from (string) |
1762 directory name of the project to be pushed from (string) |
1325 </dd><dt><i>force=</i></dt> |
1763 </dd> |
|
1764 <dt><i>force=</i></dt> |
1326 <dd> |
1765 <dd> |
1327 flag indicating a forced push (boolean) |
1766 flag indicating a forced push (boolean) |
1328 </dd><dt><i>newBranch=</i></dt> |
1767 </dd> |
|
1768 <dt><i>newBranch=</i></dt> |
1329 <dd> |
1769 <dd> |
1330 flag indicating to push a new branch (boolean) |
1770 flag indicating to push a new branch (boolean) |
1331 </dd><dt><i>rev=</i></dt> |
1771 </dd> |
|
1772 <dt><i>rev=</i></dt> |
1332 <dd> |
1773 <dd> |
1333 revision to be pushed (including all ancestors) (string) |
1774 revision to be pushed (including all ancestors) (string) |
1334 </dd> |
1775 </dd> |
1335 </dl><a NAME="Hg.hgReMerge" ID="Hg.hgReMerge"></a> |
1776 </dl> |
|
1777 <a NAME="Hg.hgReMerge" ID="Hg.hgReMerge"></a> |
1336 <h4>Hg.hgReMerge</h4> |
1778 <h4>Hg.hgReMerge</h4> |
1337 <b>hgReMerge</b>(<i>name</i>) |
1779 <b>hgReMerge</b>(<i>name</i>) |
|
1780 |
1338 <p> |
1781 <p> |
1339 Public method used to merge a URL/revision into the local project. |
1782 Public method used to merge a URL/revision into the local project. |
1340 </p><dl> |
1783 </p> |
|
1784 <dl> |
|
1785 |
1341 <dt><i>name</i></dt> |
1786 <dt><i>name</i></dt> |
1342 <dd> |
1787 <dd> |
1343 file/directory name to be merged (string) |
1788 file/directory name to be merged (string) |
1344 </dd> |
1789 </dd> |
1345 </dl><a NAME="Hg.hgRecover" ID="Hg.hgRecover"></a> |
1790 </dl> |
|
1791 <a NAME="Hg.hgRecover" ID="Hg.hgRecover"></a> |
1346 <h4>Hg.hgRecover</h4> |
1792 <h4>Hg.hgRecover</h4> |
1347 <b>hgRecover</b>(<i>name</i>) |
1793 <b>hgRecover</b>(<i>name</i>) |
|
1794 |
1348 <p> |
1795 <p> |
1349 Public method to recover an interrupted transaction. |
1796 Public method to recover an interrupted transaction. |
1350 </p><dl> |
1797 </p> |
|
1798 <dl> |
|
1799 |
1351 <dt><i>name</i></dt> |
1800 <dt><i>name</i></dt> |
1352 <dd> |
1801 <dd> |
1353 file/directory name (string) |
1802 file/directory name (string) |
1354 </dd> |
1803 </dd> |
1355 </dl><a NAME="Hg.hgRemoveSubrepositories" ID="Hg.hgRemoveSubrepositories"></a> |
1804 </dl> |
|
1805 <a NAME="Hg.hgRemoveSubrepositories" ID="Hg.hgRemoveSubrepositories"></a> |
1356 <h4>Hg.hgRemoveSubrepositories</h4> |
1806 <h4>Hg.hgRemoveSubrepositories</h4> |
1357 <b>hgRemoveSubrepositories</b>(<i></i>) |
1807 <b>hgRemoveSubrepositories</b>(<i></i>) |
|
1808 |
1358 <p> |
1809 <p> |
1359 Public method to remove sub-repositories. |
1810 Public method to remove sub-repositories. |
1360 </p><a NAME="Hg.hgResolved" ID="Hg.hgResolved"></a> |
1811 </p> |
|
1812 <a NAME="Hg.hgResolved" ID="Hg.hgResolved"></a> |
1361 <h4>Hg.hgResolved</h4> |
1813 <h4>Hg.hgResolved</h4> |
1362 <b>hgResolved</b>(<i>name, unresolve=False</i>) |
1814 <b>hgResolved</b>(<i>name, unresolve=False</i>) |
|
1815 |
1363 <p> |
1816 <p> |
1364 Public method used to resolve conflicts of a file/directory. |
1817 Public method used to resolve conflicts of a file/directory. |
1365 </p><dl> |
1818 </p> |
|
1819 <dl> |
|
1820 |
1366 <dt><i>name</i></dt> |
1821 <dt><i>name</i></dt> |
1367 <dd> |
1822 <dd> |
1368 file/directory name to be resolved (string) |
1823 file/directory name to be resolved (string) |
1369 </dd><dt><i>unresolve</i></dt> |
1824 </dd> |
|
1825 <dt><i>unresolve</i></dt> |
1370 <dd> |
1826 <dd> |
1371 flag indicating to mark the file/directory as |
1827 flag indicating to mark the file/directory as |
1372 unresolved (boolean) |
1828 unresolved (boolean) |
1373 </dd> |
1829 </dd> |
1374 </dl><a NAME="Hg.hgRevert" ID="Hg.hgRevert"></a> |
1830 </dl> |
|
1831 <a NAME="Hg.hgRevert" ID="Hg.hgRevert"></a> |
1375 <h4>Hg.hgRevert</h4> |
1832 <h4>Hg.hgRevert</h4> |
1376 <b>hgRevert</b>(<i>name</i>) |
1833 <b>hgRevert</b>(<i>name</i>) |
|
1834 |
1377 <p> |
1835 <p> |
1378 Public method used to revert changes made to a file/directory. |
1836 Public method used to revert changes made to a file/directory. |
1379 </p><dl> |
1837 </p> |
|
1838 <dl> |
|
1839 |
1380 <dt><i>name</i></dt> |
1840 <dt><i>name</i></dt> |
1381 <dd> |
1841 <dd> |
1382 file/directory name to be reverted (string) |
1842 file/directory name to be reverted (string) |
1383 </dd> |
1843 </dd> |
1384 </dl><dl> |
1844 </dl> |
|
1845 <dl> |
1385 <dt>Returns:</dt> |
1846 <dt>Returns:</dt> |
1386 <dd> |
1847 <dd> |
1387 flag indicating, that the update contained an add |
1848 flag indicating, that the update contained an add |
1388 or delete (boolean) |
1849 or delete (boolean) |
1389 </dd> |
1850 </dd> |
1390 </dl><a NAME="Hg.hgRollback" ID="Hg.hgRollback"></a> |
1851 </dl> |
|
1852 <a NAME="Hg.hgRollback" ID="Hg.hgRollback"></a> |
1391 <h4>Hg.hgRollback</h4> |
1853 <h4>Hg.hgRollback</h4> |
1392 <b>hgRollback</b>(<i>name</i>) |
1854 <b>hgRollback</b>(<i>name</i>) |
|
1855 |
1393 <p> |
1856 <p> |
1394 Public method used to rollback the last transaction. |
1857 Public method used to rollback the last transaction. |
1395 </p><dl> |
1858 </p> |
|
1859 <dl> |
|
1860 |
1396 <dt><i>name</i></dt> |
1861 <dt><i>name</i></dt> |
1397 <dd> |
1862 <dd> |
1398 directory name (string or list of strings) |
1863 directory name (string or list of strings) |
1399 </dd> |
1864 </dd> |
1400 </dl><a NAME="Hg.hgSbsDiff" ID="Hg.hgSbsDiff"></a> |
1865 </dl> |
|
1866 <a NAME="Hg.hgSbsDiff" ID="Hg.hgSbsDiff"></a> |
1401 <h4>Hg.hgSbsDiff</h4> |
1867 <h4>Hg.hgSbsDiff</h4> |
1402 <b>hgSbsDiff</b>(<i>name, extended=False, revisions=None</i>) |
1868 <b>hgSbsDiff</b>(<i>name, extended=False, revisions=None</i>) |
|
1869 |
1403 <p> |
1870 <p> |
1404 Public method used to view the difference of a file to the Mercurial |
1871 Public method used to view the difference of a file to the Mercurial |
1405 repository side-by-side. |
1872 repository side-by-side. |
1406 </p><dl> |
1873 </p> |
|
1874 <dl> |
|
1875 |
1407 <dt><i>name</i></dt> |
1876 <dt><i>name</i></dt> |
1408 <dd> |
1877 <dd> |
1409 file name to be diffed (string) |
1878 file name to be diffed (string) |
1410 </dd><dt><i>extended=</i></dt> |
1879 </dd> |
|
1880 <dt><i>extended=</i></dt> |
1411 <dd> |
1881 <dd> |
1412 flag indicating the extended variant (boolean) |
1882 flag indicating the extended variant (boolean) |
1413 </dd><dt><i>revisions=</i></dt> |
1883 </dd> |
|
1884 <dt><i>revisions=</i></dt> |
1414 <dd> |
1885 <dd> |
1415 tuple of two revisions (tuple of strings) |
1886 tuple of two revisions (tuple of strings) |
1416 </dd> |
1887 </dd> |
1417 </dl><dl> |
1888 </dl> |
|
1889 <dl> |
|
1890 |
1418 <dt>Raises <b>ValueError</b>:</dt> |
1891 <dt>Raises <b>ValueError</b>:</dt> |
1419 <dd> |
1892 <dd> |
1420 raised to indicate an invalid name parameter |
1893 raised to indicate an invalid name parameter |
1421 </dd> |
1894 </dd> |
1422 </dl><a NAME="Hg.hgServe" ID="Hg.hgServe"></a> |
1895 </dl> |
|
1896 <a NAME="Hg.hgServe" ID="Hg.hgServe"></a> |
1423 <h4>Hg.hgServe</h4> |
1897 <h4>Hg.hgServe</h4> |
1424 <b>hgServe</b>(<i>name</i>) |
1898 <b>hgServe</b>(<i>name</i>) |
|
1899 |
1425 <p> |
1900 <p> |
1426 Public method used to serve the project. |
1901 Public method used to serve the project. |
1427 </p><dl> |
1902 </p> |
|
1903 <dl> |
|
1904 |
1428 <dt><i>name</i></dt> |
1905 <dt><i>name</i></dt> |
1429 <dd> |
1906 <dd> |
1430 directory name (string) |
1907 directory name (string) |
1431 </dd> |
1908 </dd> |
1432 </dl><a NAME="Hg.hgShowBranch" ID="Hg.hgShowBranch"></a> |
1909 </dl> |
|
1910 <a NAME="Hg.hgShowBranch" ID="Hg.hgShowBranch"></a> |
1433 <h4>Hg.hgShowBranch</h4> |
1911 <h4>Hg.hgShowBranch</h4> |
1434 <b>hgShowBranch</b>(<i>name</i>) |
1912 <b>hgShowBranch</b>(<i>name</i>) |
|
1913 |
1435 <p> |
1914 <p> |
1436 Public method used to show the current branch of the working directory. |
1915 Public method used to show the current branch of the working directory. |
1437 </p><dl> |
1916 </p> |
|
1917 <dl> |
|
1918 |
1438 <dt><i>name</i></dt> |
1919 <dt><i>name</i></dt> |
1439 <dd> |
1920 <dd> |
1440 file/directory name (string) |
1921 file/directory name (string) |
1441 </dd> |
1922 </dd> |
1442 </dl><a NAME="Hg.hgShowConfig" ID="Hg.hgShowConfig"></a> |
1923 </dl> |
|
1924 <a NAME="Hg.hgShowConfig" ID="Hg.hgShowConfig"></a> |
1443 <h4>Hg.hgShowConfig</h4> |
1925 <h4>Hg.hgShowConfig</h4> |
1444 <b>hgShowConfig</b>(<i>name</i>) |
1926 <b>hgShowConfig</b>(<i>name</i>) |
|
1927 |
1445 <p> |
1928 <p> |
1446 Public method to show the combined configuration. |
1929 Public method to show the combined configuration. |
1447 </p><dl> |
1930 </p> |
|
1931 <dl> |
|
1932 |
1448 <dt><i>name</i></dt> |
1933 <dt><i>name</i></dt> |
1449 <dd> |
1934 <dd> |
1450 file/directory name (string) |
1935 file/directory name (string) |
1451 </dd> |
1936 </dd> |
1452 </dl><a NAME="Hg.hgShowPaths" ID="Hg.hgShowPaths"></a> |
1937 </dl> |
|
1938 <a NAME="Hg.hgShowPaths" ID="Hg.hgShowPaths"></a> |
1453 <h4>Hg.hgShowPaths</h4> |
1939 <h4>Hg.hgShowPaths</h4> |
1454 <b>hgShowPaths</b>(<i>name</i>) |
1940 <b>hgShowPaths</b>(<i>name</i>) |
|
1941 |
1455 <p> |
1942 <p> |
1456 Public method to show the path aliases for remote repositories. |
1943 Public method to show the path aliases for remote repositories. |
1457 </p><dl> |
1944 </p> |
|
1945 <dl> |
|
1946 |
1458 <dt><i>name</i></dt> |
1947 <dt><i>name</i></dt> |
1459 <dd> |
1948 <dd> |
1460 file/directory name (string) |
1949 file/directory name (string) |
1461 </dd> |
1950 </dd> |
1462 </dl><a NAME="Hg.hgSummary" ID="Hg.hgSummary"></a> |
1951 </dl> |
|
1952 <a NAME="Hg.hgSummary" ID="Hg.hgSummary"></a> |
1463 <h4>Hg.hgSummary</h4> |
1953 <h4>Hg.hgSummary</h4> |
1464 <b>hgSummary</b>(<i>mq=False, largefiles=False</i>) |
1954 <b>hgSummary</b>(<i>mq=False, largefiles=False</i>) |
|
1955 |
1465 <p> |
1956 <p> |
1466 Public method used to show some summary information of the |
1957 Public method used to show some summary information of the |
1467 working directory state. |
1958 working directory state. |
1468 </p><dl> |
1959 </p> |
|
1960 <dl> |
|
1961 |
1469 <dt><i>mq</i></dt> |
1962 <dt><i>mq</i></dt> |
1470 <dd> |
1963 <dd> |
1471 flag indicating to show the queue status as well (boolean) |
1964 flag indicating to show the queue status as well (boolean) |
1472 </dd><dt><i>largefiles</i></dt> |
1965 </dd> |
|
1966 <dt><i>largefiles</i></dt> |
1473 <dd> |
1967 <dd> |
1474 flag indicating to show the largefiles status as |
1968 flag indicating to show the largefiles status as |
1475 well (boolean) |
1969 well (boolean) |
1476 </dd> |
1970 </dd> |
1477 </dl><a NAME="Hg.hgUnbundle" ID="Hg.hgUnbundle"></a> |
1971 </dl> |
|
1972 <a NAME="Hg.hgUnbundle" ID="Hg.hgUnbundle"></a> |
1478 <h4>Hg.hgUnbundle</h4> |
1973 <h4>Hg.hgUnbundle</h4> |
1479 <b>hgUnbundle</b>(<i>name, files=None</i>) |
1974 <b>hgUnbundle</b>(<i>name, files=None</i>) |
|
1975 |
1480 <p> |
1976 <p> |
1481 Public method to apply changegroup files. |
1977 Public method to apply changegroup files. |
1482 </p><dl> |
1978 </p> |
|
1979 <dl> |
|
1980 |
1483 <dt><i>name</i> (str)</dt> |
1981 <dt><i>name</i> (str)</dt> |
1484 <dd> |
1982 <dd> |
1485 directory name |
1983 directory name |
1486 </dd><dt><i>files</i> (list of str)</dt> |
1984 </dd> |
|
1985 <dt><i>files</i> (list of str)</dt> |
1487 <dd> |
1986 <dd> |
1488 list of bundle files to be applied |
1987 list of bundle files to be applied |
1489 </dd> |
1988 </dd> |
1490 </dl><dl> |
1989 </dl> |
|
1990 <dl> |
1491 <dt>Returns:</dt> |
1991 <dt>Returns:</dt> |
1492 <dd> |
1992 <dd> |
1493 flag indicating, that the update contained an add |
1993 flag indicating, that the update contained an add |
1494 or delete |
1994 or delete |
1495 </dd> |
1995 </dd> |
1496 </dl><dl> |
1996 </dl> |
|
1997 <dl> |
1497 <dt>Return Type:</dt> |
1998 <dt>Return Type:</dt> |
1498 <dd> |
1999 <dd> |
1499 bool |
2000 bool |
1500 </dd> |
2001 </dd> |
1501 </dl><a NAME="Hg.hgVerify" ID="Hg.hgVerify"></a> |
2002 </dl> |
|
2003 <a NAME="Hg.hgVerify" ID="Hg.hgVerify"></a> |
1502 <h4>Hg.hgVerify</h4> |
2004 <h4>Hg.hgVerify</h4> |
1503 <b>hgVerify</b>(<i>name</i>) |
2005 <b>hgVerify</b>(<i>name</i>) |
|
2006 |
1504 <p> |
2007 <p> |
1505 Public method to verify the integrity of the repository. |
2008 Public method to verify the integrity of the repository. |
1506 </p><dl> |
2009 </p> |
|
2010 <dl> |
|
2011 |
1507 <dt><i>name</i></dt> |
2012 <dt><i>name</i></dt> |
1508 <dd> |
2013 <dd> |
1509 file/directory name (string) |
2014 file/directory name (string) |
1510 </dd> |
2015 </dd> |
1511 </dl><a NAME="Hg.initCommand" ID="Hg.initCommand"></a> |
2016 </dl> |
|
2017 <a NAME="Hg.initCommand" ID="Hg.initCommand"></a> |
1512 <h4>Hg.initCommand</h4> |
2018 <h4>Hg.initCommand</h4> |
1513 <b>initCommand</b>(<i>command</i>) |
2019 <b>initCommand</b>(<i>command</i>) |
|
2020 |
1514 <p> |
2021 <p> |
1515 Public method to initialize a command arguments list. |
2022 Public method to initialize a command arguments list. |
1516 </p><dl> |
2023 </p> |
|
2024 <dl> |
|
2025 |
1517 <dt><i>command</i></dt> |
2026 <dt><i>command</i></dt> |
1518 <dd> |
2027 <dd> |
1519 command name (string) |
2028 command name (string) |
1520 </dd> |
2029 </dd> |
1521 </dl><dl> |
2030 </dl> |
|
2031 <dl> |
1522 <dt>Returns:</dt> |
2032 <dt>Returns:</dt> |
1523 <dd> |
2033 <dd> |
1524 list of command options (list of string) |
2034 list of command options (list of string) |
1525 </dd> |
2035 </dd> |
1526 </dl><a NAME="Hg.isExtensionActive" ID="Hg.isExtensionActive"></a> |
2036 </dl> |
|
2037 <a NAME="Hg.isExtensionActive" ID="Hg.isExtensionActive"></a> |
1527 <h4>Hg.isExtensionActive</h4> |
2038 <h4>Hg.isExtensionActive</h4> |
1528 <b>isExtensionActive</b>(<i>extensionName</i>) |
2039 <b>isExtensionActive</b>(<i>extensionName</i>) |
|
2040 |
1529 <p> |
2041 <p> |
1530 Public method to check, if an extension is active. |
2042 Public method to check, if an extension is active. |
1531 </p><dl> |
2043 </p> |
|
2044 <dl> |
|
2045 |
1532 <dt><i>extensionName</i></dt> |
2046 <dt><i>extensionName</i></dt> |
1533 <dd> |
2047 <dd> |
1534 name of the extension to check for (string) |
2048 name of the extension to check for (string) |
1535 </dd> |
2049 </dd> |
1536 </dl><dl> |
2050 </dl> |
|
2051 <dl> |
1537 <dt>Returns:</dt> |
2052 <dt>Returns:</dt> |
1538 <dd> |
2053 <dd> |
1539 flag indicating an active extension (boolean) |
2054 flag indicating an active extension (boolean) |
1540 </dd> |
2055 </dd> |
1541 </dl><a NAME="Hg.vcsAdd" ID="Hg.vcsAdd"></a> |
2056 </dl> |
|
2057 <a NAME="Hg.vcsAdd" ID="Hg.vcsAdd"></a> |
1542 <h4>Hg.vcsAdd</h4> |
2058 <h4>Hg.vcsAdd</h4> |
1543 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) |
2059 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) |
|
2060 |
1544 <p> |
2061 <p> |
1545 Public method used to add a file/directory to the Mercurial repository. |
2062 Public method used to add a file/directory to the Mercurial repository. |
1546 </p><dl> |
2063 </p> |
|
2064 <dl> |
|
2065 |
1547 <dt><i>name</i></dt> |
2066 <dt><i>name</i></dt> |
1548 <dd> |
2067 <dd> |
1549 file/directory name to be added (string) |
2068 file/directory name to be added (string) |
1550 </dd><dt><i>isDir</i></dt> |
2069 </dd> |
|
2070 <dt><i>isDir</i></dt> |
1551 <dd> |
2071 <dd> |
1552 flag indicating name is a directory (boolean) |
2072 flag indicating name is a directory (boolean) |
1553 </dd><dt><i>noDialog</i></dt> |
2073 </dd> |
|
2074 <dt><i>noDialog</i></dt> |
1554 <dd> |
2075 <dd> |
1555 flag indicating quiet operations |
2076 flag indicating quiet operations |
1556 </dd> |
2077 </dd> |
1557 </dl><a NAME="Hg.vcsAddBinary" ID="Hg.vcsAddBinary"></a> |
2078 </dl> |
|
2079 <a NAME="Hg.vcsAddBinary" ID="Hg.vcsAddBinary"></a> |
1558 <h4>Hg.vcsAddBinary</h4> |
2080 <h4>Hg.vcsAddBinary</h4> |
1559 <b>vcsAddBinary</b>(<i>name, isDir=False</i>) |
2081 <b>vcsAddBinary</b>(<i>name, isDir=False</i>) |
|
2082 |
1560 <p> |
2083 <p> |
1561 Public method used to add a file/directory in binary mode to the |
2084 Public method used to add a file/directory in binary mode to the |
1562 Mercurial repository. |
2085 Mercurial repository. |
1563 </p><dl> |
2086 </p> |
|
2087 <dl> |
|
2088 |
1564 <dt><i>name</i></dt> |
2089 <dt><i>name</i></dt> |
1565 <dd> |
2090 <dd> |
1566 file/directory name to be added (string) |
2091 file/directory name to be added (string) |
1567 </dd><dt><i>isDir</i></dt> |
2092 </dd> |
|
2093 <dt><i>isDir</i></dt> |
1568 <dd> |
2094 <dd> |
1569 flag indicating name is a directory (boolean) |
2095 flag indicating name is a directory (boolean) |
1570 </dd> |
2096 </dd> |
1571 </dl><a NAME="Hg.vcsAddTree" ID="Hg.vcsAddTree"></a> |
2097 </dl> |
|
2098 <a NAME="Hg.vcsAddTree" ID="Hg.vcsAddTree"></a> |
1572 <h4>Hg.vcsAddTree</h4> |
2099 <h4>Hg.vcsAddTree</h4> |
1573 <b>vcsAddTree</b>(<i>path</i>) |
2100 <b>vcsAddTree</b>(<i>path</i>) |
|
2101 |
1574 <p> |
2102 <p> |
1575 Public method to add a directory tree rooted at path to the Mercurial |
2103 Public method to add a directory tree rooted at path to the Mercurial |
1576 repository. |
2104 repository. |
1577 </p><dl> |
2105 </p> |
|
2106 <dl> |
|
2107 |
1578 <dt><i>path</i></dt> |
2108 <dt><i>path</i></dt> |
1579 <dd> |
2109 <dd> |
1580 root directory of the tree to be added (string or list of |
2110 root directory of the tree to be added (string or list of |
1581 strings)) |
2111 strings)) |
1582 </dd> |
2112 </dd> |
1583 </dl><a NAME="Hg.vcsAllRegisteredStates" ID="Hg.vcsAllRegisteredStates"></a> |
2113 </dl> |
|
2114 <a NAME="Hg.vcsAllRegisteredStates" ID="Hg.vcsAllRegisteredStates"></a> |
1584 <h4>Hg.vcsAllRegisteredStates</h4> |
2115 <h4>Hg.vcsAllRegisteredStates</h4> |
1585 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) |
2116 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) |
|
2117 |
1586 <p> |
2118 <p> |
1587 Public method used to get the registered states of a number of files |
2119 Public method used to get the registered states of a number of files |
1588 in the vcs. |
2120 in the vcs. |
1589 </p><p> |
2121 </p> |
|
2122 <p> |
1590 <b>Note:</b> If a shortcut is to be taken, the code will only check, |
2123 <b>Note:</b> If a shortcut is to be taken, the code will only check, |
1591 if the named directory has been scanned already. If so, it is assumed, |
2124 if the named directory has been scanned already. If so, it is assumed, |
1592 that the states for all files have been populated by the previous run. |
2125 that the states for all files have been populated by the previous run. |
1593 </p><dl> |
2126 </p> |
|
2127 <dl> |
|
2128 |
1594 <dt><i>names</i></dt> |
2129 <dt><i>names</i></dt> |
1595 <dd> |
2130 <dd> |
1596 dictionary with all filenames to be checked as keys |
2131 dictionary with all filenames to be checked as keys |
1597 </dd><dt><i>dname</i></dt> |
2132 </dd> |
|
2133 <dt><i>dname</i></dt> |
1598 <dd> |
2134 <dd> |
1599 directory to check in (string) |
2135 directory to check in (string) |
1600 </dd><dt><i>shortcut</i></dt> |
2136 </dd> |
|
2137 <dt><i>shortcut</i></dt> |
1601 <dd> |
2138 <dd> |
1602 flag indicating a shortcut should be taken (boolean) |
2139 flag indicating a shortcut should be taken (boolean) |
1603 </dd> |
2140 </dd> |
1604 </dl><dl> |
2141 </dl> |
|
2142 <dl> |
1605 <dt>Returns:</dt> |
2143 <dt>Returns:</dt> |
1606 <dd> |
2144 <dd> |
1607 the received dictionary completed with a combination of |
2145 the received dictionary completed with a combination of |
1608 canBeCommited and canBeAdded or None in order to signal an error |
2146 canBeCommited and canBeAdded or None in order to signal an error |
1609 </dd> |
2147 </dd> |
1610 </dl><a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a> |
2148 </dl> |
|
2149 <a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a> |
1611 <h4>Hg.vcsCheckout</h4> |
2150 <h4>Hg.vcsCheckout</h4> |
1612 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) |
2151 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) |
|
2152 |
1613 <p> |
2153 <p> |
1614 Public method used to check the project out of a Mercurial repository |
2154 Public method used to check the project out of a Mercurial repository |
1615 (clone). |
2155 (clone). |
1616 </p><dl> |
2156 </p> |
|
2157 <dl> |
|
2158 |
1617 <dt><i>vcsDataDict</i></dt> |
2159 <dt><i>vcsDataDict</i></dt> |
1618 <dd> |
2160 <dd> |
1619 dictionary of data required for the checkout |
2161 dictionary of data required for the checkout |
1620 </dd><dt><i>projectDir</i></dt> |
2162 </dd> |
|
2163 <dt><i>projectDir</i></dt> |
1621 <dd> |
2164 <dd> |
1622 project directory to create (string) |
2165 project directory to create (string) |
1623 </dd><dt><i>noDialog</i></dt> |
2166 </dd> |
|
2167 <dt><i>noDialog</i></dt> |
1624 <dd> |
2168 <dd> |
1625 flag indicating quiet operations |
2169 flag indicating quiet operations |
1626 </dd> |
2170 </dd> |
1627 </dl><dl> |
2171 </dl> |
|
2172 <dl> |
1628 <dt>Returns:</dt> |
2173 <dt>Returns:</dt> |
1629 <dd> |
2174 <dd> |
1630 flag indicating an execution without errors (boolean) |
2175 flag indicating an execution without errors (boolean) |
1631 </dd> |
2176 </dd> |
1632 </dl><a NAME="Hg.vcsCleanup" ID="Hg.vcsCleanup"></a> |
2177 </dl> |
|
2178 <a NAME="Hg.vcsCleanup" ID="Hg.vcsCleanup"></a> |
1633 <h4>Hg.vcsCleanup</h4> |
2179 <h4>Hg.vcsCleanup</h4> |
1634 <b>vcsCleanup</b>(<i>name</i>) |
2180 <b>vcsCleanup</b>(<i>name</i>) |
|
2181 |
1635 <p> |
2182 <p> |
1636 Public method used to cleanup the working directory. |
2183 Public method used to cleanup the working directory. |
1637 </p><dl> |
2184 </p> |
|
2185 <dl> |
|
2186 |
1638 <dt><i>name</i></dt> |
2187 <dt><i>name</i></dt> |
1639 <dd> |
2188 <dd> |
1640 directory name to be cleaned up (string) |
2189 directory name to be cleaned up (string) |
1641 </dd> |
2190 </dd> |
1642 </dl><a NAME="Hg.vcsCommandLine" ID="Hg.vcsCommandLine"></a> |
2191 </dl> |
|
2192 <a NAME="Hg.vcsCommandLine" ID="Hg.vcsCommandLine"></a> |
1643 <h4>Hg.vcsCommandLine</h4> |
2193 <h4>Hg.vcsCommandLine</h4> |
1644 <b>vcsCommandLine</b>(<i>name</i>) |
2194 <b>vcsCommandLine</b>(<i>name</i>) |
|
2195 |
1645 <p> |
2196 <p> |
1646 Public method used to execute arbitrary mercurial commands. |
2197 Public method used to execute arbitrary mercurial commands. |
1647 </p><dl> |
2198 </p> |
|
2199 <dl> |
|
2200 |
1648 <dt><i>name</i></dt> |
2201 <dt><i>name</i></dt> |
1649 <dd> |
2202 <dd> |
1650 directory name of the working directory (string) |
2203 directory name of the working directory (string) |
1651 </dd> |
2204 </dd> |
1652 </dl><a NAME="Hg.vcsCommit" ID="Hg.vcsCommit"></a> |
2205 </dl> |
|
2206 <a NAME="Hg.vcsCommit" ID="Hg.vcsCommit"></a> |
1653 <h4>Hg.vcsCommit</h4> |
2207 <h4>Hg.vcsCommit</h4> |
1654 <b>vcsCommit</b>(<i>name, message, noDialog=False, closeBranch=False, mq=False, merge=False</i>) |
2208 <b>vcsCommit</b>(<i>name, message, noDialog=False, closeBranch=False, mq=False, merge=False</i>) |
|
2209 |
1655 <p> |
2210 <p> |
1656 Public method used to make the change of a file/directory permanent |
2211 Public method used to make the change of a file/directory permanent |
1657 in the Mercurial repository. |
2212 in the Mercurial repository. |
1658 </p><dl> |
2213 </p> |
|
2214 <dl> |
|
2215 |
1659 <dt><i>name</i></dt> |
2216 <dt><i>name</i></dt> |
1660 <dd> |
2217 <dd> |
1661 file/directory name to be committed (string or list of |
2218 file/directory name to be committed (string or list of |
1662 strings) |
2219 strings) |
1663 </dd><dt><i>message</i></dt> |
2220 </dd> |
|
2221 <dt><i>message</i></dt> |
1664 <dd> |
2222 <dd> |
1665 message for this operation (string) |
2223 message for this operation (string) |
1666 </dd><dt><i>noDialog</i></dt> |
2224 </dd> |
|
2225 <dt><i>noDialog</i></dt> |
1667 <dd> |
2226 <dd> |
1668 flag indicating quiet operations |
2227 flag indicating quiet operations |
1669 </dd><dt><i>closeBranch=</i></dt> |
2228 </dd> |
|
2229 <dt><i>closeBranch=</i></dt> |
1670 <dd> |
2230 <dd> |
1671 flag indicating a close branch commit (boolean) |
2231 flag indicating a close branch commit (boolean) |
1672 </dd><dt><i>mq=</i></dt> |
2232 </dd> |
|
2233 <dt><i>mq=</i></dt> |
1673 <dd> |
2234 <dd> |
1674 flag indicating a queue commit (boolean) |
2235 flag indicating a queue commit (boolean) |
1675 </dd><dt><i>merge=</i></dt> |
2236 </dd> |
|
2237 <dt><i>merge=</i></dt> |
1676 <dd> |
2238 <dd> |
1677 flag indicating a merge commit (boolean) |
2239 flag indicating a merge commit (boolean) |
1678 </dd> |
2240 </dd> |
1679 </dl><a NAME="Hg.vcsConvertProject" ID="Hg.vcsConvertProject"></a> |
2241 </dl> |
|
2242 <a NAME="Hg.vcsConvertProject" ID="Hg.vcsConvertProject"></a> |
1680 <h4>Hg.vcsConvertProject</h4> |
2243 <h4>Hg.vcsConvertProject</h4> |
1681 <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>) |
2244 <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>) |
|
2245 |
1682 <p> |
2246 <p> |
1683 Public method to convert an uncontrolled project to a version |
2247 Public method to convert an uncontrolled project to a version |
1684 controlled project. |
2248 controlled project. |
1685 </p><dl> |
2249 </p> |
|
2250 <dl> |
|
2251 |
1686 <dt><i>vcsDataDict</i> (dict)</dt> |
2252 <dt><i>vcsDataDict</i> (dict)</dt> |
1687 <dd> |
2253 <dd> |
1688 dictionary of data required for the conversion |
2254 dictionary of data required for the conversion |
1689 </dd><dt><i>project</i> (Project)</dt> |
2255 </dd> |
|
2256 <dt><i>project</i> (Project)</dt> |
1690 <dd> |
2257 <dd> |
1691 reference to the project object |
2258 reference to the project object |
1692 </dd><dt><i>addAll</i> (bool)</dt> |
2259 </dd> |
|
2260 <dt><i>addAll</i> (bool)</dt> |
1693 <dd> |
2261 <dd> |
1694 flag indicating to add all files to the repository |
2262 flag indicating to add all files to the repository |
1695 </dd> |
2263 </dd> |
1696 </dl><a NAME="Hg.vcsDiff" ID="Hg.vcsDiff"></a> |
2264 </dl> |
|
2265 <a NAME="Hg.vcsDiff" ID="Hg.vcsDiff"></a> |
1697 <h4>Hg.vcsDiff</h4> |
2266 <h4>Hg.vcsDiff</h4> |
1698 <b>vcsDiff</b>(<i>name</i>) |
2267 <b>vcsDiff</b>(<i>name</i>) |
|
2268 |
1699 <p> |
2269 <p> |
1700 Public method used to view the difference of a file/directory to the |
2270 Public method used to view the difference of a file/directory to the |
1701 Mercurial repository. |
2271 Mercurial repository. |
1702 </p><p> |
2272 </p> |
|
2273 <p> |
1703 If name is a directory and is the project directory, all project files |
2274 If name is a directory and is the project directory, all project files |
1704 are saved first. If name is a file (or list of files), which is/are |
2275 are saved first. If name is a file (or list of files), which is/are |
1705 being edited and has unsaved modification, they can be saved or the |
2276 being edited and has unsaved modification, they can be saved or the |
1706 operation may be aborted. |
2277 operation may be aborted. |
1707 </p><dl> |
2278 </p> |
|
2279 <dl> |
|
2280 |
1708 <dt><i>name</i></dt> |
2281 <dt><i>name</i></dt> |
1709 <dd> |
2282 <dd> |
1710 file/directory name to be diffed (string) |
2283 file/directory name to be diffed (string) |
1711 </dd> |
2284 </dd> |
1712 </dl><a NAME="Hg.vcsExists" ID="Hg.vcsExists"></a> |
2285 </dl> |
|
2286 <a NAME="Hg.vcsExists" ID="Hg.vcsExists"></a> |
1713 <h4>Hg.vcsExists</h4> |
2287 <h4>Hg.vcsExists</h4> |
1714 <b>vcsExists</b>(<i></i>) |
2288 <b>vcsExists</b>(<i></i>) |
|
2289 |
1715 <p> |
2290 <p> |
1716 Public method used to test for the presence of the hg executable. |
2291 Public method used to test for the presence of the hg executable. |
1717 </p><dl> |
2292 </p> |
|
2293 <dl> |
1718 <dt>Returns:</dt> |
2294 <dt>Returns:</dt> |
1719 <dd> |
2295 <dd> |
1720 flag indicating the existence (boolean) and an error message |
2296 flag indicating the existence (boolean) and an error message |
1721 (string) |
2297 (string) |
1722 </dd> |
2298 </dd> |
1723 </dl><a NAME="Hg.vcsExport" ID="Hg.vcsExport"></a> |
2299 </dl> |
|
2300 <a NAME="Hg.vcsExport" ID="Hg.vcsExport"></a> |
1724 <h4>Hg.vcsExport</h4> |
2301 <h4>Hg.vcsExport</h4> |
1725 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>) |
2302 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>) |
|
2303 |
1726 <p> |
2304 <p> |
1727 Public method used to export a directory from the Mercurial repository. |
2305 Public method used to export a directory from the Mercurial repository. |
1728 </p><dl> |
2306 </p> |
|
2307 <dl> |
|
2308 |
1729 <dt><i>vcsDataDict</i></dt> |
2309 <dt><i>vcsDataDict</i></dt> |
1730 <dd> |
2310 <dd> |
1731 dictionary of data required for the checkout |
2311 dictionary of data required for the checkout |
1732 </dd><dt><i>projectDir</i></dt> |
2312 </dd> |
|
2313 <dt><i>projectDir</i></dt> |
1733 <dd> |
2314 <dd> |
1734 project directory to create (string) |
2315 project directory to create (string) |
1735 </dd> |
2316 </dd> |
1736 </dl><dl> |
2317 </dl> |
|
2318 <dl> |
1737 <dt>Returns:</dt> |
2319 <dt>Returns:</dt> |
1738 <dd> |
2320 <dd> |
1739 flag indicating an execution without errors (boolean) |
2321 flag indicating an execution without errors (boolean) |
1740 </dd> |
2322 </dd> |
1741 </dl><a NAME="Hg.vcsGetProjectBrowserHelper" ID="Hg.vcsGetProjectBrowserHelper"></a> |
2323 </dl> |
|
2324 <a NAME="Hg.vcsGetProjectBrowserHelper" ID="Hg.vcsGetProjectBrowserHelper"></a> |
1742 <h4>Hg.vcsGetProjectBrowserHelper</h4> |
2325 <h4>Hg.vcsGetProjectBrowserHelper</h4> |
1743 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) |
2326 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) |
|
2327 |
1744 <p> |
2328 <p> |
1745 Public method to instantiate a helper object for the different |
2329 Public method to instantiate a helper object for the different |
1746 project browsers. |
2330 project browsers. |
1747 </p><dl> |
2331 </p> |
|
2332 <dl> |
|
2333 |
1748 <dt><i>browser</i></dt> |
2334 <dt><i>browser</i></dt> |
1749 <dd> |
2335 <dd> |
1750 reference to the project browser object |
2336 reference to the project browser object |
1751 </dd><dt><i>project</i></dt> |
2337 </dd> |
|
2338 <dt><i>project</i></dt> |
1752 <dd> |
2339 <dd> |
1753 reference to the project object |
2340 reference to the project object |
1754 </dd><dt><i>isTranslationsBrowser</i></dt> |
2341 </dd> |
|
2342 <dt><i>isTranslationsBrowser</i></dt> |
1755 <dd> |
2343 <dd> |
1756 flag indicating, the helper is requested |
2344 flag indicating, the helper is requested |
1757 for the translations browser (this needs some special treatment) |
2345 for the translations browser (this needs some special treatment) |
1758 </dd> |
2346 </dd> |
1759 </dl><dl> |
2347 </dl> |
|
2348 <dl> |
1760 <dt>Returns:</dt> |
2349 <dt>Returns:</dt> |
1761 <dd> |
2350 <dd> |
1762 the project browser helper object |
2351 the project browser helper object |
1763 </dd> |
2352 </dd> |
1764 </dl><a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a> |
2353 </dl> |
|
2354 <a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a> |
1765 <h4>Hg.vcsGetProjectHelper</h4> |
2355 <h4>Hg.vcsGetProjectHelper</h4> |
1766 <b>vcsGetProjectHelper</b>(<i>project</i>) |
2356 <b>vcsGetProjectHelper</b>(<i>project</i>) |
|
2357 |
1767 <p> |
2358 <p> |
1768 Public method to instantiate a helper object for the project. |
2359 Public method to instantiate a helper object for the project. |
1769 </p><dl> |
2360 </p> |
|
2361 <dl> |
|
2362 |
1770 <dt><i>project</i></dt> |
2363 <dt><i>project</i></dt> |
1771 <dd> |
2364 <dd> |
1772 reference to the project object |
2365 reference to the project object |
1773 </dd> |
2366 </dd> |
1774 </dl><dl> |
2367 </dl> |
|
2368 <dl> |
1775 <dt>Returns:</dt> |
2369 <dt>Returns:</dt> |
1776 <dd> |
2370 <dd> |
1777 the project helper object |
2371 the project helper object |
1778 </dd> |
2372 </dd> |
1779 </dl><a NAME="Hg.vcsImport" ID="Hg.vcsImport"></a> |
2373 </dl> |
|
2374 <a NAME="Hg.vcsImport" ID="Hg.vcsImport"></a> |
1780 <h4>Hg.vcsImport</h4> |
2375 <h4>Hg.vcsImport</h4> |
1781 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>) |
2376 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>) |
|
2377 |
1782 <p> |
2378 <p> |
1783 Public method used to import the project into the Mercurial repository. |
2379 Public method used to import the project into the Mercurial repository. |
1784 </p><dl> |
2380 </p> |
|
2381 <dl> |
|
2382 |
1785 <dt><i>vcsDataDict</i> (dict)</dt> |
2383 <dt><i>vcsDataDict</i> (dict)</dt> |
1786 <dd> |
2384 <dd> |
1787 dictionary of data required for the import |
2385 dictionary of data required for the import |
1788 </dd><dt><i>projectDir</i> (str)</dt> |
2386 </dd> |
|
2387 <dt><i>projectDir</i> (str)</dt> |
1789 <dd> |
2388 <dd> |
1790 project directory (string) |
2389 project directory (string) |
1791 </dd><dt><i>noDialog</i> (bool)</dt> |
2390 </dd> |
|
2391 <dt><i>noDialog</i> (bool)</dt> |
1792 <dd> |
2392 <dd> |
1793 flag indicating quiet operations |
2393 flag indicating quiet operations |
1794 </dd><dt><i>addAll</i> (bool)</dt> |
2394 </dd> |
|
2395 <dt><i>addAll</i> (bool)</dt> |
1795 <dd> |
2396 <dd> |
1796 flag indicating to add all files to the repository |
2397 flag indicating to add all files to the repository |
1797 </dd> |
2398 </dd> |
1798 </dl><dl> |
2399 </dl> |
|
2400 <dl> |
1799 <dt>Returns:</dt> |
2401 <dt>Returns:</dt> |
1800 <dd> |
2402 <dd> |
1801 tuple containing a flag indicating an execution without errors |
2403 tuple containing a flag indicating an execution without errors |
1802 and a flag indicating the version controll status |
2404 and a flag indicating the version controll status |
1803 </dd> |
2405 </dd> |
1804 </dl><dl> |
2406 </dl> |
|
2407 <dl> |
1805 <dt>Return Type:</dt> |
2408 <dt>Return Type:</dt> |
1806 <dd> |
2409 <dd> |
1807 tuple of (bool, bool) |
2410 tuple of (bool, bool) |
1808 </dd> |
2411 </dd> |
1809 </dl><a NAME="Hg.vcsInit" ID="Hg.vcsInit"></a> |
2412 </dl> |
|
2413 <a NAME="Hg.vcsInit" ID="Hg.vcsInit"></a> |
1810 <h4>Hg.vcsInit</h4> |
2414 <h4>Hg.vcsInit</h4> |
1811 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) |
2415 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) |
|
2416 |
1812 <p> |
2417 <p> |
1813 Public method used to initialize the mercurial repository. |
2418 Public method used to initialize the mercurial repository. |
1814 </p><p> |
2419 </p> |
|
2420 <p> |
1815 The initialization is done, when a project is converted into a |
2421 The initialization is done, when a project is converted into a |
1816 Mercurial controlled project. Therefore we always return TRUE without |
2422 Mercurial controlled project. Therefore we always return TRUE without |
1817 doing anything. |
2423 doing anything. |
1818 </p><dl> |
2424 </p> |
|
2425 <dl> |
|
2426 |
1819 <dt><i>vcsDir</i></dt> |
2427 <dt><i>vcsDir</i></dt> |
1820 <dd> |
2428 <dd> |
1821 name of the VCS directory (string) |
2429 name of the VCS directory (string) |
1822 </dd><dt><i>noDialog</i></dt> |
2430 </dd> |
|
2431 <dt><i>noDialog</i></dt> |
1823 <dd> |
2432 <dd> |
1824 flag indicating quiet operations (boolean) |
2433 flag indicating quiet operations (boolean) |
1825 </dd> |
2434 </dd> |
1826 </dl><dl> |
2435 </dl> |
|
2436 <dl> |
1827 <dt>Returns:</dt> |
2437 <dt>Returns:</dt> |
1828 <dd> |
2438 <dd> |
1829 always TRUE |
2439 always TRUE |
1830 </dd> |
2440 </dd> |
1831 </dl><a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a> |
2441 </dl> |
|
2442 <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a> |
1832 <h4>Hg.vcsInitConfig</h4> |
2443 <h4>Hg.vcsInitConfig</h4> |
1833 <b>vcsInitConfig</b>(<i>project</i>) |
2444 <b>vcsInitConfig</b>(<i>project</i>) |
|
2445 |
1834 <p> |
2446 <p> |
1835 Public method to initialize the VCS configuration. |
2447 Public method to initialize the VCS configuration. |
1836 </p><p> |
2448 </p> |
|
2449 <p> |
1837 This method ensures, that an ignore file exists. |
2450 This method ensures, that an ignore file exists. |
1838 </p><dl> |
2451 </p> |
|
2452 <dl> |
|
2453 |
1839 <dt><i>project</i></dt> |
2454 <dt><i>project</i></dt> |
1840 <dd> |
2455 <dd> |
1841 reference to the project (Project) |
2456 reference to the project (Project) |
1842 </dd> |
2457 </dd> |
1843 </dl><a NAME="Hg.vcsLogBrowser" ID="Hg.vcsLogBrowser"></a> |
2458 </dl> |
|
2459 <a NAME="Hg.vcsLogBrowser" ID="Hg.vcsLogBrowser"></a> |
1844 <h4>Hg.vcsLogBrowser</h4> |
2460 <h4>Hg.vcsLogBrowser</h4> |
1845 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) |
2461 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) |
|
2462 |
1846 <p> |
2463 <p> |
1847 Public method used to browse the log of a file/directory from the |
2464 Public method used to browse the log of a file/directory from the |
1848 Mercurial repository. |
2465 Mercurial repository. |
1849 </p><dl> |
2466 </p> |
|
2467 <dl> |
|
2468 |
1850 <dt><i>name</i></dt> |
2469 <dt><i>name</i></dt> |
1851 <dd> |
2470 <dd> |
1852 file/directory name to show the log of (string) |
2471 file/directory name to show the log of (string) |
1853 </dd><dt><i>isFile=</i></dt> |
2472 </dd> |
|
2473 <dt><i>isFile=</i></dt> |
1854 <dd> |
2474 <dd> |
1855 flag indicating log for a file is to be shown |
2475 flag indicating log for a file is to be shown |
1856 (boolean) |
2476 (boolean) |
1857 </dd> |
2477 </dd> |
1858 </dl><a NAME="Hg.vcsMerge" ID="Hg.vcsMerge"></a> |
2478 </dl> |
|
2479 <a NAME="Hg.vcsMerge" ID="Hg.vcsMerge"></a> |
1859 <h4>Hg.vcsMerge</h4> |
2480 <h4>Hg.vcsMerge</h4> |
1860 <b>vcsMerge</b>(<i>name, rev=""</i>) |
2481 <b>vcsMerge</b>(<i>name, rev=""</i>) |
|
2482 |
1861 <p> |
2483 <p> |
1862 Public method used to merge a URL/revision into the local project. |
2484 Public method used to merge a URL/revision into the local project. |
1863 </p><dl> |
2485 </p> |
|
2486 <dl> |
|
2487 |
1864 <dt><i>name</i> (str)</dt> |
2488 <dt><i>name</i> (str)</dt> |
1865 <dd> |
2489 <dd> |
1866 file/directory name to be merged |
2490 file/directory name to be merged |
1867 </dd><dt><i>rev=</i> (str)</dt> |
2491 </dd> |
|
2492 <dt><i>rev=</i> (str)</dt> |
1868 <dd> |
2493 <dd> |
1869 revision to merge with |
2494 revision to merge with |
1870 </dd> |
2495 </dd> |
1871 </dl><a NAME="Hg.vcsMove" ID="Hg.vcsMove"></a> |
2496 </dl> |
|
2497 <a NAME="Hg.vcsMove" ID="Hg.vcsMove"></a> |
1872 <h4>Hg.vcsMove</h4> |
2498 <h4>Hg.vcsMove</h4> |
1873 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) |
2499 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) |
|
2500 |
1874 <p> |
2501 <p> |
1875 Public method used to move a file/directory. |
2502 Public method used to move a file/directory. |
1876 </p><dl> |
2503 </p> |
|
2504 <dl> |
|
2505 |
1877 <dt><i>name</i></dt> |
2506 <dt><i>name</i></dt> |
1878 <dd> |
2507 <dd> |
1879 file/directory name to be moved (string) |
2508 file/directory name to be moved (string) |
1880 </dd><dt><i>project</i></dt> |
2509 </dd> |
|
2510 <dt><i>project</i></dt> |
1881 <dd> |
2511 <dd> |
1882 reference to the project object |
2512 reference to the project object |
1883 </dd><dt><i>target</i></dt> |
2513 </dd> |
|
2514 <dt><i>target</i></dt> |
1884 <dd> |
2515 <dd> |
1885 new name of the file/directory (string) |
2516 new name of the file/directory (string) |
1886 </dd><dt><i>noDialog</i></dt> |
2517 </dd> |
|
2518 <dt><i>noDialog</i></dt> |
1887 <dd> |
2519 <dd> |
1888 flag indicating quiet operations |
2520 flag indicating quiet operations |
1889 </dd> |
2521 </dd> |
1890 </dl><dl> |
2522 </dl> |
|
2523 <dl> |
1891 <dt>Returns:</dt> |
2524 <dt>Returns:</dt> |
1892 <dd> |
2525 <dd> |
1893 flag indicating successfull operation (boolean) |
2526 flag indicating successfull operation (boolean) |
1894 </dd> |
2527 </dd> |
1895 </dl><a NAME="Hg.vcsName" ID="Hg.vcsName"></a> |
2528 </dl> |
|
2529 <a NAME="Hg.vcsName" ID="Hg.vcsName"></a> |
1896 <h4>Hg.vcsName</h4> |
2530 <h4>Hg.vcsName</h4> |
1897 <b>vcsName</b>(<i></i>) |
2531 <b>vcsName</b>(<i></i>) |
|
2532 |
1898 <p> |
2533 <p> |
1899 Public method returning the name of the vcs. |
2534 Public method returning the name of the vcs. |
1900 </p><dl> |
2535 </p> |
|
2536 <dl> |
1901 <dt>Returns:</dt> |
2537 <dt>Returns:</dt> |
1902 <dd> |
2538 <dd> |
1903 always 'Mercurial' (string) |
2539 always 'Mercurial' (string) |
1904 </dd> |
2540 </dd> |
1905 </dl><a NAME="Hg.vcsNewProjectOptionsDialog" ID="Hg.vcsNewProjectOptionsDialog"></a> |
2541 </dl> |
|
2542 <a NAME="Hg.vcsNewProjectOptionsDialog" ID="Hg.vcsNewProjectOptionsDialog"></a> |
1906 <h4>Hg.vcsNewProjectOptionsDialog</h4> |
2543 <h4>Hg.vcsNewProjectOptionsDialog</h4> |
1907 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) |
2544 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) |
|
2545 |
1908 <p> |
2546 <p> |
1909 Public method to get a dialog to enter repository info for getting a |
2547 Public method to get a dialog to enter repository info for getting a |
1910 new project. |
2548 new project. |
1911 </p><dl> |
2549 </p> |
|
2550 <dl> |
|
2551 |
1912 <dt><i>parent</i></dt> |
2552 <dt><i>parent</i></dt> |
1913 <dd> |
2553 <dd> |
1914 parent widget (QWidget) |
2554 parent widget (QWidget) |
1915 </dd> |
2555 </dd> |
1916 </dl><dl> |
2556 </dl> |
|
2557 <dl> |
1917 <dt>Returns:</dt> |
2558 <dt>Returns:</dt> |
1918 <dd> |
2559 <dd> |
1919 reference to the instantiated options dialog |
2560 reference to the instantiated options dialog |
1920 (HgNewProjectOptionsDialog) |
2561 (HgNewProjectOptionsDialog) |
1921 </dd> |
2562 </dd> |
1922 </dl><a NAME="Hg.vcsOptionsDialog" ID="Hg.vcsOptionsDialog"></a> |
2563 </dl> |
|
2564 <a NAME="Hg.vcsOptionsDialog" ID="Hg.vcsOptionsDialog"></a> |
1923 <h4>Hg.vcsOptionsDialog</h4> |
2565 <h4>Hg.vcsOptionsDialog</h4> |
1924 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) |
2566 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) |
|
2567 |
1925 <p> |
2568 <p> |
1926 Public method to get a dialog to enter repository info. |
2569 Public method to get a dialog to enter repository info. |
1927 </p><dl> |
2570 </p> |
|
2571 <dl> |
|
2572 |
1928 <dt><i>project</i></dt> |
2573 <dt><i>project</i></dt> |
1929 <dd> |
2574 <dd> |
1930 reference to the project object |
2575 reference to the project object |
1931 </dd><dt><i>archive</i></dt> |
2576 </dd> |
|
2577 <dt><i>archive</i></dt> |
1932 <dd> |
2578 <dd> |
1933 name of the project in the repository (string) |
2579 name of the project in the repository (string) |
1934 </dd><dt><i>editable</i></dt> |
2580 </dd> |
|
2581 <dt><i>editable</i></dt> |
1935 <dd> |
2582 <dd> |
1936 flag indicating that the project name is editable |
2583 flag indicating that the project name is editable |
1937 (boolean) |
2584 (boolean) |
1938 </dd><dt><i>parent</i></dt> |
2585 </dd> |
|
2586 <dt><i>parent</i></dt> |
1939 <dd> |
2587 <dd> |
1940 parent widget (QWidget) |
2588 parent widget (QWidget) |
1941 </dd> |
2589 </dd> |
1942 </dl><dl> |
2590 </dl> |
|
2591 <dl> |
1943 <dt>Returns:</dt> |
2592 <dt>Returns:</dt> |
1944 <dd> |
2593 <dd> |
1945 reference to the instantiated options dialog (HgOptionsDialog) |
2594 reference to the instantiated options dialog (HgOptionsDialog) |
1946 </dd> |
2595 </dd> |
1947 </dl><a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a> |
2596 </dl> |
|
2597 <a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a> |
1948 <h4>Hg.vcsRegisteredState</h4> |
2598 <h4>Hg.vcsRegisteredState</h4> |
1949 <b>vcsRegisteredState</b>(<i>name</i>) |
2599 <b>vcsRegisteredState</b>(<i>name</i>) |
|
2600 |
1950 <p> |
2601 <p> |
1951 Public method used to get the registered state of a file in the vcs. |
2602 Public method used to get the registered state of a file in the vcs. |
1952 </p><dl> |
2603 </p> |
|
2604 <dl> |
|
2605 |
1953 <dt><i>name</i></dt> |
2606 <dt><i>name</i></dt> |
1954 <dd> |
2607 <dd> |
1955 filename to check (string) |
2608 filename to check (string) |
1956 </dd> |
2609 </dd> |
1957 </dl><dl> |
2610 </dl> |
|
2611 <dl> |
1958 <dt>Returns:</dt> |
2612 <dt>Returns:</dt> |
1959 <dd> |
2613 <dd> |
1960 a combination of canBeCommited and canBeAdded |
2614 a combination of canBeCommited and canBeAdded |
1961 </dd> |
2615 </dd> |
1962 </dl><a NAME="Hg.vcsRemove" ID="Hg.vcsRemove"></a> |
2616 </dl> |
|
2617 <a NAME="Hg.vcsRemove" ID="Hg.vcsRemove"></a> |
1963 <h4>Hg.vcsRemove</h4> |
2618 <h4>Hg.vcsRemove</h4> |
1964 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) |
2619 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) |
|
2620 |
1965 <p> |
2621 <p> |
1966 Public method used to remove a file/directory from the Mercurial |
2622 Public method used to remove a file/directory from the Mercurial |
1967 repository. |
2623 repository. |
1968 </p><p> |
2624 </p> |
|
2625 <p> |
1969 The default operation is to remove the local copy as well. |
2626 The default operation is to remove the local copy as well. |
1970 </p><dl> |
2627 </p> |
|
2628 <dl> |
|
2629 |
1971 <dt><i>name</i></dt> |
2630 <dt><i>name</i></dt> |
1972 <dd> |
2631 <dd> |
1973 file/directory name to be removed (string or list of |
2632 file/directory name to be removed (string or list of |
1974 strings)) |
2633 strings)) |
1975 </dd><dt><i>project</i></dt> |
2634 </dd> |
|
2635 <dt><i>project</i></dt> |
1976 <dd> |
2636 <dd> |
1977 flag indicating deletion of a project tree (boolean) |
2637 flag indicating deletion of a project tree (boolean) |
1978 (not needed) |
2638 (not needed) |
1979 </dd><dt><i>noDialog</i></dt> |
2639 </dd> |
|
2640 <dt><i>noDialog</i></dt> |
1980 <dd> |
2641 <dd> |
1981 flag indicating quiet operations |
2642 flag indicating quiet operations |
1982 </dd> |
2643 </dd> |
1983 </dl><dl> |
2644 </dl> |
|
2645 <dl> |
1984 <dt>Returns:</dt> |
2646 <dt>Returns:</dt> |
1985 <dd> |
2647 <dd> |
1986 flag indicating successfull operation (boolean) |
2648 flag indicating successfull operation (boolean) |
1987 </dd> |
2649 </dd> |
1988 </dl><a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a> |
2650 </dl> |
|
2651 <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a> |
1989 <h4>Hg.vcsRepositoryInfos</h4> |
2652 <h4>Hg.vcsRepositoryInfos</h4> |
1990 <b>vcsRepositoryInfos</b>(<i>ppath</i>) |
2653 <b>vcsRepositoryInfos</b>(<i>ppath</i>) |
|
2654 |
1991 <p> |
2655 <p> |
1992 Public method to retrieve information about the repository. |
2656 Public method to retrieve information about the repository. |
1993 </p><dl> |
2657 </p> |
|
2658 <dl> |
|
2659 |
1994 <dt><i>ppath</i></dt> |
2660 <dt><i>ppath</i></dt> |
1995 <dd> |
2661 <dd> |
1996 local path to get the repository infos (string) |
2662 local path to get the repository infos (string) |
1997 </dd> |
2663 </dd> |
1998 </dl><dl> |
2664 </dl> |
|
2665 <dl> |
1999 <dt>Returns:</dt> |
2666 <dt>Returns:</dt> |
2000 <dd> |
2667 <dd> |
2001 string with ready formated info for display (string) |
2668 string with ready formated info for display (string) |
2002 </dd> |
2669 </dd> |
2003 </dl><a NAME="Hg.vcsShutdown" ID="Hg.vcsShutdown"></a> |
2670 </dl> |
|
2671 <a NAME="Hg.vcsShutdown" ID="Hg.vcsShutdown"></a> |
2004 <h4>Hg.vcsShutdown</h4> |
2672 <h4>Hg.vcsShutdown</h4> |
2005 <b>vcsShutdown</b>(<i></i>) |
2673 <b>vcsShutdown</b>(<i></i>) |
|
2674 |
2006 <p> |
2675 <p> |
2007 Public method used to shutdown the Mercurial interface. |
2676 Public method used to shutdown the Mercurial interface. |
2008 </p><a NAME="Hg.vcsStatus" ID="Hg.vcsStatus"></a> |
2677 </p> |
|
2678 <a NAME="Hg.vcsStatus" ID="Hg.vcsStatus"></a> |
2009 <h4>Hg.vcsStatus</h4> |
2679 <h4>Hg.vcsStatus</h4> |
2010 <b>vcsStatus</b>(<i>name</i>) |
2680 <b>vcsStatus</b>(<i>name</i>) |
|
2681 |
2011 <p> |
2682 <p> |
2012 Public method used to view the status of files/directories in the |
2683 Public method used to view the status of files/directories in the |
2013 Mercurial repository. |
2684 Mercurial repository. |
2014 </p><dl> |
2685 </p> |
|
2686 <dl> |
|
2687 |
2015 <dt><i>name</i></dt> |
2688 <dt><i>name</i></dt> |
2016 <dd> |
2689 <dd> |
2017 file/directory name(s) to show the status of |
2690 file/directory name(s) to show the status of |
2018 (string or list of strings) |
2691 (string or list of strings) |
2019 </dd> |
2692 </dd> |
2020 </dl><a NAME="Hg.vcsSupportCommandOptions" ID="Hg.vcsSupportCommandOptions"></a> |
2693 </dl> |
|
2694 <a NAME="Hg.vcsSupportCommandOptions" ID="Hg.vcsSupportCommandOptions"></a> |
2021 <h4>Hg.vcsSupportCommandOptions</h4> |
2695 <h4>Hg.vcsSupportCommandOptions</h4> |
2022 <b>vcsSupportCommandOptions</b>(<i></i>) |
2696 <b>vcsSupportCommandOptions</b>(<i></i>) |
|
2697 |
2023 <p> |
2698 <p> |
2024 Public method to signal the support of user settable command options. |
2699 Public method to signal the support of user settable command options. |
2025 </p><dl> |
2700 </p> |
|
2701 <dl> |
2026 <dt>Returns:</dt> |
2702 <dt>Returns:</dt> |
2027 <dd> |
2703 <dd> |
2028 flag indicating the support of user settable command options |
2704 flag indicating the support of user settable command options |
2029 (boolean) |
2705 (boolean) |
2030 </dd> |
2706 </dd> |
2031 </dl><a NAME="Hg.vcsSwitch" ID="Hg.vcsSwitch"></a> |
2707 </dl> |
|
2708 <a NAME="Hg.vcsSwitch" ID="Hg.vcsSwitch"></a> |
2032 <h4>Hg.vcsSwitch</h4> |
2709 <h4>Hg.vcsSwitch</h4> |
2033 <b>vcsSwitch</b>(<i>name</i>) |
2710 <b>vcsSwitch</b>(<i>name</i>) |
|
2711 |
2034 <p> |
2712 <p> |
2035 Public method used to switch a working directory to a different |
2713 Public method used to switch a working directory to a different |
2036 revision. |
2714 revision. |
2037 </p><dl> |
2715 </p> |
|
2716 <dl> |
|
2717 |
2038 <dt><i>name</i></dt> |
2718 <dt><i>name</i></dt> |
2039 <dd> |
2719 <dd> |
2040 directory name to be switched (string) |
2720 directory name to be switched (string) |
2041 </dd> |
2721 </dd> |
2042 </dl><dl> |
2722 </dl> |
|
2723 <dl> |
2043 <dt>Returns:</dt> |
2724 <dt>Returns:</dt> |
2044 <dd> |
2725 <dd> |
2045 flag indicating, that the switch contained an add |
2726 flag indicating, that the switch contained an add |
2046 or delete (boolean) |
2727 or delete (boolean) |
2047 </dd> |
2728 </dd> |
2048 </dl><a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a> |
2729 </dl> |
|
2730 <a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a> |
2049 <h4>Hg.vcsTag</h4> |
2731 <h4>Hg.vcsTag</h4> |
2050 <b>vcsTag</b>(<i>name, revision=None, tagName=None</i>) |
2732 <b>vcsTag</b>(<i>name, revision=None, tagName=None</i>) |
|
2733 |
2051 <p> |
2734 <p> |
2052 Public method used to set/remove a tag in the Mercurial repository. |
2735 Public method used to set/remove a tag in the Mercurial repository. |
2053 </p><dl> |
2736 </p> |
|
2737 <dl> |
|
2738 |
2054 <dt><i>name</i></dt> |
2739 <dt><i>name</i></dt> |
2055 <dd> |
2740 <dd> |
2056 file/directory name to determine the repo root from |
2741 file/directory name to determine the repo root from |
2057 (string) |
2742 (string) |
2058 </dd><dt><i>revision</i></dt> |
2743 </dd> |
|
2744 <dt><i>revision</i></dt> |
2059 <dd> |
2745 <dd> |
2060 revision to set tag for (string) |
2746 revision to set tag for (string) |
2061 </dd><dt><i>tagName</i></dt> |
2747 </dd> |
|
2748 <dt><i>tagName</i></dt> |
2062 <dd> |
2749 <dd> |
2063 name of the tag (string) |
2750 name of the tag (string) |
2064 </dd> |
2751 </dd> |
2065 </dl><dl> |
2752 </dl> |
|
2753 <dl> |
2066 <dt>Returns:</dt> |
2754 <dt>Returns:</dt> |
2067 <dd> |
2755 <dd> |
2068 flag indicating a performed tag action (boolean) |
2756 flag indicating a performed tag action (boolean) |
2069 </dd> |
2757 </dd> |
2070 </dl><a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a> |
2758 </dl> |
|
2759 <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a> |
2071 <h4>Hg.vcsUpdate</h4> |
2760 <h4>Hg.vcsUpdate</h4> |
2072 <b>vcsUpdate</b>(<i>name, noDialog=False, revision=None</i>) |
2761 <b>vcsUpdate</b>(<i>name, noDialog=False, revision=None</i>) |
|
2762 |
2073 <p> |
2763 <p> |
2074 Public method used to update a file/directory with the Mercurial |
2764 Public method used to update a file/directory with the Mercurial |
2075 repository. |
2765 repository. |
2076 </p><dl> |
2766 </p> |
|
2767 <dl> |
|
2768 |
2077 <dt><i>name</i></dt> |
2769 <dt><i>name</i></dt> |
2078 <dd> |
2770 <dd> |
2079 file/directory name to be updated (string or list of |
2771 file/directory name to be updated (string or list of |
2080 strings) |
2772 strings) |
2081 </dd><dt><i>noDialog</i></dt> |
2773 </dd> |
|
2774 <dt><i>noDialog</i></dt> |
2082 <dd> |
2775 <dd> |
2083 flag indicating quiet operations (boolean) |
2776 flag indicating quiet operations (boolean) |
2084 </dd><dt><i>revision=</i></dt> |
2777 </dd> |
|
2778 <dt><i>revision=</i></dt> |
2085 <dd> |
2779 <dd> |
2086 revision to update to (string) |
2780 revision to update to (string) |
2087 </dd> |
2781 </dd> |
2088 </dl><dl> |
2782 </dl> |
|
2783 <dl> |
2089 <dt>Returns:</dt> |
2784 <dt>Returns:</dt> |
2090 <dd> |
2785 <dd> |
2091 flag indicating, that the update contained an add |
2786 flag indicating, that the update contained an add |
2092 or delete (boolean) |
2787 or delete (boolean) |
2093 </dd> |
2788 </dd> |