src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html

branch
eric7
changeset 10259
b51dfacef37f
parent 10070
9f5758c0fec1
child 10438
4cd7e5a8b3cf
diff -r e7764f992a01 -r b51dfacef37f src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html	Fri Oct 27 14:09:40 2023 +0200
@@ -84,7 +84,7 @@
 </tr>
 <tr>
 <td><a href="#Subversion.__vcsAllRegisteredStates_wcng">__vcsAllRegisteredStates_wcng</a></td>
-<td></td>
+<td>Private method used to get the registered states of a number of files in the vcs.</td>
 </tr>
 <tr>
 <td><a href="#Subversion.__vcsCommit_Step2">__vcsCommit_Step2</a></td>
@@ -272,11 +272,11 @@
 </tr>
 <tr>
 <td><a href="#Subversion.vcsInit">vcsInit</a></td>
-<td></td>
+<td>Public method used to initialize the subversion repository.</td>
 </tr>
 <tr>
 <td><a href="#Subversion.vcsInitConfig">vcsInitConfig</a></td>
-<td></td>
+<td>Public method to initialize the VCS configuration.</td>
 </tr>
 <tr>
 <td><a href="#Subversion.vcsLogBrowser">vcsLogBrowser</a></td>
@@ -308,7 +308,7 @@
 </tr>
 <tr>
 <td><a href="#Subversion.vcsRemove">vcsRemove</a></td>
-<td></td>
+<td>Public method used to remove a file/directory from the Subversion repository.</td>
 </tr>
 <tr>
 <td><a href="#Subversion.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
@@ -484,6 +484,41 @@
 <h4>Subversion.__vcsAllRegisteredStates_wcng</h4>
 <b>__vcsAllRegisteredStates_wcng</b>(<i>names, dname, shortcut=True</i>)
 
+<p>
+        Private method used to get the registered states of a number of files
+        in the vcs.
+</p>
+<p>
+        This is the variant for subversion installations using the new working
+        copy meta-data format.
+</p>
+<p>
+        <b>Note:</b> If a shortcut is to be taken, the code will only check,
+        if the named directory has been scanned already. If so, it is assumed,
+        that the states for all files has been populated by the previous run.
+</p>
+<dl>
+
+<dt><i>names</i></dt>
+<dd>
+dictionary with all filenames to be checked as keys
+</dd>
+<dt><i>dname</i></dt>
+<dd>
+directory to check in (string)
+</dd>
+<dt><i>shortcut</i></dt>
+<dd>
+flag indicating a shortcut should be taken (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+the received dictionary completed with a combination of
+            canBeCommited and canBeAdded or None in order to signal an error
+</dd>
+</dl>
 <a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a>
 <h4>Subversion.__vcsCommit_Step2</h4>
 <b>__vcsCommit_Step2</b>(<i></i>)
@@ -1378,10 +1413,49 @@
 <h4>Subversion.vcsInit</h4>
 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
 
+<p>
+        Public method used to initialize the subversion repository.
+</p>
+<p>
+        The subversion repository has to be initialized from outside eric
+        because the respective command always works locally. Therefore we
+        always return TRUE without doing anything.
+</p>
+<dl>
+
+<dt><i>vcsDir</i></dt>
+<dd>
+name of the VCS directory (string)
+</dd>
+<dt><i>noDialog</i></dt>
+<dd>
+flag indicating quiet operations (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+always TRUE
+</dd>
+</dl>
 <a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a>
 <h4>Subversion.vcsInitConfig</h4>
 <b>vcsInitConfig</b>(<i>project</i>)
 
+<p>
+        Public method to initialize the VCS configuration.
+</p>
+<p>
+        This method ensures, that eric specific files and directories are
+        ignored.
+</p>
+<dl>
+
+<dt><i>project</i></dt>
+<dd>
+reference to the project (Project)
+</dd>
+</dl>
 <a NAME="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a>
 <h4>Subversion.vcsLogBrowser</h4>
 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>)
@@ -1539,6 +1613,36 @@
 <h4>Subversion.vcsRemove</h4>
 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
 
+<p>
+        Public method used to remove a file/directory from the Subversion
+        repository.
+</p>
+<p>
+        The default operation is to remove the local copy as well.
+</p>
+<dl>
+
+<dt><i>name</i></dt>
+<dd>
+file/directory name to be removed (string or list of
+            strings))
+</dd>
+<dt><i>project</i></dt>
+<dd>
+flag indicating deletion of a project tree (boolean)
+            (not needed)
+</dd>
+<dt><i>noDialog</i></dt>
+<dd>
+flag indicating quiet operations
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating successfull operation (boolean)
+</dd>
+</dl>
 <a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a>
 <h4>Subversion.vcsRepositoryInfos</h4>
 <b>vcsRepositoryInfos</b>(<i>ppath</i>)

eric ide

mercurial