--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html Sat Dec 23 15:40:23 2023 +0100
@@ -586,17 +586,17 @@
</p>
<dl>
-<dt><i>plugin</i></dt>
+<dt><i>plugin</i> (VcsGitPlugin)</dt>
<dd>
reference to the plugin object
</dd>
-<dt><i>parent</i></dt>
-<dd>
-parent widget (QWidget)
-</dd>
-<dt><i>name</i></dt>
-<dd>
-name of this object (string)
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget
+</dd>
+<dt><i>name</i> (str)</dt>
+<dd>
+name of this object
</dd>
</dl>
<a NAME="Git.__gitGetFileForRevision" ID="Git.__gitGetFileForRevision"></a>
@@ -609,19 +609,25 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file name to get from the repository (string)
-</dd>
-<dt><i>rev</i></dt>
-<dd>
-revision to retrieve (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+file name to get from the repository
+</dd>
+<dt><i>rev</i> (str)</dt>
+<dd>
+revision to retrieve
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-contents of the file (string) and an error message (string)
+contents of the file (string) and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Git.__gitGetStashesList" ID="Git.__gitGetStashesList"></a>
@@ -633,15 +639,21 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of available stashes (list of string)
+list of available stashes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="Git.__gitSubmodulesList" ID="Git.__gitSubmodulesList"></a>
@@ -741,20 +753,25 @@
</p>
<dl>
-<dt><i>interval</i></dt>
+<dt><i>interval</i> (int)</dt>
<dd>
check interval for the monitor thread in seconds
- (integer)
-</dd>
-<dt><i>project</i></dt>
-<dd>
-reference to the project object (Project)
+</dd>
+<dt><i>project</i> (Project)</dt>
+<dd>
+reference to the project object
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-reference to the monitor thread (QThread)
+reference to the monitor thread
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+GitStatusMonitorThread
</dd>
</dl>
<a NAME="Git.clearStatusCache" ID="Git.clearStatusCache"></a>
@@ -800,7 +817,13 @@
<dl>
<dt>Return:</dt>
<dd>
-reference to the plugin object (VcsGitPlugin)
+reference to the plugin object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+VcsGitPlugin
</dd>
</dl>
<a NAME="Git.gitAddRemote" ID="Git.gitAddRemote"></a>
@@ -812,9 +835,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitApply" ID="Git.gitApply"></a>
@@ -826,26 +849,25 @@
</p>
<dl>
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
-<dt><i>patchFile</i></dt>
-<dd>
-name of the patch file (string)
-</dd>
-<dt><i>cached</i></dt>
+<dt><i>repodir</i> (str)</dt>
+<dd>
+directory name of the repository
+</dd>
+<dt><i>patchFile</i> (str)</dt>
+<dd>
+name of the patch file
+</dd>
+<dt><i>cached</i> (bool)</dt>
<dd>
flag indicating to apply the patch to the staging area
- (boolean)
-</dd>
-<dt><i>reverse</i></dt>
-<dd>
-flag indicating to apply the patch in reverse (boolean)
-</dd>
-<dt><i>noDialog</i></dt>
-<dd>
-flag indicating quiet operations (boolean)
+</dd>
+<dt><i>reverse</i> (bool)</dt>
+<dd>
+flag indicating to apply the patch in reverse
+</dd>
+<dt><i>noDialog</i> (bool)</dt>
+<dd>
+flag indicating quiet operations
</dd>
</dl>
<a NAME="Git.gitApplyCheckPatches" ID="Git.gitApplyCheckPatches"></a>
@@ -858,13 +880,13 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-directory name of the project (string)
-</dd>
-<dt><i>check</i></dt>
-<dd>
-flag indicating to perform a check operation (boolean)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+directory name of the project
+</dd>
+<dt><i>check</i> (bool)</dt>
+<dd>
+flag indicating to perform a check operation
</dd>
</dl>
<a NAME="Git.gitBisect" ID="Git.gitBisect"></a>
@@ -876,21 +898,26 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>subcommand</i></dt>
-<dd>
-name of the subcommand (string, one of 'start',
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>subcommand</i> (str)</dt>
+<dd>
+name of the subcommand (one of 'start',
'start_extended', 'good', 'bad', 'skip' or 'reset')
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the update contained an add
- or delete (boolean)
+flag indicating, that the update contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<dl>
@@ -909,9 +936,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitBisectEditReplayFile" ID="Git.gitBisectEditReplayFile"></a>
@@ -923,9 +950,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitBisectLogBrowser" ID="Git.gitBisectLogBrowser"></a>
@@ -937,9 +964,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitBisectReplay" ID="Git.gitBisectReplay"></a>
@@ -951,16 +978,21 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the update contained an add
- or delete (boolean)
+flag indicating, that the update contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitBlame" ID="Git.gitBlame"></a>
@@ -991,29 +1023,34 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be branched (string)
-</dd>
-<dt><i>revision</i></dt>
-<dd>
-revision to set tag for (string)
-</dd>
-<dt><i>branchName</i></dt>
-<dd>
-name of the branch (string)
-</dd>
-<dt><i>branchOp</i></dt>
-<dd>
-desired branch operation (integer)
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be branched
+</dd>
+<dt><i>revision</i> (str)</dt>
+<dd>
+revision to set tag for
+</dd>
+<dt><i>branchName</i> (str)</dt>
+<dd>
+name of the branch
+</dd>
+<dt><i>branchOp</i> (int)</dt>
+<dd>
+desired branch operation
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a performed branch action (boolean) and
- a flag indicating, that the branch operation contained an add
- or delete (boolean)
+flag indicating a performed branch action and a flag indicating,
+ that the branch operation contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, bool)
</dd>
</dl>
<a NAME="Git.gitBundle" ID="Git.gitBundle"></a>
@@ -1025,9 +1062,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitBundleFetch" ID="Git.gitBundleFetch"></a>
@@ -1040,9 +1077,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitBundleListHeads" ID="Git.gitBundleListHeads"></a>
@@ -1054,9 +1091,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitBundlePull" ID="Git.gitBundlePull"></a>
@@ -1069,16 +1106,21 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the update contained an add
- or delete (boolean)
+flag indicating, that the update contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitCancelMerge" ID="Git.gitCancelMerge"></a>
@@ -1090,16 +1132,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the cancellation contained an add
- or delete (boolean)
+flag indicating, that the cancellation contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitChangeRemoteCredentials" ID="Git.gitChangeRemoteCredentials"></a>
@@ -1156,19 +1203,25 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>commits</i></dt>
-<dd>
-list of commits to be applied (list of strings)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>commits</i> (list of str)</dt>
+<dd>
+list of commits to be applied
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating that the project should be reread (boolean)
+flag indicating that the project should be reread
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitCherryPickAbort" ID="Git.gitCherryPickAbort"></a>
@@ -1181,15 +1234,21 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating that the project should be reread (boolean)
+flag indicating that the project should be reread
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitCherryPickContinue" ID="Git.gitCherryPickContinue"></a>
@@ -1202,15 +1261,21 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating that the project should be reread (boolean)
+flag indicating that the project should be reread
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitCherryPickQuit" ID="Git.gitCherryPickQuit"></a>
@@ -1222,15 +1287,21 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating that the project should be reread (boolean)
+flag indicating that the project should be reread
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitCommitMerge" ID="Git.gitCommitMerge"></a>
@@ -1242,9 +1313,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name
</dd>
</dl>
<a NAME="Git.gitCopy" ID="Git.gitCopy"></a>
@@ -1256,11 +1327,11 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be copied (string)
-</dd>
-<dt><i>project</i></dt>
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be copied
+</dd>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
@@ -1268,7 +1339,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating successful operation (boolean)
+flag indicating successful operation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitCreateArchive" ID="Git.gitCreateArchive"></a>
@@ -1280,9 +1357,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitCreateIgnoreFile" ID="Git.gitCreateIgnoreFile"></a>
@@ -1294,13 +1371,13 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-directory name to create the ignore file in (string)
-</dd>
-<dt><i>autoAdd</i></dt>
-<dd>
-flag indicating to add it automatically (boolean)
+<dt><i>name</i> (str)</dt>
+<dd>
+directory name to create the ignore file in
+</dd>
+<dt><i>autoAdd</i> (bool)</dt>
+<dd>
+flag indicating to add it automatically
</dd>
</dl>
<dl>
@@ -1309,6 +1386,12 @@
flag indicating success
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
<a NAME="Git.gitDeleteRemoteBranch" ID="Git.gitDeleteRemoteBranch"></a>
<h4>Git.gitDeleteRemoteBranch</h4>
<b>gitDeleteRemoteBranch</b>(<i>name</i>)
@@ -1318,9 +1401,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name
</dd>
</dl>
<a NAME="Git.gitDescribe" ID="Git.gitDescribe"></a>
@@ -1332,14 +1415,13 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>commits</i></dt>
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>commits</i> (list of str)</dt>
<dd>
list of commits to start the search from
- (list of strings)
</dd>
</dl>
<a NAME="Git.gitEditConfig" ID="Git.gitEditConfig"></a>
@@ -1351,9 +1433,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitEditUserConfig" ID="Git.gitEditUserConfig"></a>
@@ -1382,9 +1464,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be diffed (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be diffed
</dd>
</dl>
<a NAME="Git.gitFetch" ID="Git.gitFetch"></a>
@@ -1396,9 +1478,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-directory name (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+directory name
</dd>
</dl>
<a NAME="Git.gitGetArchiveFormats" ID="Git.gitGetArchiveFormats"></a>
@@ -1410,15 +1492,21 @@
</p>
<dl>
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
+<dt><i>repodir</i> (str)</dt>
+<dd>
+directory name of the repository
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of supported archive formats (list of strings)
+list of supported archive formats
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="Git.gitGetBranchesList" ID="Git.gitGetBranchesList"></a>
@@ -1430,27 +1518,33 @@
</p>
<dl>
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
-<dt><i>withMain</i></dt>
-<dd>
-flag indicating to get 'main' as well (boolean)
-</dd>
-<dt><i>allBranches</i></dt>
-<dd>
-flag indicating to return all branches (boolean)
-</dd>
-<dt><i>remotes</i></dt>
-<dd>
-flag indicating to return remote branches only (boolean)
+<dt><i>repodir</i> (str)</dt>
+<dd>
+directory name of the repository
+</dd>
+<dt><i>withMain</i> (bool)</dt>
+<dd>
+flag indicating to get 'main' as well
+</dd>
+<dt><i>allBranches</i> (bool)</dt>
+<dd>
+flag indicating to return all branches
+</dd>
+<dt><i>remotes</i> (bool)</dt>
+<dd>
+flag indicating to return remote branches only
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of branches (list of string)
+list of branches
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="Git.gitGetBundleHeads" ID="Git.gitGetBundleHeads"></a>
@@ -1462,19 +1556,25 @@
</p>
<dl>
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
-<dt><i>bundleFile</i></dt>
-<dd>
-file name of a git bundle file (string)
+<dt><i>repodir</i> (str)</dt>
+<dd>
+directory name of the repository
+</dd>
+<dt><i>bundleFile</i> (str)</dt>
+<dd>
+file name of a git bundle file
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of heads (list of strings)
+list of heads
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="Git.gitGetCurrentBranch" ID="Git.gitGetCurrentBranch"></a>
@@ -1486,15 +1586,21 @@
</p>
<dl>
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
+<dt><i>repodir</i> (str)</dt>
+<dd>
+directory name of the repository
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-name of the current branch (string)
+name of the current branch
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Git.gitGetRemoteBranchesList" ID="Git.gitGetRemoteBranchesList"></a>
@@ -1506,19 +1612,25 @@
</p>
<dl>
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
-<dt><i>remote</i></dt>
-<dd>
-remote repository name (string)
+<dt><i>repodir</i> (str)</dt>
+<dd>
+directory name of the repository
+</dd>
+<dt><i>remote</i> (str)</dt>
+<dd>
+remote repository name
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of remote repository branches (list of string)
+list of remote repository branches
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="Git.gitGetRemoteUrl" ID="Git.gitGetRemoteUrl"></a>
@@ -1560,20 +1672,25 @@
</p>
<dl>
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
-<dt><i>forFetch</i></dt>
-<dd>
-flag indicating to get Fetch info (string)
+<dt><i>repodir</i> (str)</dt>
+<dd>
+directory name of the repository
+</dd>
+<dt><i>forFetch</i> (str)</dt>
+<dd>
+flag indicating to get Fetch info
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of tuples of remote repo name and repo URL (list of
- tuple of two strings)
+list of tuples of remote repo name and repo URL
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of [(str, str)]
</dd>
</dl>
<a NAME="Git.gitGetRemotesList" ID="Git.gitGetRemotesList"></a>
@@ -1585,15 +1702,21 @@
</p>
<dl>
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
+<dt><i>repodir</i> (str)</dt>
+<dd>
+directory name of the repository
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of remote repos (list of string)
+list of remote repos
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="Git.gitGetTagsList" ID="Git.gitGetTagsList"></a>
@@ -1605,17 +1728,22 @@
</p>
<dl>
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
+<dt><i>repodir</i> (str)</dt>
+<dd>
+directory name of the repository
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of tags (list of string) or list of tuples of
- tag name and flag indicating a local tag (list of tuple of string
- and boolean), if withType is True
+list of tags or list of tuples of tag name and flag indicating
+ a local tag, if withType is True
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str or list of tuple of (str, bool)
</dd>
</dl>
<a NAME="Git.gitHouseKeeping" ID="Git.gitHouseKeeping"></a>
@@ -1627,9 +1755,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitListTagBranch" ID="Git.gitListTagBranch"></a>
@@ -1641,23 +1769,22 @@
</p>
<dl>
-<dt><i>path</i></dt>
-<dd>
-directory name of the project (string)
-</dd>
-<dt><i>tags</i></dt>
+<dt><i>path</i> (str)</dt>
+<dd>
+directory name of the project
+</dd>
+<dt><i>tags</i> (bool)</dt>
<dd>
flag indicating listing of branches or tags
(False = branches, True = tags)
</dd>
-<dt><i>listAll</i></dt>
-<dd>
-flag indicating to show all tags or branches (boolean)
-</dd>
-<dt><i>merged</i></dt>
-<dd>
-flag indicating to show only merged or non-merged
- branches (boolean)
+<dt><i>listAll</i> (bool)</dt>
+<dd>
+flag indicating to show all tags or branches
+</dd>
+<dt><i>merged</i> (bool)</dt>
+<dd>
+flag indicating to show only merged or non-merged branches
</dd>
</dl>
<a NAME="Git.gitNormalizeURL" ID="Git.gitNormalizeURL"></a>
@@ -1669,15 +1796,21 @@
</p>
<dl>
-<dt><i>url</i></dt>
-<dd>
-url string (string)
+<dt><i>url</i> (str)</dt>
+<dd>
+url string
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-properly normalized url for git (string)
+properly normalized url for git
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Git.gitPruneRemote" ID="Git.gitPruneRemote"></a>
@@ -1689,13 +1822,13 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>remoteName</i></dt>
-<dd>
-name of the remote repository (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>remoteName</i> (str)</dt>
+<dd>
+name of the remote repository
</dd>
</dl>
<a NAME="Git.gitPull" ID="Git.gitPull"></a>
@@ -1707,16 +1840,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-directory name of the project to be pulled to (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+directory name of the project to be pulled to
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the update contained an add
- or delete (boolean)
+flag indicating, that the update contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitPush" ID="Git.gitPush"></a>
@@ -1728,9 +1866,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-directory name of the project to be pushed from (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+directory name of the project to be pushed from
</dd>
</dl>
<a NAME="Git.gitReflogBrowser" ID="Git.gitReflogBrowser"></a>
@@ -1742,9 +1880,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitRemoveRemote" ID="Git.gitRemoveRemote"></a>
@@ -1756,13 +1894,13 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>remoteName</i></dt>
-<dd>
-name of the remote repository (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>remoteName</i> (str)</dt>
+<dd>
+name of the remote repository
</dd>
</dl>
<a NAME="Git.gitRenameRemote" ID="Git.gitRenameRemote"></a>
@@ -1774,13 +1912,13 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>remoteName</i></dt>
-<dd>
-name of the remote repository (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>remoteName</i> (str)</dt>
+<dd>
+name of the remote repository
</dd>
</dl>
<a NAME="Git.gitShortlog" ID="Git.gitShortlog"></a>
@@ -1793,13 +1931,13 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>commit</i></dt>
-<dd>
-commit to start the log at (strings)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>commit</i> (str)</dt>
+<dd>
+commit to start the log at
</dd>
</dl>
<a NAME="Git.gitShowBranch" ID="Git.gitShowBranch"></a>
@@ -1811,9 +1949,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name
</dd>
</dl>
<a NAME="Git.gitShowConfig" ID="Git.gitShowConfig"></a>
@@ -1825,9 +1963,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitShowPatchesStatistics" ID="Git.gitShowPatchesStatistics"></a>
@@ -1839,9 +1977,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-directory name of the project (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+directory name of the project
</dd>
</dl>
<a NAME="Git.gitShowRemote" ID="Git.gitShowRemote"></a>
@@ -1853,13 +1991,13 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>remoteName</i></dt>
-<dd>
-name of the remote repository (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>remoteName</i> (str)</dt>
+<dd>
+name of the remote repository
</dd>
</dl>
<a NAME="Git.gitShowRemotes" ID="Git.gitShowRemotes"></a>
@@ -1871,9 +2009,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitStashApply" ID="Git.gitStashApply"></a>
@@ -1885,20 +2023,25 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>stashName</i></dt>
-<dd>
-name of a stash (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>stashName</i> (str)</dt>
+<dd>
+name of a stash
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the restore contained an add
- or delete (boolean)
+flag indicating, that the restore contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitStashBranch" ID="Git.gitStashBranch"></a>
@@ -1910,20 +2053,25 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>stashName</i></dt>
-<dd>
-name of a stash (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>stashName</i> (str)</dt>
+<dd>
+name of a stash
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the restore contained an add
- or delete (boolean)
+flag indicating, that the restore contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitStashBrowser" ID="Git.gitStashBrowser"></a>
@@ -1935,9 +2083,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitStashClear" ID="Git.gitStashClear"></a>
@@ -1949,15 +2097,21 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a successful deletion (boolean)
+flag indicating a successful deletion
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitStashDrop" ID="Git.gitStashDrop"></a>
@@ -1969,19 +2123,25 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>stashName</i></dt>
-<dd>
-name of a stash (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>stashName</i> (str)</dt>
+<dd>
+name of a stash
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a successful deletion (boolean)
+flag indicating a successful deletion
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitStashPop" ID="Git.gitStashPop"></a>
@@ -1993,20 +2153,25 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>stashName</i></dt>
-<dd>
-name of a stash (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>stashName</i> (str)</dt>
+<dd>
+name of a stash
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the restore contained an add
- or delete (boolean)
+flag indicating, that the restore contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitStashSave" ID="Git.gitStashSave"></a>
@@ -2018,16 +2183,21 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the save contained an add
- or delete (boolean)
+flag indicating, that the save contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitStashShowPatch" ID="Git.gitStashShowPatch"></a>
@@ -2039,13 +2209,13 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
-</dd>
-<dt><i>stashName</i></dt>
-<dd>
-name of a stash (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
+</dd>
+<dt><i>stashName</i> (str)</dt>
+<dd>
+name of a stash
</dd>
</dl>
<a NAME="Git.gitStatistics" ID="Git.gitStatistics"></a>
@@ -2057,9 +2227,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitSubmoduleAdd" ID="Git.gitSubmoduleAdd"></a>
@@ -2206,16 +2376,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be reverted (string)
+<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 (boolean)
+flag indicating, that the update contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.gitVerify" ID="Git.gitVerify"></a>
@@ -2228,9 +2403,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitVerifyBundle" ID="Git.gitVerifyBundle"></a>
@@ -2242,9 +2417,9 @@
</p>
<dl>
-<dt><i>projectDir</i></dt>
-<dd>
-name of the project directory (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+name of the project directory
</dd>
</dl>
<a NAME="Git.gitWorktreeManagement" ID="Git.gitWorktreeManagement"></a>
@@ -2270,15 +2445,21 @@
</p>
<dl>
-<dt><i>command</i></dt>
-<dd>
-command name (string)
+<dt><i>command</i> (str)</dt>
+<dd>
+command name
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of command options (list of string)
+list of command options
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="Git.vcsAdd" ID="Git.vcsAdd"></a>
@@ -2290,15 +2471,15 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be added (string)
-</dd>
-<dt><i>isDir</i></dt>
-<dd>
-flag indicating name is a directory (boolean)
-</dd>
-<dt><i>noDialog</i></dt>
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be added
+</dd>
+<dt><i>isDir</i> (bool)</dt>
+<dd>
+flag indicating name is a directory
+</dd>
+<dt><i>noDialog</i> (bool)</dt>
<dd>
flag indicating quiet operations
</dd>
@@ -2313,13 +2494,13 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be added (string)
-</dd>
-<dt><i>isDir</i></dt>
-<dd>
-flag indicating name is a directory (boolean)
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be added
+</dd>
+<dt><i>isDir</i> (bool)</dt>
+<dd>
+flag indicating name is a directory
</dd>
</dl>
<a NAME="Git.vcsAddCommitMessage" ID="Git.vcsAddCommitMessage"></a>
@@ -2346,10 +2527,9 @@
</p>
<dl>
-<dt><i>path</i></dt>
-<dd>
-root directory of the tree to be added (string or list of
- strings))
+<dt><i>path</i> (str or list of str)</dt>
+<dd>
+root directory of the tree to be added
</dd>
</dl>
<a NAME="Git.vcsAllRegisteredStates" ID="Git.vcsAllRegisteredStates"></a>
@@ -2367,17 +2547,17 @@
</p>
<dl>
-<dt><i>names</i></dt>
+<dt><i>names</i> (dict)</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)
+<dt><i>dname</i> (str)</dt>
+<dd>
+directory to check in
+</dd>
+<dt><i>shortcut</i> (bool)</dt>
+<dd>
+flag indicating a shortcut should be taken
</dd>
</dl>
<dl>
@@ -2387,6 +2567,12 @@
canBeCommited and canBeAdded or None in order to signal an error
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
<a NAME="Git.vcsCheckout" ID="Git.vcsCheckout"></a>
<h4>Git.vcsCheckout</h4>
<b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
@@ -2397,15 +2583,15 @@
</p>
<dl>
-<dt><i>vcsDataDict</i></dt>
+<dt><i>vcsDataDict</i> (dict)</dt>
<dd>
dictionary of data required for the checkout
</dd>
-<dt><i>projectDir</i></dt>
-<dd>
-project directory to create (string)
-</dd>
-<dt><i>noDialog</i></dt>
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+project directory to create
+</dd>
+<dt><i>noDialog</i> (bool)</dt>
<dd>
flag indicating quiet operations
</dd>
@@ -2413,7 +2599,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating an execution without errors (boolean)
+flag indicating an execution without errors
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.vcsCleanup" ID="Git.vcsCleanup"></a>
@@ -2425,9 +2617,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-directory name to be cleaned up (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+directory name to be cleaned up
</dd>
</dl>
<a NAME="Git.vcsClearCommitMessages" ID="Git.vcsClearCommitMessages"></a>
@@ -2446,9 +2638,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-directory name of the working directory (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+directory name of the working directory
</dd>
</dl>
<a NAME="Git.vcsCommit" ID="Git.vcsCommit"></a>
@@ -2461,26 +2653,25 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be committed (string or list of
- strings)
-</dd>
-<dt><i>message</i></dt>
-<dd>
-message for this operation (string)
-</dd>
-<dt><i>noDialog</i></dt>
-<dd>
-flag indicating quiet operations (boolean)
-</dd>
-<dt><i>commitAll</i></dt>
-<dd>
-flag indicating to commit all local changes (boolean)
-</dd>
-<dt><i>amend</i></dt>
-<dd>
-flag indicating to amend the HEAD commit (boolean)
+<dt><i>name</i> (str or list of str)</dt>
+<dd>
+file/directory name to be committed
+</dd>
+<dt><i>message</i> (str)</dt>
+<dd>
+message for this operation
+</dd>
+<dt><i>noDialog</i> (bool)</dt>
+<dd>
+flag indicating quiet operations
+</dd>
+<dt><i>commitAll</i> (bool)</dt>
+<dd>
+flag indicating to commit all local changes
+</dd>
+<dt><i>amend</i> (bool)</dt>
+<dd>
+flag indicating to amend the HEAD commit
</dd>
</dl>
<a NAME="Git.vcsCommitMessages" ID="Git.vcsCommitMessages"></a>
@@ -2541,9 +2732,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be diffed (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be diffed
</dd>
</dl>
<a NAME="Git.vcsExists" ID="Git.vcsExists"></a>
@@ -2556,8 +2747,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the existance (boolean) and an error message
- (string)
+flag indicating the existance and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
</dd>
</dl>
<a NAME="Git.vcsExport" ID="Git.vcsExport"></a>
@@ -2569,19 +2765,25 @@
</p>
<dl>
-<dt><i>vcsDataDict</i></dt>
+<dt><i>vcsDataDict</i> (dict)</dt>
<dd>
dictionary of data required for the checkout
</dd>
-<dt><i>projectDir</i></dt>
-<dd>
-project directory to create (string)
+<dt><i>projectDir</i> (str)</dt>
+<dd>
+project directory to create
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating an execution without errors (boolean)
+flag indicating an execution without errors
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.vcsForget" ID="Git.vcsForget"></a>
@@ -2611,15 +2813,15 @@
</p>
<dl>
-<dt><i>browser</i></dt>
+<dt><i>browser</i> (ProjectBaseBrowser)</dt>
<dd>
reference to the project browser object
</dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
-<dt><i>isTranslationsBrowser</i></dt>
+<dt><i>isTranslationsBrowser</i> (bool)</dt>
<dd>
flag indicating, the helper is requested
for the translations browser (this needs some special treatment)
@@ -2631,6 +2833,12 @@
the project browser helper object
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+GitProjectBrowserHelper
+</dd>
+</dl>
<a NAME="Git.vcsGetProjectHelper" ID="Git.vcsGetProjectHelper"></a>
<h4>Git.vcsGetProjectHelper</h4>
<b>vcsGetProjectHelper</b>(<i>project</i>)
@@ -2640,7 +2848,7 @@
</p>
<dl>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
@@ -2651,6 +2859,12 @@
the project helper object
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+GitProjectHelper
+</dd>
+</dl>
<a NAME="Git.vcsImport" ID="Git.vcsImport"></a>
<h4>Git.vcsImport</h4>
<b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>)
@@ -2666,7 +2880,7 @@
</dd>
<dt><i>projectDir</i> (str)</dt>
<dd>
-project directory (string)
+project directory
</dd>
<dt><i>noDialog</i> (bool)</dt>
<dd>
@@ -2704,19 +2918,25 @@
</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)
+<dt><i>vcsDir</i> (str)</dt>
+<dd>
+name of the VCS directory
+</dd>
+<dt><i>noDialog</i> (bool)</dt>
+<dd>
+flag indicating quiet operations
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-always TRUE
+always True
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a>
@@ -2731,9 +2951,9 @@
</p>
<dl>
-<dt><i>project</i></dt>
-<dd>
-reference to the project (Project)
+<dt><i>project</i> (Project)</dt>
+<dd>
+reference to the project
</dd>
</dl>
<a NAME="Git.vcsLogBrowser" ID="Git.vcsLogBrowser"></a>
@@ -2746,14 +2966,13 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to show the log of (string)
-</dd>
-<dt><i>isFile</i></dt>
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to show the log of
+</dd>
+<dt><i>isFile</i> (bool)</dt>
<dd>
flag indicating log for a file is to be shown
- (boolean)
</dd>
</dl>
<a NAME="Git.vcsMerge" ID="Git.vcsMerge"></a>
@@ -2765,9 +2984,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be merged (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be merged
</dd>
</dl>
<a NAME="Git.vcsMove" ID="Git.vcsMove"></a>
@@ -2779,19 +2998,19 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be moved (string)
-</dd>
-<dt><i>project</i></dt>
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be moved
+</dd>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
-<dt><i>target</i></dt>
-<dd>
-new name of the file/directory (string)
-</dd>
-<dt><i>noDialog</i></dt>
+<dt><i>target</i> (str)</dt>
+<dd>
+new name of the file/directory
+</dd>
+<dt><i>noDialog</i> (bool)</dt>
<dd>
flag indicating quiet operations
</dd>
@@ -2799,7 +3018,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating successful operation (boolean)
+flag indicating successful operation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.vcsName" ID="Git.vcsName"></a>
@@ -2812,7 +3037,13 @@
<dl>
<dt>Return:</dt>
<dd>
-always 'Git' (string)
+always 'Git'
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Git.vcsNewProjectOptionsDialog" ID="Git.vcsNewProjectOptionsDialog"></a>
@@ -2825,16 +3056,21 @@
</p>
<dl>
-<dt><i>parent</i></dt>
-<dd>
-parent widget (QWidget)
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the instantiated options dialog
- (GitNewProjectOptionsDialog)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+GitNewProjectOptionsDialog
</dd>
</dl>
<a NAME="Git.vcsOptionsDialog" ID="Git.vcsOptionsDialog"></a>
@@ -2846,28 +3082,33 @@
</p>
<dl>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
-<dt><i>archive</i></dt>
-<dd>
-name of the project in the repository (string)
-</dd>
-<dt><i>editable</i></dt>
+<dt><i>archive</i> (str)</dt>
+<dd>
+name of the project in the repository
+</dd>
+<dt><i>editable</i> (bool)</dt>
<dd>
flag indicating that the project name is editable
- (boolean)
-</dd>
-<dt><i>parent</i></dt>
-<dd>
-parent widget (QWidget)
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-reference to the instantiated options dialog (GitOptionsDialog)
+reference to the instantiated options dialog
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+GitOptionsDialog
</dd>
</dl>
<a NAME="Git.vcsRegisteredState" ID="Git.vcsRegisteredState"></a>
@@ -2879,15 +3120,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-filename to check (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+filename to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-a combination of canBeCommited and canBeAdded
+registered state (one of canBeCommited and canBeAdded)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="Git.vcsRemove" ID="Git.vcsRemove"></a>
@@ -2903,30 +3150,34 @@
</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 (boolean)
-</dd>
-<dt><i>stageOnly</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
+<dd>
+file/directory name to be removed
+</dd>
+<dt><i>project</i> (bool)</dt>
+<dd>
+flag indicating deletion of a project tree
+</dd>
+<dt><i>noDialog</i> (bool)</dt>
+<dd>
+flag indicating quiet operations
+</dd>
+<dt><i>stageOnly</i> (bool)</dt>
<dd>
flag indicating to just remove the file from the
- staging area (boolean)
+ staging area
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating successful operation (boolean)
+flag indicating successful operation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.vcsRepositoryInfos" ID="Git.vcsRepositoryInfos"></a>
@@ -2938,15 +3189,21 @@
</p>
<dl>
-<dt><i>ppath</i></dt>
-<dd>
-local path to get the repository infos (string)
+<dt><i>ppath</i> (str)</dt>
+<dd>
+local path to get the repository infos
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-string with ready formated info for display (string)
+string with ready formated info for display
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Git.vcsRevert" ID="Git.vcsRevert"></a>
@@ -2986,17 +3243,17 @@
</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)
+<dt><i>name</i> (str)</dt>
+<dd>
+file name to be diffed
+</dd>
+<dt><i>extended</i> (bool)</dt>
+<dd>
+flag indicating the extended variant
+</dd>
+<dt><i>revisions</i> (tuple of (str, str))</dt>
+<dd>
+tuple of two revisions
</dd>
</dl>
<dl>
@@ -3023,10 +3280,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
<dd>
file/directory name(s) to show the status of
- (string or list of strings)
</dd>
</dl>
<a NAME="Git.vcsSupportCommandOptions" ID="Git.vcsSupportCommandOptions"></a>
@@ -3040,7 +3296,12 @@
<dt>Return:</dt>
<dd>
flag indicating the support of user settable command options
- (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.vcsSwitch" ID="Git.vcsSwitch"></a>
@@ -3053,16 +3314,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-directory name to be switched (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+directory name to be switched
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the switch contained an add
- or delete (boolean)
+flag indicating, that the switch contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.vcsTag" ID="Git.vcsTag"></a>
@@ -3074,24 +3340,29 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
file/directory name to determine the repo root from
- (string)
-</dd>
-<dt><i>revision</i></dt>
-<dd>
-revision to set tag for (string)
-</dd>
-<dt><i>tagName</i></dt>
-<dd>
-name of the tag (string)
+</dd>
+<dt><i>revision</i> (str)</dt>
+<dd>
+revision to set tag for
+</dd>
+<dt><i>tagName</i> (str)</dt>
+<dd>
+name of the tag
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a performed tag action (boolean)
+flag indicating a performed tag action
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Git.vcsUpdate" ID="Git.vcsUpdate"></a>
@@ -3104,25 +3375,29 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be updated (string or list of
- strings)
-</dd>
-<dt><i>noDialog</i></dt>
-<dd>
-flag indicating quiet operations (boolean)
-</dd>
-<dt><i>revision</i></dt>
-<dd>
-revision to update to (string)
+<dt><i>name</i> (str or list of str)</dt>
+<dd>
+file/directory name to be updated
+</dd>
+<dt><i>noDialog</i> (bool)</dt>
+<dd>
+flag indicating quiet operations
+</dd>
+<dt><i>revision</i> (str)</dt>
+<dd>
+revision to update to
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the update contained an add
- or delete (boolean)
+flag indicating, that the update contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
