|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Plugins.VcsPlugins.vcsSubversion.subversion</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Plugins.VcsPlugins.vcsSubversion.subversion</h1> |
|
23 <p> |
|
24 Module implementing the version control systems interface to Subversion. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#Subversion">Subversion</a></td> |
|
34 <td>Class implementing the version control systems interface to Subversion.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="Subversion" ID="Subversion"></a> |
|
43 <h2>Subversion</h2> |
|
44 <p> |
|
45 Class implementing the version control systems interface to Subversion. |
|
46 </p><h3>Signals</h3> |
|
47 <dl> |
|
48 <dt>committed()</dt> |
|
49 <dd> |
|
50 emitted after the commit action has completed |
|
51 </dd> |
|
52 </dl> |
|
53 <h3>Derived from</h3> |
|
54 VersionControl |
|
55 <h3>Class Attributes</h3> |
|
56 <table> |
|
57 <tr><td>None</td></tr> |
|
58 </table> |
|
59 <h3>Class Methods</h3> |
|
60 <table> |
|
61 <tr><td>None</td></tr> |
|
62 </table> |
|
63 <h3>Methods</h3> |
|
64 <table> |
|
65 <tr> |
|
66 <td><a href="#Subversion.__init__">Subversion</a></td> |
|
67 <td>Constructor</td> |
|
68 </tr><tr> |
|
69 <td><a href="#Subversion.__svnGetFileForRevision">__svnGetFileForRevision</a></td> |
|
70 <td>Private method to get a file for a specific revision from the repository.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#Subversion.__svnURL">__svnURL</a></td> |
|
73 <td>Private method to format a url for subversion.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#Subversion.__vcsAllRegisteredStates_wc">__vcsAllRegisteredStates_wc</a></td> |
|
76 <td>Private method used to get the registered states of a number of files in the VCS.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#Subversion.__vcsAllRegisteredStates_wcng">__vcsAllRegisteredStates_wcng</a></td> |
|
79 <td>Private method used to get the registered states of a number of files in the VCS.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#Subversion.__vcsCommit_Step2">__vcsCommit_Step2</a></td> |
|
82 <td>Private slot performing the second step of the commit action.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#Subversion.__vcsRegisteredState_wc">__vcsRegisteredState_wc</a></td> |
|
85 <td>Private method used to get the registered state of a file in the VCS.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#Subversion.__vcsRegisteredState_wcng">__vcsRegisteredState_wcng</a></td> |
|
88 <td>Private method used to get the registered state of a file in the vcs.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#Subversion._createStatusMonitorThread">_createStatusMonitorThread</a></td> |
|
91 <td>Protected method to create an instance of the VCS status monitor thread.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#Subversion.clearStatusCache">clearStatusCache</a></td> |
|
94 <td>Public method to clear the status cache.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#Subversion.getPlugin">getPlugin</a></td> |
|
97 <td>Public method to get a reference to the plugin object.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#Subversion.svnAddToChangelist">svnAddToChangelist</a></td> |
|
100 <td>Public method to add a file or directory to a changelist.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#Subversion.svnBlame">svnBlame</a></td> |
|
103 <td>Public method to show the output of the svn blame command.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#Subversion.svnCopy">svnCopy</a></td> |
|
106 <td>Public method used to copy a file/directory.</td> |
|
107 </tr><tr> |
|
108 <td><a href="#Subversion.svnDelProp">svnDelProp</a></td> |
|
109 <td>Public method used to delete a property of a file/directory.</td> |
|
110 </tr><tr> |
|
111 <td><a href="#Subversion.svnExtendedDiff">svnExtendedDiff</a></td> |
|
112 <td>Public method used to view the difference of a file/directory to the Subversion repository.</td> |
|
113 </tr><tr> |
|
114 <td><a href="#Subversion.svnGetChangelists">svnGetChangelists</a></td> |
|
115 <td>Public method to get a list of all defined change lists.</td> |
|
116 </tr><tr> |
|
117 <td><a href="#Subversion.svnGetReposName">svnGetReposName</a></td> |
|
118 <td>Public method used to retrieve the URL of the subversion repository path.</td> |
|
119 </tr><tr> |
|
120 <td><a href="#Subversion.svnListProps">svnListProps</a></td> |
|
121 <td>Public method used to list the properties of a file/directory.</td> |
|
122 </tr><tr> |
|
123 <td><a href="#Subversion.svnListTagBranch">svnListTagBranch</a></td> |
|
124 <td>Public method used to list the available tags or branches.</td> |
|
125 </tr><tr> |
|
126 <td><a href="#Subversion.svnLock">svnLock</a></td> |
|
127 <td>Public method used to lock a file in the Subversion repository.</td> |
|
128 </tr><tr> |
|
129 <td><a href="#Subversion.svnNormalizeURL">svnNormalizeURL</a></td> |
|
130 <td>Public method to normalize a url for subversion.</td> |
|
131 </tr><tr> |
|
132 <td><a href="#Subversion.svnRelocate">svnRelocate</a></td> |
|
133 <td>Public method to relocate the working copy to a new repository URL.</td> |
|
134 </tr><tr> |
|
135 <td><a href="#Subversion.svnRemoveFromChangelist">svnRemoveFromChangelist</a></td> |
|
136 <td>Public method to remove a file or directory from its changelist.</td> |
|
137 </tr><tr> |
|
138 <td><a href="#Subversion.svnRepoBrowser">svnRepoBrowser</a></td> |
|
139 <td>Public method to open the repository browser.</td> |
|
140 </tr><tr> |
|
141 <td><a href="#Subversion.svnResolve">svnResolve</a></td> |
|
142 <td>Public method used to resolve conflicts of a file/directory.</td> |
|
143 </tr><tr> |
|
144 <td><a href="#Subversion.svnSbsDiff">svnSbsDiff</a></td> |
|
145 <td>Public method used to view the difference of a file to the Mercurial repository side-by-side.</td> |
|
146 </tr><tr> |
|
147 <td><a href="#Subversion.svnSetProp">svnSetProp</a></td> |
|
148 <td>Public method used to add a property to a file/directory.</td> |
|
149 </tr><tr> |
|
150 <td><a href="#Subversion.svnShowChangelists">svnShowChangelists</a></td> |
|
151 <td>Public method used to inspect the change lists defined for the project.</td> |
|
152 </tr><tr> |
|
153 <td><a href="#Subversion.svnUnlock">svnUnlock</a></td> |
|
154 <td>Public method used to unlock a file in the Subversion repository.</td> |
|
155 </tr><tr> |
|
156 <td><a href="#Subversion.svnUpgrade">svnUpgrade</a></td> |
|
157 <td>Public method to upgrade the working copy format.</td> |
|
158 </tr><tr> |
|
159 <td><a href="#Subversion.svnUrlDiff">svnUrlDiff</a></td> |
|
160 <td>Public method used to view the difference of a file/directory of two repository URLs.</td> |
|
161 </tr><tr> |
|
162 <td><a href="#Subversion.vcsAdd">vcsAdd</a></td> |
|
163 <td>Public method used to add a file/directory to the Subversion repository.</td> |
|
164 </tr><tr> |
|
165 <td><a href="#Subversion.vcsAddBinary">vcsAddBinary</a></td> |
|
166 <td>Public method used to add a file/directory in binary mode to the Subversion repository.</td> |
|
167 </tr><tr> |
|
168 <td><a href="#Subversion.vcsAddTree">vcsAddTree</a></td> |
|
169 <td>Public method to add a directory tree rooted at path to the Subversion repository.</td> |
|
170 </tr><tr> |
|
171 <td><a href="#Subversion.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td> |
|
172 <td>Public method used to get the registered states of a number of files in the VCS.</td> |
|
173 </tr><tr> |
|
174 <td><a href="#Subversion.vcsCheckout">vcsCheckout</a></td> |
|
175 <td>Public method used to check the project out of the Subversion repository.</td> |
|
176 </tr><tr> |
|
177 <td><a href="#Subversion.vcsCleanup">vcsCleanup</a></td> |
|
178 <td>Public method used to cleanup the working copy.</td> |
|
179 </tr><tr> |
|
180 <td><a href="#Subversion.vcsCommandLine">vcsCommandLine</a></td> |
|
181 <td>Public method used to execute arbitrary subversion commands.</td> |
|
182 </tr><tr> |
|
183 <td><a href="#Subversion.vcsCommit">vcsCommit</a></td> |
|
184 <td>Public method used to make the change of a file/directory permanent in the Subversion repository.</td> |
|
185 </tr><tr> |
|
186 <td><a href="#Subversion.vcsConvertProject">vcsConvertProject</a></td> |
|
187 <td>Public method to convert an uncontrolled project to a version controlled project.</td> |
|
188 </tr><tr> |
|
189 <td><a href="#Subversion.vcsDiff">vcsDiff</a></td> |
|
190 <td>Public method used to view the difference of a file/directory to the Subversion repository.</td> |
|
191 </tr><tr> |
|
192 <td><a href="#Subversion.vcsExists">vcsExists</a></td> |
|
193 <td>Public method used to test for the presence of the svn executable.</td> |
|
194 </tr><tr> |
|
195 <td><a href="#Subversion.vcsExport">vcsExport</a></td> |
|
196 <td>Public method used to export a directory from the Subversion repository.</td> |
|
197 </tr><tr> |
|
198 <td><a href="#Subversion.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td> |
|
199 <td>Public method to instanciate a helper object for the different project browsers.</td> |
|
200 </tr><tr> |
|
201 <td><a href="#Subversion.vcsGetProjectHelper">vcsGetProjectHelper</a></td> |
|
202 <td>Public method to instanciate a helper object for the project.</td> |
|
203 </tr><tr> |
|
204 <td><a href="#Subversion.vcsImport">vcsImport</a></td> |
|
205 <td>Public method used to import the project into the Subversion repository.</td> |
|
206 </tr><tr> |
|
207 <td><a href="#Subversion.vcsInit">vcsInit</a></td> |
|
208 <td>Public method used to initialize the subversion repository.</td> |
|
209 </tr><tr> |
|
210 <td><a href="#Subversion.vcsInitConfig">vcsInitConfig</a></td> |
|
211 <td>Public method to initialize the VCS configuration.</td> |
|
212 </tr><tr> |
|
213 <td><a href="#Subversion.vcsLog">vcsLog</a></td> |
|
214 <td>Public method used to view the log of a file/directory from the Subversion repository.</td> |
|
215 </tr><tr> |
|
216 <td><a href="#Subversion.vcsLogBrowser">vcsLogBrowser</a></td> |
|
217 <td>Public method used to browse the log of a file/directory from the Subversion repository.</td> |
|
218 </tr><tr> |
|
219 <td><a href="#Subversion.vcsMerge">vcsMerge</a></td> |
|
220 <td>Public method used to merge a URL/revision into the local project.</td> |
|
221 </tr><tr> |
|
222 <td><a href="#Subversion.vcsMove">vcsMove</a></td> |
|
223 <td>Public method used to move a file/directory.</td> |
|
224 </tr><tr> |
|
225 <td><a href="#Subversion.vcsName">vcsName</a></td> |
|
226 <td>Public method returning the name of the vcs.</td> |
|
227 </tr><tr> |
|
228 <td><a href="#Subversion.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td> |
|
229 <td>Public method to get a dialog to enter repository info for getting a new project.</td> |
|
230 </tr><tr> |
|
231 <td><a href="#Subversion.vcsOptionsDialog">vcsOptionsDialog</a></td> |
|
232 <td>Public method to get a dialog to enter repository info.</td> |
|
233 </tr><tr> |
|
234 <td><a href="#Subversion.vcsRegisteredState">vcsRegisteredState</a></td> |
|
235 <td>Public method used to get the registered state of a file in the vcs.</td> |
|
236 </tr><tr> |
|
237 <td><a href="#Subversion.vcsRemove">vcsRemove</a></td> |
|
238 <td>Public method used to remove a file/directory from the Subversion repository.</td> |
|
239 </tr><tr> |
|
240 <td><a href="#Subversion.vcsRepositoryInfos">vcsRepositoryInfos</a></td> |
|
241 <td>Public method to retrieve information about the repository.</td> |
|
242 </tr><tr> |
|
243 <td><a href="#Subversion.vcsRevert">vcsRevert</a></td> |
|
244 <td>Public method used to revert changes made to a file/directory.</td> |
|
245 </tr><tr> |
|
246 <td><a href="#Subversion.vcsShutdown">vcsShutdown</a></td> |
|
247 <td>Public method used to shutdown the Subversion interface.</td> |
|
248 </tr><tr> |
|
249 <td><a href="#Subversion.vcsStatus">vcsStatus</a></td> |
|
250 <td>Public method used to view the status of files/directories in the Subversion repository.</td> |
|
251 </tr><tr> |
|
252 <td><a href="#Subversion.vcsSwitch">vcsSwitch</a></td> |
|
253 <td>Public method used to switch a directory to a different tag/branch.</td> |
|
254 </tr><tr> |
|
255 <td><a href="#Subversion.vcsTag">vcsTag</a></td> |
|
256 <td>Public method used to set the tag of a file/directory in the Subversion repository.</td> |
|
257 </tr><tr> |
|
258 <td><a href="#Subversion.vcsUpdate">vcsUpdate</a></td> |
|
259 <td>Public method used to update a file/directory with the Subversion repository.</td> |
|
260 </tr> |
|
261 </table> |
|
262 <h3>Static Methods</h3> |
|
263 <table> |
|
264 <tr><td>None</td></tr> |
|
265 </table> |
|
266 <a NAME="Subversion.__init__" ID="Subversion.__init__"></a> |
|
267 <h4>Subversion (Constructor)</h4> |
|
268 <b>Subversion</b>(<i>plugin, parent=None, name=None</i>) |
|
269 <p> |
|
270 Constructor |
|
271 </p><dl> |
|
272 <dt><i>plugin</i></dt> |
|
273 <dd> |
|
274 reference to the plugin object |
|
275 </dd><dt><i>parent</i></dt> |
|
276 <dd> |
|
277 parent widget (QWidget) |
|
278 </dd><dt><i>name</i></dt> |
|
279 <dd> |
|
280 name of this object (string) |
|
281 </dd> |
|
282 </dl><a NAME="Subversion.__svnGetFileForRevision" ID="Subversion.__svnGetFileForRevision"></a> |
|
283 <h4>Subversion.__svnGetFileForRevision</h4> |
|
284 <b>__svnGetFileForRevision</b>(<i>name, rev=""</i>) |
|
285 <p> |
|
286 Private method to get a file for a specific revision from the |
|
287 repository. |
|
288 </p><dl> |
|
289 <dt><i>name</i></dt> |
|
290 <dd> |
|
291 file name to get from the repository (string) |
|
292 </dd><dt><i>rev=</i></dt> |
|
293 <dd> |
|
294 revision to retrieve (integer or string) |
|
295 </dd> |
|
296 </dl><dl> |
|
297 <dt>Returns:</dt> |
|
298 <dd> |
|
299 contents of the file (string) and an error message (string) |
|
300 </dd> |
|
301 </dl><a NAME="Subversion.__svnURL" ID="Subversion.__svnURL"></a> |
|
302 <h4>Subversion.__svnURL</h4> |
|
303 <b>__svnURL</b>(<i>url</i>) |
|
304 <p> |
|
305 Private method to format a url for subversion. |
|
306 </p><dl> |
|
307 <dt><i>url</i></dt> |
|
308 <dd> |
|
309 unformatted url string (string) |
|
310 </dd> |
|
311 </dl><dl> |
|
312 <dt>Returns:</dt> |
|
313 <dd> |
|
314 properly formated url for subversion (string) |
|
315 </dd> |
|
316 </dl><a NAME="Subversion.__vcsAllRegisteredStates_wc" ID="Subversion.__vcsAllRegisteredStates_wc"></a> |
|
317 <h4>Subversion.__vcsAllRegisteredStates_wc</h4> |
|
318 <b>__vcsAllRegisteredStates_wc</b>(<i>names, dname, shortcut=True</i>) |
|
319 <p> |
|
320 Private method used to get the registered states of a number of files |
|
321 in the VCS. |
|
322 </p><p> |
|
323 This is the variant for subversion installations using the old working |
|
324 copy meta-data format. |
|
325 </p><p> |
|
326 <b>Note:</b> If a shortcut is to be taken, the code will only check, |
|
327 if the named directory has been scanned already. If so, it is assumed, |
|
328 that the states for all files has been populated by the previous run. |
|
329 </p><dl> |
|
330 <dt><i>names</i></dt> |
|
331 <dd> |
|
332 dictionary with all filenames to be checked as keys |
|
333 </dd><dt><i>dname</i></dt> |
|
334 <dd> |
|
335 directory to check in (string) |
|
336 </dd><dt><i>shortcut</i></dt> |
|
337 <dd> |
|
338 flag indicating a shortcut should be taken (boolean) |
|
339 </dd> |
|
340 </dl><dl> |
|
341 <dt>Returns:</dt> |
|
342 <dd> |
|
343 the received dictionary completed with a combination of |
|
344 canBeCommited and canBeAdded or None in order to signal an error |
|
345 </dd> |
|
346 </dl><a NAME="Subversion.__vcsAllRegisteredStates_wcng" ID="Subversion.__vcsAllRegisteredStates_wcng"></a> |
|
347 <h4>Subversion.__vcsAllRegisteredStates_wcng</h4> |
|
348 <b>__vcsAllRegisteredStates_wcng</b>(<i>names, dname, shortcut=True</i>) |
|
349 <p> |
|
350 Private method used to get the registered states of a number of files |
|
351 in the VCS. |
|
352 </p><p> |
|
353 This is the variant for subversion installations using the new working |
|
354 copy meta-data format. |
|
355 </p><p> |
|
356 <b>Note:</b> If a shortcut is to be taken, the code will only check, |
|
357 if the named directory has been scanned already. If so, it is assumed, |
|
358 that the states for all files has been populated by the previous run. |
|
359 </p><dl> |
|
360 <dt><i>names</i></dt> |
|
361 <dd> |
|
362 dictionary with all filenames to be checked as keys |
|
363 </dd><dt><i>dname</i></dt> |
|
364 <dd> |
|
365 directory to check in (string) |
|
366 </dd><dt><i>shortcut</i></dt> |
|
367 <dd> |
|
368 flag indicating a shortcut should be taken (boolean) |
|
369 </dd> |
|
370 </dl><dl> |
|
371 <dt>Returns:</dt> |
|
372 <dd> |
|
373 the received dictionary completed with a combination of |
|
374 canBeCommited and canBeAdded or None in order to signal an error |
|
375 </dd> |
|
376 </dl><a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a> |
|
377 <h4>Subversion.__vcsCommit_Step2</h4> |
|
378 <b>__vcsCommit_Step2</b>(<i></i>) |
|
379 <p> |
|
380 Private slot performing the second step of the commit action. |
|
381 </p><a NAME="Subversion.__vcsRegisteredState_wc" ID="Subversion.__vcsRegisteredState_wc"></a> |
|
382 <h4>Subversion.__vcsRegisteredState_wc</h4> |
|
383 <b>__vcsRegisteredState_wc</b>(<i>name</i>) |
|
384 <p> |
|
385 Private method used to get the registered state of a file in the VCS. |
|
386 </p><p> |
|
387 This is the variant for subversion installations using the old working |
|
388 copy meta-data format. |
|
389 </p><dl> |
|
390 <dt><i>name</i></dt> |
|
391 <dd> |
|
392 filename to check (string) |
|
393 </dd> |
|
394 </dl><dl> |
|
395 <dt>Returns:</dt> |
|
396 <dd> |
|
397 a combination of canBeCommited and canBeAdded |
|
398 </dd> |
|
399 </dl><a NAME="Subversion.__vcsRegisteredState_wcng" ID="Subversion.__vcsRegisteredState_wcng"></a> |
|
400 <h4>Subversion.__vcsRegisteredState_wcng</h4> |
|
401 <b>__vcsRegisteredState_wcng</b>(<i>name</i>) |
|
402 <p> |
|
403 Private method used to get the registered state of a file in the vcs. |
|
404 </p><p> |
|
405 This is the variant for subversion installations using the new |
|
406 working copy meta-data format. |
|
407 </p><dl> |
|
408 <dt><i>name</i></dt> |
|
409 <dd> |
|
410 filename to check (string) |
|
411 </dd> |
|
412 </dl><dl> |
|
413 <dt>Returns:</dt> |
|
414 <dd> |
|
415 a combination of canBeCommited and canBeAdded |
|
416 </dd> |
|
417 </dl><a NAME="Subversion._createStatusMonitorThread" ID="Subversion._createStatusMonitorThread"></a> |
|
418 <h4>Subversion._createStatusMonitorThread</h4> |
|
419 <b>_createStatusMonitorThread</b>(<i>interval, project</i>) |
|
420 <p> |
|
421 Protected method to create an instance of the VCS status monitor |
|
422 thread. |
|
423 </p><dl> |
|
424 <dt><i>interval</i></dt> |
|
425 <dd> |
|
426 check interval for the monitor thread in seconds |
|
427 (integer) |
|
428 </dd><dt><i>project</i></dt> |
|
429 <dd> |
|
430 reference to the project object |
|
431 </dd> |
|
432 </dl><dl> |
|
433 <dt>Returns:</dt> |
|
434 <dd> |
|
435 reference to the monitor thread (QThread) |
|
436 </dd> |
|
437 </dl><a NAME="Subversion.clearStatusCache" ID="Subversion.clearStatusCache"></a> |
|
438 <h4>Subversion.clearStatusCache</h4> |
|
439 <b>clearStatusCache</b>(<i></i>) |
|
440 <p> |
|
441 Public method to clear the status cache. |
|
442 </p><a NAME="Subversion.getPlugin" ID="Subversion.getPlugin"></a> |
|
443 <h4>Subversion.getPlugin</h4> |
|
444 <b>getPlugin</b>(<i></i>) |
|
445 <p> |
|
446 Public method to get a reference to the plugin object. |
|
447 </p><dl> |
|
448 <dt>Returns:</dt> |
|
449 <dd> |
|
450 reference to the plugin object (VcsSubversionPlugin) |
|
451 </dd> |
|
452 </dl><a NAME="Subversion.svnAddToChangelist" ID="Subversion.svnAddToChangelist"></a> |
|
453 <h4>Subversion.svnAddToChangelist</h4> |
|
454 <b>svnAddToChangelist</b>(<i>names</i>) |
|
455 <p> |
|
456 Public method to add a file or directory to a changelist. |
|
457 </p><p> |
|
458 Note: Directories will be added recursively. |
|
459 </p><dl> |
|
460 <dt><i>names</i></dt> |
|
461 <dd> |
|
462 name or list of names of file or directory to add |
|
463 (string) |
|
464 </dd> |
|
465 </dl><a NAME="Subversion.svnBlame" ID="Subversion.svnBlame"></a> |
|
466 <h4>Subversion.svnBlame</h4> |
|
467 <b>svnBlame</b>(<i>name</i>) |
|
468 <p> |
|
469 Public method to show the output of the svn blame command. |
|
470 </p><dl> |
|
471 <dt><i>name</i></dt> |
|
472 <dd> |
|
473 file name to show the blame for (string) |
|
474 </dd> |
|
475 </dl><a NAME="Subversion.svnCopy" ID="Subversion.svnCopy"></a> |
|
476 <h4>Subversion.svnCopy</h4> |
|
477 <b>svnCopy</b>(<i>name, project</i>) |
|
478 <p> |
|
479 Public method used to copy a file/directory. |
|
480 </p><dl> |
|
481 <dt><i>name</i></dt> |
|
482 <dd> |
|
483 file/directory name to be copied (string) |
|
484 </dd><dt><i>project</i></dt> |
|
485 <dd> |
|
486 reference to the project object |
|
487 </dd> |
|
488 </dl><dl> |
|
489 <dt>Returns:</dt> |
|
490 <dd> |
|
491 flag indicating successfull operation (boolean) |
|
492 </dd> |
|
493 </dl><a NAME="Subversion.svnDelProp" ID="Subversion.svnDelProp"></a> |
|
494 <h4>Subversion.svnDelProp</h4> |
|
495 <b>svnDelProp</b>(<i>name, recursive=False</i>) |
|
496 <p> |
|
497 Public method used to delete a property of a file/directory. |
|
498 </p><dl> |
|
499 <dt><i>name</i></dt> |
|
500 <dd> |
|
501 file/directory name (string or list of strings) |
|
502 </dd><dt><i>recursive</i></dt> |
|
503 <dd> |
|
504 flag indicating a recursive list is requested |
|
505 </dd> |
|
506 </dl><a NAME="Subversion.svnExtendedDiff" ID="Subversion.svnExtendedDiff"></a> |
|
507 <h4>Subversion.svnExtendedDiff</h4> |
|
508 <b>svnExtendedDiff</b>(<i>name</i>) |
|
509 <p> |
|
510 Public method used to view the difference of a file/directory to the |
|
511 Subversion repository. |
|
512 </p><p> |
|
513 If name is a directory and is the project directory, all project files |
|
514 are saved first. If name is a file (or list of files), which is/are |
|
515 being edited and has unsaved modification, they can be saved or the |
|
516 operation may be aborted. |
|
517 </p><p> |
|
518 This method gives the chance to enter the revisions to be compared. |
|
519 </p><dl> |
|
520 <dt><i>name</i></dt> |
|
521 <dd> |
|
522 file/directory name to be diffed (string) |
|
523 </dd> |
|
524 </dl><a NAME="Subversion.svnGetChangelists" ID="Subversion.svnGetChangelists"></a> |
|
525 <h4>Subversion.svnGetChangelists</h4> |
|
526 <b>svnGetChangelists</b>(<i></i>) |
|
527 <p> |
|
528 Public method to get a list of all defined change lists. |
|
529 </p><dl> |
|
530 <dt>Returns:</dt> |
|
531 <dd> |
|
532 list of defined change list names (list of strings) |
|
533 </dd> |
|
534 </dl><a NAME="Subversion.svnGetReposName" ID="Subversion.svnGetReposName"></a> |
|
535 <h4>Subversion.svnGetReposName</h4> |
|
536 <b>svnGetReposName</b>(<i>path</i>) |
|
537 <p> |
|
538 Public method used to retrieve the URL of the subversion repository |
|
539 path. |
|
540 </p><dl> |
|
541 <dt><i>path</i></dt> |
|
542 <dd> |
|
543 local path to get the svn repository path for (string) |
|
544 </dd> |
|
545 </dl><dl> |
|
546 <dt>Returns:</dt> |
|
547 <dd> |
|
548 string with the repository path URL |
|
549 </dd> |
|
550 </dl><a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a> |
|
551 <h4>Subversion.svnListProps</h4> |
|
552 <b>svnListProps</b>(<i>name, recursive=False</i>) |
|
553 <p> |
|
554 Public method used to list the properties of a file/directory. |
|
555 </p><dl> |
|
556 <dt><i>name</i></dt> |
|
557 <dd> |
|
558 file/directory name (string or list of strings) |
|
559 </dd><dt><i>recursive</i></dt> |
|
560 <dd> |
|
561 flag indicating a recursive list is requested |
|
562 </dd> |
|
563 </dl><a NAME="Subversion.svnListTagBranch" ID="Subversion.svnListTagBranch"></a> |
|
564 <h4>Subversion.svnListTagBranch</h4> |
|
565 <b>svnListTagBranch</b>(<i>path, tags=True</i>) |
|
566 <p> |
|
567 Public method used to list the available tags or branches. |
|
568 </p><dl> |
|
569 <dt><i>path</i></dt> |
|
570 <dd> |
|
571 directory name of the project (string) |
|
572 </dd><dt><i>tags</i></dt> |
|
573 <dd> |
|
574 flag indicating listing of branches or tags |
|
575 (False = branches, True = tags) |
|
576 </dd> |
|
577 </dl><a NAME="Subversion.svnLock" ID="Subversion.svnLock"></a> |
|
578 <h4>Subversion.svnLock</h4> |
|
579 <b>svnLock</b>(<i>name, stealIt=False, parent=None</i>) |
|
580 <p> |
|
581 Public method used to lock a file in the Subversion repository. |
|
582 </p><dl> |
|
583 <dt><i>name</i></dt> |
|
584 <dd> |
|
585 file/directory name to be locked (string or list of |
|
586 strings) |
|
587 </dd><dt><i>stealIt</i></dt> |
|
588 <dd> |
|
589 flag indicating a forced operation (boolean) |
|
590 </dd><dt><i>parent</i></dt> |
|
591 <dd> |
|
592 reference to the parent object of the subversion dialog |
|
593 (QWidget) |
|
594 </dd> |
|
595 </dl><a NAME="Subversion.svnNormalizeURL" ID="Subversion.svnNormalizeURL"></a> |
|
596 <h4>Subversion.svnNormalizeURL</h4> |
|
597 <b>svnNormalizeURL</b>(<i>url</i>) |
|
598 <p> |
|
599 Public method to normalize a url for subversion. |
|
600 </p><dl> |
|
601 <dt><i>url</i></dt> |
|
602 <dd> |
|
603 url string (string) |
|
604 </dd> |
|
605 </dl><dl> |
|
606 <dt>Returns:</dt> |
|
607 <dd> |
|
608 properly normalized url for subversion (string) |
|
609 </dd> |
|
610 </dl><a NAME="Subversion.svnRelocate" ID="Subversion.svnRelocate"></a> |
|
611 <h4>Subversion.svnRelocate</h4> |
|
612 <b>svnRelocate</b>(<i>projectPath</i>) |
|
613 <p> |
|
614 Public method to relocate the working copy to a new repository URL. |
|
615 </p><dl> |
|
616 <dt><i>projectPath</i></dt> |
|
617 <dd> |
|
618 path name of the project (string) |
|
619 </dd> |
|
620 </dl><a NAME="Subversion.svnRemoveFromChangelist" ID="Subversion.svnRemoveFromChangelist"></a> |
|
621 <h4>Subversion.svnRemoveFromChangelist</h4> |
|
622 <b>svnRemoveFromChangelist</b>(<i>names</i>) |
|
623 <p> |
|
624 Public method to remove a file or directory from its changelist. |
|
625 </p><p> |
|
626 Note: Directories will be removed recursively. |
|
627 </p><dl> |
|
628 <dt><i>names</i></dt> |
|
629 <dd> |
|
630 name or list of names of file or directory to remove |
|
631 (string) |
|
632 </dd> |
|
633 </dl><a NAME="Subversion.svnRepoBrowser" ID="Subversion.svnRepoBrowser"></a> |
|
634 <h4>Subversion.svnRepoBrowser</h4> |
|
635 <b>svnRepoBrowser</b>(<i>projectPath=None</i>) |
|
636 <p> |
|
637 Public method to open the repository browser. |
|
638 </p><dl> |
|
639 <dt><i>projectPath</i></dt> |
|
640 <dd> |
|
641 path name of the project (string) |
|
642 </dd> |
|
643 </dl><a NAME="Subversion.svnResolve" ID="Subversion.svnResolve"></a> |
|
644 <h4>Subversion.svnResolve</h4> |
|
645 <b>svnResolve</b>(<i>name</i>) |
|
646 <p> |
|
647 Public method used to resolve conflicts of a file/directory. |
|
648 </p><dl> |
|
649 <dt><i>name</i></dt> |
|
650 <dd> |
|
651 file/directory name to be resolved (string) |
|
652 </dd> |
|
653 </dl><a NAME="Subversion.svnSbsDiff" ID="Subversion.svnSbsDiff"></a> |
|
654 <h4>Subversion.svnSbsDiff</h4> |
|
655 <b>svnSbsDiff</b>(<i>name, extended=False, revisions=None</i>) |
|
656 <p> |
|
657 Public method used to view the difference of a file to the Mercurial |
|
658 repository side-by-side. |
|
659 </p><dl> |
|
660 <dt><i>name</i></dt> |
|
661 <dd> |
|
662 file name to be diffed (string) |
|
663 </dd><dt><i>extended=</i></dt> |
|
664 <dd> |
|
665 flag indicating the extended variant (boolean) |
|
666 </dd><dt><i>revisions=</i></dt> |
|
667 <dd> |
|
668 tuple of two revisions (tuple of strings) |
|
669 </dd> |
|
670 </dl><dl> |
|
671 <dt>Raises <b>ValueError</b>:</dt> |
|
672 <dd> |
|
673 raised to indicate an illegal name parameter type |
|
674 </dd> |
|
675 </dl><a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a> |
|
676 <h4>Subversion.svnSetProp</h4> |
|
677 <b>svnSetProp</b>(<i>name, recursive=False</i>) |
|
678 <p> |
|
679 Public method used to add a property to a file/directory. |
|
680 </p><dl> |
|
681 <dt><i>name</i></dt> |
|
682 <dd> |
|
683 file/directory name (string or list of strings) |
|
684 </dd><dt><i>recursive</i></dt> |
|
685 <dd> |
|
686 flag indicating a recursive list is requested |
|
687 </dd> |
|
688 </dl><a NAME="Subversion.svnShowChangelists" ID="Subversion.svnShowChangelists"></a> |
|
689 <h4>Subversion.svnShowChangelists</h4> |
|
690 <b>svnShowChangelists</b>(<i>path</i>) |
|
691 <p> |
|
692 Public method used to inspect the change lists defined for the project. |
|
693 </p><dl> |
|
694 <dt><i>path</i></dt> |
|
695 <dd> |
|
696 directory name to show change lists for (string) |
|
697 </dd> |
|
698 </dl><a NAME="Subversion.svnUnlock" ID="Subversion.svnUnlock"></a> |
|
699 <h4>Subversion.svnUnlock</h4> |
|
700 <b>svnUnlock</b>(<i>name, breakIt=False, parent=None</i>) |
|
701 <p> |
|
702 Public method used to unlock a file in the Subversion repository. |
|
703 </p><dl> |
|
704 <dt><i>name</i></dt> |
|
705 <dd> |
|
706 file/directory name to be unlocked (string or list of |
|
707 strings) |
|
708 </dd><dt><i>breakIt</i></dt> |
|
709 <dd> |
|
710 flag indicating a forced operation (boolean) |
|
711 </dd><dt><i>parent</i></dt> |
|
712 <dd> |
|
713 reference to the parent object of the subversion dialog |
|
714 (QWidget) |
|
715 </dd> |
|
716 </dl><a NAME="Subversion.svnUpgrade" ID="Subversion.svnUpgrade"></a> |
|
717 <h4>Subversion.svnUpgrade</h4> |
|
718 <b>svnUpgrade</b>(<i>path</i>) |
|
719 <p> |
|
720 Public method to upgrade the working copy format. |
|
721 </p><dl> |
|
722 <dt><i>path</i></dt> |
|
723 <dd> |
|
724 directory name to show change lists for (string) |
|
725 </dd> |
|
726 </dl><a NAME="Subversion.svnUrlDiff" ID="Subversion.svnUrlDiff"></a> |
|
727 <h4>Subversion.svnUrlDiff</h4> |
|
728 <b>svnUrlDiff</b>(<i>name</i>) |
|
729 <p> |
|
730 Public method used to view the difference of a file/directory of two |
|
731 repository URLs. |
|
732 </p><p> |
|
733 If name is a directory and is the project directory, all project files |
|
734 are saved first. If name is a file (or list of files), which is/are |
|
735 being edited and has unsaved modification, they can be saved or the |
|
736 operation may be aborted. |
|
737 </p><p> |
|
738 This method gives the chance to enter the revisions to be compared. |
|
739 </p><dl> |
|
740 <dt><i>name</i></dt> |
|
741 <dd> |
|
742 file/directory name to be diffed (string) |
|
743 </dd> |
|
744 </dl><a NAME="Subversion.vcsAdd" ID="Subversion.vcsAdd"></a> |
|
745 <h4>Subversion.vcsAdd</h4> |
|
746 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) |
|
747 <p> |
|
748 Public method used to add a file/directory to the Subversion |
|
749 repository. |
|
750 </p><dl> |
|
751 <dt><i>name</i></dt> |
|
752 <dd> |
|
753 file/directory name to be added (string) |
|
754 </dd><dt><i>isDir</i></dt> |
|
755 <dd> |
|
756 flag indicating name is a directory (boolean) |
|
757 </dd><dt><i>noDialog</i></dt> |
|
758 <dd> |
|
759 flag indicating quiet operations |
|
760 </dd> |
|
761 </dl><a NAME="Subversion.vcsAddBinary" ID="Subversion.vcsAddBinary"></a> |
|
762 <h4>Subversion.vcsAddBinary</h4> |
|
763 <b>vcsAddBinary</b>(<i>name, isDir=False</i>) |
|
764 <p> |
|
765 Public method used to add a file/directory in binary mode to the |
|
766 Subversion repository. |
|
767 </p><dl> |
|
768 <dt><i>name</i></dt> |
|
769 <dd> |
|
770 file/directory name to be added (string) |
|
771 </dd><dt><i>isDir</i></dt> |
|
772 <dd> |
|
773 flag indicating name is a directory (boolean) |
|
774 </dd> |
|
775 </dl><a NAME="Subversion.vcsAddTree" ID="Subversion.vcsAddTree"></a> |
|
776 <h4>Subversion.vcsAddTree</h4> |
|
777 <b>vcsAddTree</b>(<i>path</i>) |
|
778 <p> |
|
779 Public method to add a directory tree rooted at path to the Subversion |
|
780 repository. |
|
781 </p><dl> |
|
782 <dt><i>path</i></dt> |
|
783 <dd> |
|
784 root directory of the tree to be added (string or list of |
|
785 strings)) |
|
786 </dd> |
|
787 </dl><a NAME="Subversion.vcsAllRegisteredStates" ID="Subversion.vcsAllRegisteredStates"></a> |
|
788 <h4>Subversion.vcsAllRegisteredStates</h4> |
|
789 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) |
|
790 <p> |
|
791 Public method used to get the registered states of a number of files |
|
792 in the VCS. |
|
793 </p><p> |
|
794 <b>Note:</b> If a shortcut is to be taken, the code will only check, |
|
795 if the named directory has been scanned already. If so, it is assumed, |
|
796 that the states for all files have been populated by the previous run. |
|
797 </p><dl> |
|
798 <dt><i>names</i></dt> |
|
799 <dd> |
|
800 dictionary with all filenames to be checked as keys |
|
801 </dd><dt><i>dname</i></dt> |
|
802 <dd> |
|
803 directory to check in (string) |
|
804 </dd><dt><i>shortcut</i></dt> |
|
805 <dd> |
|
806 flag indicating a shortcut should be taken (boolean) |
|
807 </dd> |
|
808 </dl><dl> |
|
809 <dt>Returns:</dt> |
|
810 <dd> |
|
811 the received dictionary completed with a combination of |
|
812 canBeCommited and canBeAdded or None in order to signal an error |
|
813 </dd> |
|
814 </dl><a NAME="Subversion.vcsCheckout" ID="Subversion.vcsCheckout"></a> |
|
815 <h4>Subversion.vcsCheckout</h4> |
|
816 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) |
|
817 <p> |
|
818 Public method used to check the project out of the Subversion |
|
819 repository. |
|
820 </p><dl> |
|
821 <dt><i>vcsDataDict</i></dt> |
|
822 <dd> |
|
823 dictionary of data required for the checkout |
|
824 </dd><dt><i>projectDir</i></dt> |
|
825 <dd> |
|
826 project directory to create (string) |
|
827 </dd><dt><i>noDialog</i></dt> |
|
828 <dd> |
|
829 flag indicating quiet operations |
|
830 </dd> |
|
831 </dl><dl> |
|
832 <dt>Returns:</dt> |
|
833 <dd> |
|
834 flag indicating an execution without errors (boolean) |
|
835 </dd> |
|
836 </dl><a NAME="Subversion.vcsCleanup" ID="Subversion.vcsCleanup"></a> |
|
837 <h4>Subversion.vcsCleanup</h4> |
|
838 <b>vcsCleanup</b>(<i>name</i>) |
|
839 <p> |
|
840 Public method used to cleanup the working copy. |
|
841 </p><dl> |
|
842 <dt><i>name</i></dt> |
|
843 <dd> |
|
844 directory name to be cleaned up (string) |
|
845 </dd> |
|
846 </dl><a NAME="Subversion.vcsCommandLine" ID="Subversion.vcsCommandLine"></a> |
|
847 <h4>Subversion.vcsCommandLine</h4> |
|
848 <b>vcsCommandLine</b>(<i>name</i>) |
|
849 <p> |
|
850 Public method used to execute arbitrary subversion commands. |
|
851 </p><dl> |
|
852 <dt><i>name</i></dt> |
|
853 <dd> |
|
854 directory name of the working directory (string) |
|
855 </dd> |
|
856 </dl><a NAME="Subversion.vcsCommit" ID="Subversion.vcsCommit"></a> |
|
857 <h4>Subversion.vcsCommit</h4> |
|
858 <b>vcsCommit</b>(<i>name, message, noDialog=False</i>) |
|
859 <p> |
|
860 Public method used to make the change of a file/directory permanent |
|
861 in the Subversion repository. |
|
862 </p><dl> |
|
863 <dt><i>name</i></dt> |
|
864 <dd> |
|
865 file/directory name to be committed (string or list of |
|
866 strings) |
|
867 </dd><dt><i>message</i></dt> |
|
868 <dd> |
|
869 message for this operation (string) |
|
870 </dd><dt><i>noDialog</i></dt> |
|
871 <dd> |
|
872 flag indicating quiet operations |
|
873 </dd> |
|
874 </dl><a NAME="Subversion.vcsConvertProject" ID="Subversion.vcsConvertProject"></a> |
|
875 <h4>Subversion.vcsConvertProject</h4> |
|
876 <b>vcsConvertProject</b>(<i>vcsDataDict, project</i>) |
|
877 <p> |
|
878 Public method to convert an uncontrolled project to a version |
|
879 controlled project. |
|
880 </p><dl> |
|
881 <dt><i>vcsDataDict</i></dt> |
|
882 <dd> |
|
883 dictionary of data required for the conversion |
|
884 </dd><dt><i>project</i></dt> |
|
885 <dd> |
|
886 reference to the project object |
|
887 </dd> |
|
888 </dl><a NAME="Subversion.vcsDiff" ID="Subversion.vcsDiff"></a> |
|
889 <h4>Subversion.vcsDiff</h4> |
|
890 <b>vcsDiff</b>(<i>name</i>) |
|
891 <p> |
|
892 Public method used to view the difference of a file/directory to the |
|
893 Subversion repository. |
|
894 </p><p> |
|
895 If name is a directory and is the project directory, all project files |
|
896 are saved first. If name is a file (or list of files), which is/are |
|
897 being edited and has unsaved modification, they can be saved or the |
|
898 operation may be aborted. |
|
899 </p><dl> |
|
900 <dt><i>name</i></dt> |
|
901 <dd> |
|
902 file/directory name to be diffed (string) |
|
903 </dd> |
|
904 </dl><a NAME="Subversion.vcsExists" ID="Subversion.vcsExists"></a> |
|
905 <h4>Subversion.vcsExists</h4> |
|
906 <b>vcsExists</b>(<i></i>) |
|
907 <p> |
|
908 Public method used to test for the presence of the svn executable. |
|
909 </p><dl> |
|
910 <dt>Returns:</dt> |
|
911 <dd> |
|
912 flag indicating the existance (boolean) and an error message |
|
913 (string) |
|
914 </dd> |
|
915 </dl><a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a> |
|
916 <h4>Subversion.vcsExport</h4> |
|
917 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>) |
|
918 <p> |
|
919 Public method used to export a directory from the Subversion |
|
920 repository. |
|
921 </p><dl> |
|
922 <dt><i>vcsDataDict</i></dt> |
|
923 <dd> |
|
924 dictionary of data required for the checkout |
|
925 </dd><dt><i>projectDir</i></dt> |
|
926 <dd> |
|
927 project directory to create (string) |
|
928 </dd> |
|
929 </dl><dl> |
|
930 <dt>Returns:</dt> |
|
931 <dd> |
|
932 flag indicating an execution without errors (boolean) |
|
933 </dd> |
|
934 </dl><a NAME="Subversion.vcsGetProjectBrowserHelper" ID="Subversion.vcsGetProjectBrowserHelper"></a> |
|
935 <h4>Subversion.vcsGetProjectBrowserHelper</h4> |
|
936 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) |
|
937 <p> |
|
938 Public method to instanciate a helper object for the different |
|
939 project browsers. |
|
940 </p><dl> |
|
941 <dt><i>browser</i></dt> |
|
942 <dd> |
|
943 reference to the project browser object |
|
944 </dd><dt><i>project</i></dt> |
|
945 <dd> |
|
946 reference to the project object |
|
947 </dd><dt><i>isTranslationsBrowser</i></dt> |
|
948 <dd> |
|
949 flag indicating, the helper is requested |
|
950 for the translations browser (this needs some special treatment) |
|
951 </dd> |
|
952 </dl><dl> |
|
953 <dt>Returns:</dt> |
|
954 <dd> |
|
955 the project browser helper object |
|
956 </dd> |
|
957 </dl><a NAME="Subversion.vcsGetProjectHelper" ID="Subversion.vcsGetProjectHelper"></a> |
|
958 <h4>Subversion.vcsGetProjectHelper</h4> |
|
959 <b>vcsGetProjectHelper</b>(<i>project</i>) |
|
960 <p> |
|
961 Public method to instanciate a helper object for the project. |
|
962 </p><dl> |
|
963 <dt><i>project</i></dt> |
|
964 <dd> |
|
965 reference to the project object |
|
966 </dd> |
|
967 </dl><dl> |
|
968 <dt>Returns:</dt> |
|
969 <dd> |
|
970 the project helper object |
|
971 </dd> |
|
972 </dl><a NAME="Subversion.vcsImport" ID="Subversion.vcsImport"></a> |
|
973 <h4>Subversion.vcsImport</h4> |
|
974 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) |
|
975 <p> |
|
976 Public method used to import the project into the Subversion |
|
977 repository. |
|
978 </p><dl> |
|
979 <dt><i>vcsDataDict</i></dt> |
|
980 <dd> |
|
981 dictionary of data required for the import |
|
982 </dd><dt><i>projectDir</i></dt> |
|
983 <dd> |
|
984 project directory (string) |
|
985 </dd><dt><i>noDialog</i></dt> |
|
986 <dd> |
|
987 flag indicating quiet operations |
|
988 </dd> |
|
989 </dl><dl> |
|
990 <dt>Returns:</dt> |
|
991 <dd> |
|
992 flag indicating an execution without errors (boolean) |
|
993 and a flag indicating the version control status (boolean) |
|
994 </dd> |
|
995 </dl><a NAME="Subversion.vcsInit" ID="Subversion.vcsInit"></a> |
|
996 <h4>Subversion.vcsInit</h4> |
|
997 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) |
|
998 <p> |
|
999 Public method used to initialize the subversion repository. |
|
1000 </p><p> |
|
1001 The subversion repository has to be initialized from outside eric6 |
|
1002 because the respective command always works locally. Therefore we |
|
1003 always return TRUE without doing anything. |
|
1004 </p><dl> |
|
1005 <dt><i>vcsDir</i></dt> |
|
1006 <dd> |
|
1007 name of the VCS directory (string) |
|
1008 </dd><dt><i>noDialog</i></dt> |
|
1009 <dd> |
|
1010 flag indicating quiet operations (boolean) |
|
1011 </dd> |
|
1012 </dl><dl> |
|
1013 <dt>Returns:</dt> |
|
1014 <dd> |
|
1015 always TRUE |
|
1016 </dd> |
|
1017 </dl><a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a> |
|
1018 <h4>Subversion.vcsInitConfig</h4> |
|
1019 <b>vcsInitConfig</b>(<i>project</i>) |
|
1020 <p> |
|
1021 Public method to initialize the VCS configuration. |
|
1022 </p><p> |
|
1023 This method ensures, that an ignore file exists. |
|
1024 </p><dl> |
|
1025 <dt><i>project</i></dt> |
|
1026 <dd> |
|
1027 reference to the project (Project) |
|
1028 </dd> |
|
1029 </dl><a NAME="Subversion.vcsLog" ID="Subversion.vcsLog"></a> |
|
1030 <h4>Subversion.vcsLog</h4> |
|
1031 <b>vcsLog</b>(<i>name</i>) |
|
1032 <p> |
|
1033 Public method used to view the log of a file/directory from the |
|
1034 Subversion repository. |
|
1035 </p><dl> |
|
1036 <dt><i>name</i></dt> |
|
1037 <dd> |
|
1038 file/directory name to show the log of (string) |
|
1039 </dd> |
|
1040 </dl><a NAME="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a> |
|
1041 <h4>Subversion.vcsLogBrowser</h4> |
|
1042 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) |
|
1043 <p> |
|
1044 Public method used to browse the log of a file/directory from the |
|
1045 Subversion repository. |
|
1046 </p><dl> |
|
1047 <dt><i>name</i></dt> |
|
1048 <dd> |
|
1049 file/directory name to show the log of (string) |
|
1050 </dd><dt><i>isFile</i></dt> |
|
1051 <dd> |
|
1052 flag indicating log for a file is to be shown (boolean) |
|
1053 </dd> |
|
1054 </dl><a NAME="Subversion.vcsMerge" ID="Subversion.vcsMerge"></a> |
|
1055 <h4>Subversion.vcsMerge</h4> |
|
1056 <b>vcsMerge</b>(<i>name</i>) |
|
1057 <p> |
|
1058 Public method used to merge a URL/revision into the local project. |
|
1059 </p><dl> |
|
1060 <dt><i>name</i></dt> |
|
1061 <dd> |
|
1062 file/directory name to be merged (string) |
|
1063 </dd> |
|
1064 </dl><a NAME="Subversion.vcsMove" ID="Subversion.vcsMove"></a> |
|
1065 <h4>Subversion.vcsMove</h4> |
|
1066 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) |
|
1067 <p> |
|
1068 Public method used to move a file/directory. |
|
1069 </p><dl> |
|
1070 <dt><i>name</i></dt> |
|
1071 <dd> |
|
1072 file/directory name to be moved (string) |
|
1073 </dd><dt><i>project</i></dt> |
|
1074 <dd> |
|
1075 reference to the project object |
|
1076 </dd><dt><i>target</i></dt> |
|
1077 <dd> |
|
1078 new name of the file/directory (string) |
|
1079 </dd><dt><i>noDialog</i></dt> |
|
1080 <dd> |
|
1081 flag indicating quiet operations |
|
1082 </dd> |
|
1083 </dl><dl> |
|
1084 <dt>Returns:</dt> |
|
1085 <dd> |
|
1086 flag indicating successfull operation (boolean) |
|
1087 </dd> |
|
1088 </dl><a NAME="Subversion.vcsName" ID="Subversion.vcsName"></a> |
|
1089 <h4>Subversion.vcsName</h4> |
|
1090 <b>vcsName</b>(<i></i>) |
|
1091 <p> |
|
1092 Public method returning the name of the vcs. |
|
1093 </p><dl> |
|
1094 <dt>Returns:</dt> |
|
1095 <dd> |
|
1096 always 'Subversion' (string) |
|
1097 </dd> |
|
1098 </dl><a NAME="Subversion.vcsNewProjectOptionsDialog" ID="Subversion.vcsNewProjectOptionsDialog"></a> |
|
1099 <h4>Subversion.vcsNewProjectOptionsDialog</h4> |
|
1100 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) |
|
1101 <p> |
|
1102 Public method to get a dialog to enter repository info for getting |
|
1103 a new project. |
|
1104 </p><dl> |
|
1105 <dt><i>parent</i></dt> |
|
1106 <dd> |
|
1107 parent widget (QWidget) |
|
1108 </dd> |
|
1109 </dl><dl> |
|
1110 <dt>Returns:</dt> |
|
1111 <dd> |
|
1112 reference to the instantiated options dialog |
|
1113 (SvnNewProjectOptionsDialog) |
|
1114 </dd> |
|
1115 </dl><a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a> |
|
1116 <h4>Subversion.vcsOptionsDialog</h4> |
|
1117 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) |
|
1118 <p> |
|
1119 Public method to get a dialog to enter repository info. |
|
1120 </p><dl> |
|
1121 <dt><i>project</i></dt> |
|
1122 <dd> |
|
1123 reference to the project object |
|
1124 </dd><dt><i>archive</i></dt> |
|
1125 <dd> |
|
1126 name of the project in the repository (string) |
|
1127 </dd><dt><i>editable</i></dt> |
|
1128 <dd> |
|
1129 flag indicating that the project name is editable |
|
1130 (boolean) |
|
1131 </dd><dt><i>parent</i></dt> |
|
1132 <dd> |
|
1133 parent widget (QWidget) |
|
1134 </dd> |
|
1135 </dl><dl> |
|
1136 <dt>Returns:</dt> |
|
1137 <dd> |
|
1138 reference to the instantiated options dialog (SvnOptionsDialog) |
|
1139 </dd> |
|
1140 </dl><a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a> |
|
1141 <h4>Subversion.vcsRegisteredState</h4> |
|
1142 <b>vcsRegisteredState</b>(<i>name</i>) |
|
1143 <p> |
|
1144 Public method used to get the registered state of a file in the vcs. |
|
1145 </p><dl> |
|
1146 <dt><i>name</i></dt> |
|
1147 <dd> |
|
1148 filename to check (string) |
|
1149 </dd> |
|
1150 </dl><dl> |
|
1151 <dt>Returns:</dt> |
|
1152 <dd> |
|
1153 a combination of canBeCommited and canBeAdded |
|
1154 </dd> |
|
1155 </dl><a NAME="Subversion.vcsRemove" ID="Subversion.vcsRemove"></a> |
|
1156 <h4>Subversion.vcsRemove</h4> |
|
1157 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) |
|
1158 <p> |
|
1159 Public method used to remove a file/directory from the Subversion |
|
1160 repository. |
|
1161 </p><p> |
|
1162 The default operation is to remove the local copy as well. |
|
1163 </p><dl> |
|
1164 <dt><i>name</i></dt> |
|
1165 <dd> |
|
1166 file/directory name to be removed (string or list of |
|
1167 strings)) |
|
1168 </dd><dt><i>project</i></dt> |
|
1169 <dd> |
|
1170 flag indicating deletion of a project tree (boolean) |
|
1171 (not needed) |
|
1172 </dd><dt><i>noDialog</i></dt> |
|
1173 <dd> |
|
1174 flag indicating quiet operations |
|
1175 </dd> |
|
1176 </dl><dl> |
|
1177 <dt>Returns:</dt> |
|
1178 <dd> |
|
1179 flag indicating successfull operation (boolean) |
|
1180 </dd> |
|
1181 </dl><a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a> |
|
1182 <h4>Subversion.vcsRepositoryInfos</h4> |
|
1183 <b>vcsRepositoryInfos</b>(<i>ppath</i>) |
|
1184 <p> |
|
1185 Public method to retrieve information about the repository. |
|
1186 </p><dl> |
|
1187 <dt><i>ppath</i></dt> |
|
1188 <dd> |
|
1189 local path to get the repository infos (string) |
|
1190 </dd> |
|
1191 </dl><dl> |
|
1192 <dt>Returns:</dt> |
|
1193 <dd> |
|
1194 string with ready formated info for display (string) |
|
1195 </dd> |
|
1196 </dl><a NAME="Subversion.vcsRevert" ID="Subversion.vcsRevert"></a> |
|
1197 <h4>Subversion.vcsRevert</h4> |
|
1198 <b>vcsRevert</b>(<i>name</i>) |
|
1199 <p> |
|
1200 Public method used to revert changes made to a file/directory. |
|
1201 </p><dl> |
|
1202 <dt><i>name</i></dt> |
|
1203 <dd> |
|
1204 file/directory name to be reverted (string) |
|
1205 </dd> |
|
1206 </dl><a NAME="Subversion.vcsShutdown" ID="Subversion.vcsShutdown"></a> |
|
1207 <h4>Subversion.vcsShutdown</h4> |
|
1208 <b>vcsShutdown</b>(<i></i>) |
|
1209 <p> |
|
1210 Public method used to shutdown the Subversion interface. |
|
1211 </p><a NAME="Subversion.vcsStatus" ID="Subversion.vcsStatus"></a> |
|
1212 <h4>Subversion.vcsStatus</h4> |
|
1213 <b>vcsStatus</b>(<i>name</i>) |
|
1214 <p> |
|
1215 Public method used to view the status of files/directories in the |
|
1216 Subversion repository. |
|
1217 </p><dl> |
|
1218 <dt><i>name</i></dt> |
|
1219 <dd> |
|
1220 file/directory name(s) to show the status of |
|
1221 (string or list of strings) |
|
1222 </dd> |
|
1223 </dl><a NAME="Subversion.vcsSwitch" ID="Subversion.vcsSwitch"></a> |
|
1224 <h4>Subversion.vcsSwitch</h4> |
|
1225 <b>vcsSwitch</b>(<i>name</i>) |
|
1226 <p> |
|
1227 Public method used to switch a directory to a different tag/branch. |
|
1228 </p><dl> |
|
1229 <dt><i>name</i></dt> |
|
1230 <dd> |
|
1231 directory name to be switched (string) |
|
1232 </dd> |
|
1233 </dl><dl> |
|
1234 <dt>Returns:</dt> |
|
1235 <dd> |
|
1236 flag indicating added or changed files (boolean) |
|
1237 </dd> |
|
1238 </dl><a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a> |
|
1239 <h4>Subversion.vcsTag</h4> |
|
1240 <b>vcsTag</b>(<i>name</i>) |
|
1241 <p> |
|
1242 Public method used to set the tag of a file/directory in the |
|
1243 Subversion repository. |
|
1244 </p><dl> |
|
1245 <dt><i>name</i></dt> |
|
1246 <dd> |
|
1247 file/directory name to be tagged (string) |
|
1248 </dd> |
|
1249 </dl><a NAME="Subversion.vcsUpdate" ID="Subversion.vcsUpdate"></a> |
|
1250 <h4>Subversion.vcsUpdate</h4> |
|
1251 <b>vcsUpdate</b>(<i>name, noDialog=False</i>) |
|
1252 <p> |
|
1253 Public method used to update a file/directory with the Subversion |
|
1254 repository. |
|
1255 </p><dl> |
|
1256 <dt><i>name</i></dt> |
|
1257 <dd> |
|
1258 file/directory name to be updated (string or list of |
|
1259 strings) |
|
1260 </dd><dt><i>noDialog</i></dt> |
|
1261 <dd> |
|
1262 flag indicating quiet operations (boolean) |
|
1263 </dd> |
|
1264 </dl><dl> |
|
1265 <dt>Returns:</dt> |
|
1266 <dd> |
|
1267 flag indicating, that the update contained an add |
|
1268 or delete (boolean) |
|
1269 </dd> |
|
1270 </dl> |
|
1271 <div align="right"><a href="#top">Up</a></div> |
|
1272 <hr /> |
|
1273 </body></html> |