eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html

branch
eric7
changeset 8623
fced5aa98d41
parent 8596
d64760b2da50
child 8652
8cacde11f4fd
diff -r 149d51870ce8 -r fced5aa98d41 eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html
--- a/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html	Wed Sep 22 18:20:06 2021 +0200
+++ b/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html	Wed Sep 22 19:52:28 2021 +0200
@@ -299,14 +299,6 @@
 <td>Public method to rename a remote repository.</td>
 </tr>
 <tr>
-<td><a href="#Git.gitRevert">gitRevert</a></td>
-<td>Public method used to revert changes made to a file/directory.</td>
-</tr>
-<tr>
-<td><a href="#Git.gitSbsDiff">gitSbsDiff</a></td>
-<td>Public method used to view the difference of a file to the Git repository side-by-side.</td>
-</tr>
-<tr>
 <td><a href="#Git.gitShortlog">gitShortlog</a></td>
 <td>Public method to show a short log suitable for inclusion in release announcements.</td>
 </tr>
@@ -467,6 +459,10 @@
 <td>Public method used to export a directory from the Git repository.</td>
 </tr>
 <tr>
+<td><a href="#Git.vcsForget">vcsForget</a></td>
+<td>Public method used to remove a file from the Mercurial repository.</td>
+</tr>
+<tr>
 <td><a href="#Git.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
 <td>Public method to instantiate a helper object for the different project browsers.</td>
 </tr>
@@ -523,6 +519,14 @@
 <td>Public method to retrieve information about the repository.</td>
 </tr>
 <tr>
+<td><a href="#Git.vcsRevert">vcsRevert</a></td>
+<td>Public method used to revert changes made to a file/directory.</td>
+</tr>
+<tr>
+<td><a href="#Git.vcsSbsDiff">vcsSbsDiff</a></td>
+<td>Public method used to view the difference of a file to the Git repository side-by-side.</td>
+</tr>
+<tr>
 <td><a href="#Git.vcsShutdown">vcsShutdown</a></td>
 <td>Public method used to shutdown the Git interface.</td>
 </tr>
@@ -1733,57 +1737,6 @@
 name of the remote repository (string)
 </dd>
 </dl>
-<a NAME="Git.gitRevert" ID="Git.gitRevert"></a>
-<h4>Git.gitRevert</h4>
-<b>gitRevert</b>(<i>name</i>)
-
-<p>
-        Public method used to revert changes made to a file/directory.
-</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be reverted (string)
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-flag indicating, that the update contained an add
-            or delete (boolean)
-</dd>
-</dl>
-<a NAME="Git.gitSbsDiff" ID="Git.gitSbsDiff"></a>
-<h4>Git.gitSbsDiff</h4>
-<b>gitSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
-
-<p>
-        Public method used to view the difference of a file to the Git
-        repository side-by-side.
-</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file name to be diffed (string)
-</dd>
-<dt><i>extended</i></dt>
-<dd>
-flag indicating the extended variant (boolean)
-</dd>
-<dt><i>revisions</i></dt>
-<dd>
-tuple of two revisions (tuple of strings)
-</dd>
-</dl>
-<dl>
-
-<dt>Raises <b>ValueError</b>:</dt>
-<dd>
-raised to indicate an invalid name parameter
-</dd>
-</dl>
 <a NAME="Git.gitShortlog" ID="Git.gitShortlog"></a>
 <h4>Git.gitShortlog</h4>
 <b>gitShortlog</b>(<i>projectDir, commit</i>)
@@ -2531,6 +2484,23 @@
 flag indicating an execution without errors (boolean)
 </dd>
 </dl>
+<a NAME="Git.vcsForget" ID="Git.vcsForget"></a>
+<h4>Git.vcsForget</h4>
+<b>vcsForget</b>(<i>name</i>)
+
+<p>
+        Public method used to remove a file from the Mercurial repository.
+</p>
+<p>
+        This will not remove the file from the project directory.
+</p>
+<dl>
+
+<dt><i>name</i> (str or list of str)</dt>
+<dd>
+file/directory name to be removed
+</dd>
+</dl>
 <a NAME="Git.vcsGetProjectBrowserHelper" ID="Git.vcsGetProjectBrowserHelper"></a>
 <h4>Git.vcsGetProjectBrowserHelper</h4>
 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
@@ -2879,6 +2849,63 @@
 string with ready formated info for display (string)
 </dd>
 </dl>
+<a NAME="Git.vcsRevert" ID="Git.vcsRevert"></a>
+<h4>Git.vcsRevert</h4>
+<b>vcsRevert</b>(<i>name</i>)
+
+<p>
+        Public method used to revert changes made to a file/directory.
+</p>
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be reverted
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating, that the update contained an add
+            or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="Git.vcsSbsDiff" ID="Git.vcsSbsDiff"></a>
+<h4>Git.vcsSbsDiff</h4>
+<b>vcsSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
+
+<p>
+        Public method used to view the difference of a file to the Git
+        repository side-by-side.
+</p>
+<dl>
+
+<dt><i>name</i></dt>
+<dd>
+file name to be diffed (string)
+</dd>
+<dt><i>extended</i></dt>
+<dd>
+flag indicating the extended variant (boolean)
+</dd>
+<dt><i>revisions</i></dt>
+<dd>
+tuple of two revisions (tuple of strings)
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>ValueError</b>:</dt>
+<dd>
+raised to indicate an invalid name parameter
+</dd>
+</dl>
 <a NAME="Git.vcsShutdown" ID="Git.vcsShutdown"></a>
 <h4>Git.vcsShutdown</h4>
 <b>vcsShutdown</b>(<i></i>)

eric ide

mercurial