Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html	Fri Oct 27 14:09:40 2023 +0200
@@ -436,7 +436,7 @@
 </tr>
 <tr>
 <td><a href="#Git.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
-<td></td>
+<td>Public method used to get the registered states of a number of files in the vcs.</td>
 </tr>
 <tr>
 <td><a href="#Git.vcsCheckout">vcsCheckout</a></td>
@@ -496,7 +496,7 @@
 </tr>
 <tr>
 <td><a href="#Git.vcsInit">vcsInit</a></td>
-<td></td>
+<td>Public method used to initialize the Git repository.</td>
 </tr>
 <tr>
 <td><a href="#Git.vcsInitConfig">vcsInitConfig</a></td>
@@ -2356,6 +2356,37 @@
 <h4>Git.vcsAllRegisteredStates</h4>
 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>)
 
+<p>
+        Public method used to get the registered states of a number of files
+        in the vcs.
+</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 have 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="Git.vcsCheckout" ID="Git.vcsCheckout"></a>
 <h4>Git.vcsCheckout</h4>
 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
@@ -2663,6 +2694,31 @@
 <h4>Git.vcsInit</h4>
 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
 
+<p>
+        Public method used to initialize the Git repository.
+</p>
+<p>
+        The initialization is done, when a project is converted into a
+        Git controlled project. 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="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a>
 <h4>Git.vcsInitConfig</h4>
 <b>vcsInitConfig</b>(<i>project</i>)