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