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

branch
eric7
changeset 10259
b51dfacef37f
parent 10070
9f5758c0fec1
child 10438
4cd7e5a8b3cf
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html	Fri Oct 27 14:09:40 2023 +0200
@@ -260,11 +260,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>
@@ -296,7 +296,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>
@@ -1345,10 +1345,48 @@
 <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 an ignore file exists.
+</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>)
@@ -1506,6 +1544,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