--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,37 +7,36 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.Plugins.VcsPlugins.vcsGit.git</h1> - <p> Module implementing the version control systems interface to Git. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#Git">Git</a></td> <td>Class implementing the version control systems interface to Git.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="Git" ID="Git"></a> <h2>Git</h2> - <p> Class implementing the version control systems interface to Git. </p> + <h3>Signals</h3> <dl> @@ -49,19 +48,17 @@ <h3>Derived from</h3> VersionControl <h3>Class Attributes</h3> - <table> <tr><td>IgnoreFileName</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#Git.__init__">Git</a></td> <td>Constructor</td> @@ -571,19 +568,20 @@ <td>Public method used to update a file/directory with the Git repository.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="Git.__init__" ID="Git.__init__"></a> <h4>Git (Constructor)</h4> <b>Git</b>(<i>plugin, parent=None, name=None</i>) - <p> Constructor </p> + <dl> <dt><i>plugin</i> (VcsGitPlugin)</dt> @@ -602,11 +600,11 @@ <a NAME="Git.__gitGetFileForRevision" ID="Git.__gitGetFileForRevision"></a> <h4>Git.__gitGetFileForRevision</h4> <b>__gitGetFileForRevision</b>(<i>name, rev=""</i>) - <p> Private method to get a file for a specific revision from the repository. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -633,10 +631,10 @@ <a NAME="Git.__gitGetStashesList" ID="Git.__gitGetStashesList"></a> <h4>Git.__gitGetStashesList</h4> <b>__gitGetStashesList</b>(<i>projectDir</i>) - <p> Private method to get a list of stash names. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -659,10 +657,10 @@ <a NAME="Git.__gitSubmodulesList" ID="Git.__gitSubmodulesList"></a> <h4>Git.__gitSubmodulesList</h4> <b>__gitSubmodulesList</b>(<i>repodir</i>) - <p> Private method to get the data of defined submodules. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -685,10 +683,10 @@ <a NAME="Git.__selectSubmodulePath" ID="Git.__selectSubmodulePath"></a> <h4>Git.__selectSubmodulePath</h4> <b>__selectSubmodulePath</b>(<i>repodir</i>) - <p> Private method to select a submodule path. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -712,10 +710,10 @@ <a NAME="Git.__selectSubmodulePaths" ID="Git.__selectSubmodulePaths"></a> <h4>Git.__selectSubmodulePaths</h4> <b>__selectSubmodulePaths</b>(<i>repodir</i>) - <p> Private method to select a list of submodule paths. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -739,18 +737,18 @@ <a NAME="Git.__vcsCommit_Step2" ID="Git.__vcsCommit_Step2"></a> <h4>Git.__vcsCommit_Step2</h4> <b>__vcsCommit_Step2</b>(<i></i>) - <p> Private slot performing the second step of the commit action. </p> + <a NAME="Git._createStatusMonitorThread" ID="Git._createStatusMonitorThread"></a> <h4>Git._createStatusMonitorThread</h4> <b>_createStatusMonitorThread</b>(<i>interval, project</i>) - <p> Protected method to create an instance of the VCS status monitor thread. </p> + <dl> <dt><i>interval</i> (int)</dt> @@ -777,17 +775,17 @@ <a NAME="Git.clearStatusCache" ID="Git.clearStatusCache"></a> <h4>Git.clearStatusCache</h4> <b>clearStatusCache</b>(<i></i>) - <p> Public method to clear the status cache. </p> + <a NAME="Git.findRepoRoot" ID="Git.findRepoRoot"></a> <h4>Git.findRepoRoot</h4> <b>findRepoRoot</b>(<i>start</i>) - <p> Public method to find the repository root directory given a start. </p> + <dl> <dt><i>start</i> (str)</dt> @@ -810,10 +808,10 @@ <a NAME="Git.getPlugin" ID="Git.getPlugin"></a> <h4>Git.getPlugin</h4> <b>getPlugin</b>(<i></i>) - <p> Public method to get a reference to the plugin object. </p> + <dl> <dt>Return:</dt> <dd> @@ -829,10 +827,10 @@ <a NAME="Git.gitAddRemote" ID="Git.gitAddRemote"></a> <h4>Git.gitAddRemote</h4> <b>gitAddRemote</b>(<i>projectDir</i>) - <p> Public method to add a remote repository. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -843,10 +841,10 @@ <a NAME="Git.gitApply" ID="Git.gitApply"></a> <h4>Git.gitApply</h4> <b>gitApply</b>(<i>repodir, patchFile, cached=False, reverse=False, noDialog=False</i>) - <p> Public method to apply a patch stored in a given file. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -873,11 +871,11 @@ <a NAME="Git.gitApplyCheckPatches" ID="Git.gitApplyCheckPatches"></a> <h4>Git.gitApplyCheckPatches</h4> <b>gitApplyCheckPatches</b>(<i>projectDir, check=False</i>) - <p> Public method to apply a list of patch files or check, if they would apply cleanly. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -892,10 +890,10 @@ <a NAME="Git.gitBisect" ID="Git.gitBisect"></a> <h4>Git.gitBisect</h4> <b>gitBisect</b>(<i>projectDir, subcommand</i>) - <p> Public method to perform bisect commands. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -930,10 +928,10 @@ <a NAME="Git.gitBisectCreateReplayFile" ID="Git.gitBisectCreateReplayFile"></a> <h4>Git.gitBisectCreateReplayFile</h4> <b>gitBisectCreateReplayFile</b>(<i>projectDir</i>) - <p> Public method used to create a bisect replay file for the project. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -944,10 +942,10 @@ <a NAME="Git.gitBisectEditReplayFile" ID="Git.gitBisectEditReplayFile"></a> <h4>Git.gitBisectEditReplayFile</h4> <b>gitBisectEditReplayFile</b>(<i>projectDir</i>) - <p> Public method used to edit a bisect replay file. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -958,10 +956,10 @@ <a NAME="Git.gitBisectLogBrowser" ID="Git.gitBisectLogBrowser"></a> <h4>Git.gitBisectLogBrowser</h4> <b>gitBisectLogBrowser</b>(<i>projectDir</i>) - <p> Public method used to browse the bisect log of the project. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -972,10 +970,10 @@ <a NAME="Git.gitBisectReplay" ID="Git.gitBisectReplay"></a> <h4>Git.gitBisectReplay</h4> <b>gitBisectReplay</b>(<i>projectDir</i>) - <p> Public method to replay a bisect session. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -998,10 +996,10 @@ <a NAME="Git.gitBlame" ID="Git.gitBlame"></a> <h4>Git.gitBlame</h4> <b>gitBlame</b>(<i>name, skiplist=""</i>) - <p> Public method to show the output of the git blame command. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1016,11 +1014,11 @@ <a NAME="Git.gitBranch" ID="Git.gitBranch"></a> <h4>Git.gitBranch</h4> <b>gitBranch</b>(<i>name, revision=None, branchName=None, branchOp=None</i>) - <p> Public method used to create, delete or move a branch in the Git repository. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1056,10 +1054,10 @@ <a NAME="Git.gitBundle" ID="Git.gitBundle"></a> <h4>Git.gitBundle</h4> <b>gitBundle</b>(<i>projectDir</i>) - <p> Public method to create a bundle file. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1070,11 +1068,11 @@ <a NAME="Git.gitBundleFetch" ID="Git.gitBundleFetch"></a> <h4>Git.gitBundleFetch</h4> <b>gitBundleFetch</b>(<i>projectDir</i>) - <p> Public method to fetch a head of a bundle file into the local repository. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1085,10 +1083,10 @@ <a NAME="Git.gitBundleListHeads" ID="Git.gitBundleListHeads"></a> <h4>Git.gitBundleListHeads</h4> <b>gitBundleListHeads</b>(<i>projectDir</i>) - <p> Public method to list the heads contained in a bundle file. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1099,11 +1097,11 @@ <a NAME="Git.gitBundlePull" ID="Git.gitBundlePull"></a> <h4>Git.gitBundlePull</h4> <b>gitBundlePull</b>(<i>projectDir</i>) - <p> Public method to pull a head of a bundle file into the local repository and working area. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1126,10 +1124,10 @@ <a NAME="Git.gitCancelMerge" ID="Git.gitCancelMerge"></a> <h4>Git.gitCancelMerge</h4> <b>gitCancelMerge</b>(<i>name</i>) - <p> Public method to cancel an uncommitted or failed merge. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1152,10 +1150,10 @@ <a NAME="Git.gitChangeRemoteCredentials" ID="Git.gitChangeRemoteCredentials"></a> <h4>Git.gitChangeRemoteCredentials</h4> <b>gitChangeRemoteCredentials</b>(<i>projectDir, remoteName, remoteUrl=""</i>) - <p> Public method to change the user credentials of a remote repository. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1174,10 +1172,10 @@ <a NAME="Git.gitChangeRemoteUrl" ID="Git.gitChangeRemoteUrl"></a> <h4>Git.gitChangeRemoteUrl</h4> <b>gitChangeRemoteUrl</b>(<i>projectDir, remoteName, remoteUrl=""</i>) - <p> Public method to change the URL of a remote repository. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1196,11 +1194,11 @@ <a NAME="Git.gitCherryPick" ID="Git.gitCherryPick"></a> <h4>Git.gitCherryPick</h4> <b>gitCherryPick</b>(<i>projectDir, commits=None</i>) - <p> Public method to cherry pick commits and apply them to the current branch. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1227,11 +1225,11 @@ <a NAME="Git.gitCherryPickAbort" ID="Git.gitCherryPickAbort"></a> <h4>Git.gitCherryPickAbort</h4> <b>gitCherryPickAbort</b>(<i>projectDir</i>) - <p> Public method to cancel the last copying session and return to the previous state. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1254,11 +1252,11 @@ <a NAME="Git.gitCherryPickContinue" ID="Git.gitCherryPickContinue"></a> <h4>Git.gitCherryPickContinue</h4> <b>gitCherryPickContinue</b>(<i>projectDir</i>) - <p> Public method to continue the last copying session after conflicts were resolved. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1281,10 +1279,10 @@ <a NAME="Git.gitCherryPickQuit" ID="Git.gitCherryPickQuit"></a> <h4>Git.gitCherryPickQuit</h4> <b>gitCherryPickQuit</b>(<i>projectDir</i>) - <p> Public method to quit the current copying operation. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1307,10 +1305,10 @@ <a NAME="Git.gitCommitMerge" ID="Git.gitCommitMerge"></a> <h4>Git.gitCommitMerge</h4> <b>gitCommitMerge</b>(<i>name</i>) - <p> Public method to commit a failed merge. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1321,10 +1319,10 @@ <a NAME="Git.gitCopy" ID="Git.gitCopy"></a> <h4>Git.gitCopy</h4> <b>gitCopy</b>(<i>name, project</i>) - <p> Public method used to copy a file/directory. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1351,10 +1349,10 @@ <a NAME="Git.gitCreateArchive" ID="Git.gitCreateArchive"></a> <h4>Git.gitCreateArchive</h4> <b>gitCreateArchive</b>(<i>projectDir</i>) - <p> Public method to show some statistics of the local repository. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1365,10 +1363,10 @@ <a NAME="Git.gitCreateIgnoreFile" ID="Git.gitCreateIgnoreFile"></a> <h4>Git.gitCreateIgnoreFile</h4> <b>gitCreateIgnoreFile</b>(<i>name, autoAdd=False</i>) - <p> Public method to create the ignore file. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1395,10 +1393,10 @@ <a NAME="Git.gitDeleteRemoteBranch" ID="Git.gitDeleteRemoteBranch"></a> <h4>Git.gitDeleteRemoteBranch</h4> <b>gitDeleteRemoteBranch</b>(<i>name</i>) - <p> Public method to delete a branch from a remote repository. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1409,10 +1407,10 @@ <a NAME="Git.gitDescribe" ID="Git.gitDescribe"></a> <h4>Git.gitDescribe</h4> <b>gitDescribe</b>(<i>projectDir, commits</i>) - <p> Public method to find the most recent tag reachable from each commit. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1427,10 +1425,10 @@ <a NAME="Git.gitEditConfig" ID="Git.gitEditConfig"></a> <h4>Git.gitEditConfig</h4> <b>gitEditConfig</b>(<i>projectDir</i>) - <p> Public method used to edit the repository configuration file. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1441,14 +1439,13 @@ <a NAME="Git.gitEditUserConfig" ID="Git.gitEditUserConfig"></a> <h4>Git.gitEditUserConfig</h4> <b>gitEditUserConfig</b>(<i></i>) - <p> Public method used to edit the user configuration file. </p> + <a NAME="Git.gitExtendedDiff" ID="Git.gitExtendedDiff"></a> <h4>Git.gitExtendedDiff</h4> <b>gitExtendedDiff</b>(<i>name</i>) - <p> Public method used to view the difference of a file/directory to the Git repository. @@ -1462,6 +1459,7 @@ <p> This method gives the chance to enter the revisions to be compared. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1472,10 +1470,10 @@ <a NAME="Git.gitFetch" ID="Git.gitFetch"></a> <h4>Git.gitFetch</h4> <b>gitFetch</b>(<i>name</i>) - <p> Public method to fetch changes from a remote repository. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1486,10 +1484,10 @@ <a NAME="Git.gitGetArchiveFormats" ID="Git.gitGetArchiveFormats"></a> <h4>Git.gitGetArchiveFormats</h4> <b>gitGetArchiveFormats</b>(<i>repodir</i>) - <p> Public method to get a list of supported archive formats. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -1512,10 +1510,10 @@ <a NAME="Git.gitGetBranchesList" ID="Git.gitGetBranchesList"></a> <h4>Git.gitGetBranchesList</h4> <b>gitGetBranchesList</b>(<i>repodir, withMain=False, allBranches=False, remotes=False</i>) - <p> Public method to get the list of branches. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -1550,10 +1548,10 @@ <a NAME="Git.gitGetBundleHeads" ID="Git.gitGetBundleHeads"></a> <h4>Git.gitGetBundleHeads</h4> <b>gitGetBundleHeads</b>(<i>repodir, bundleFile</i>) - <p> Public method to get a list of heads contained in a bundle file. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -1580,10 +1578,10 @@ <a NAME="Git.gitGetCurrentBranch" ID="Git.gitGetCurrentBranch"></a> <h4>Git.gitGetCurrentBranch</h4> <b>gitGetCurrentBranch</b>(<i>repodir</i>) - <p> Public method used to show the current branch of the working directory. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -1606,10 +1604,10 @@ <a NAME="Git.gitGetRemoteBranchesList" ID="Git.gitGetRemoteBranchesList"></a> <h4>Git.gitGetRemoteBranchesList</h4> <b>gitGetRemoteBranchesList</b>(<i>repodir, remote</i>) - <p> Public method to get the list of a remote repository branches. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -1636,10 +1634,10 @@ <a NAME="Git.gitGetRemoteUrl" ID="Git.gitGetRemoteUrl"></a> <h4>Git.gitGetRemoteUrl</h4> <b>gitGetRemoteUrl</b>(<i>repodir, remoteName</i>) - <p> Public method to get the URL of a remote repository. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -1666,10 +1664,10 @@ <a NAME="Git.gitGetRemoteUrlsList" ID="Git.gitGetRemoteUrlsList"></a> <h4>Git.gitGetRemoteUrlsList</h4> <b>gitGetRemoteUrlsList</b>(<i>repodir, forFetch=True</i>) - <p> Public method to get the list of remote repos and their URLs. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -1696,10 +1694,10 @@ <a NAME="Git.gitGetRemotesList" ID="Git.gitGetRemotesList"></a> <h4>Git.gitGetRemotesList</h4> <b>gitGetRemotesList</b>(<i>repodir</i>) - <p> Public method to get the list of remote repos. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -1722,10 +1720,10 @@ <a NAME="Git.gitGetTagsList" ID="Git.gitGetTagsList"></a> <h4>Git.gitGetTagsList</h4> <b>gitGetTagsList</b>(<i>repodir</i>) - <p> Public method to get the list of tags. </p> + <dl> <dt><i>repodir</i> (str)</dt> @@ -1749,10 +1747,10 @@ <a NAME="Git.gitHouseKeeping" ID="Git.gitHouseKeeping"></a> <h4>Git.gitHouseKeeping</h4> <b>gitHouseKeeping</b>(<i>projectDir</i>) - <p> Public method to cleanup and optimize the local repository. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1763,10 +1761,10 @@ <a NAME="Git.gitListTagBranch" ID="Git.gitListTagBranch"></a> <h4>Git.gitListTagBranch</h4> <b>gitListTagBranch</b>(<i>path, tags=True, listAll=True, merged=True</i>) - <p> Public method used to list the available tags or branches. </p> + <dl> <dt><i>path</i> (str)</dt> @@ -1790,10 +1788,10 @@ <a NAME="Git.gitNormalizeURL" ID="Git.gitNormalizeURL"></a> <h4>Git.gitNormalizeURL</h4> <b>gitNormalizeURL</b>(<i>url</i>) - <p> Public method to normalize a url for Git. </p> + <dl> <dt><i>url</i> (str)</dt> @@ -1816,10 +1814,10 @@ <a NAME="Git.gitPruneRemote" ID="Git.gitPruneRemote"></a> <h4>Git.gitPruneRemote</h4> <b>gitPruneRemote</b>(<i>projectDir, remoteName</i>) - <p> Public method to prune stale remote-tracking branches. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1834,10 +1832,10 @@ <a NAME="Git.gitPull" ID="Git.gitPull"></a> <h4>Git.gitPull</h4> <b>gitPull</b>(<i>name</i>) - <p> Public method used to pull changes from a remote Git repository. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1860,10 +1858,10 @@ <a NAME="Git.gitPush" ID="Git.gitPush"></a> <h4>Git.gitPush</h4> <b>gitPush</b>(<i>name</i>) - <p> Public method used to push changes to a remote Git repository. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1874,10 +1872,10 @@ <a NAME="Git.gitReflogBrowser" ID="Git.gitReflogBrowser"></a> <h4>Git.gitReflogBrowser</h4> <b>gitReflogBrowser</b>(<i>projectDir</i>) - <p> Public method used to browse the reflog of the project. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1888,10 +1886,10 @@ <a NAME="Git.gitRemoveRemote" ID="Git.gitRemoveRemote"></a> <h4>Git.gitRemoveRemote</h4> <b>gitRemoveRemote</b>(<i>projectDir, remoteName</i>) - <p> Public method to remove a remote repository. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1906,10 +1904,10 @@ <a NAME="Git.gitRenameRemote" ID="Git.gitRenameRemote"></a> <h4>Git.gitRenameRemote</h4> <b>gitRenameRemote</b>(<i>projectDir, remoteName</i>) - <p> Public method to rename a remote repository. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1924,11 +1922,11 @@ <a NAME="Git.gitShortlog" ID="Git.gitShortlog"></a> <h4>Git.gitShortlog</h4> <b>gitShortlog</b>(<i>projectDir, commit</i>) - <p> Public method to show a short log suitable for inclusion in release announcements. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1943,10 +1941,10 @@ <a NAME="Git.gitShowBranch" ID="Git.gitShowBranch"></a> <h4>Git.gitShowBranch</h4> <b>gitShowBranch</b>(<i>name</i>) - <p> Public method used to show the current branch of the working directory. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -1957,10 +1955,10 @@ <a NAME="Git.gitShowConfig" ID="Git.gitShowConfig"></a> <h4>Git.gitShowConfig</h4> <b>gitShowConfig</b>(<i>projectDir</i>) - <p> Public method to show the combined configuration. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1971,10 +1969,10 @@ <a NAME="Git.gitShowPatchesStatistics" ID="Git.gitShowPatchesStatistics"></a> <h4>Git.gitShowPatchesStatistics</h4> <b>gitShowPatchesStatistics</b>(<i>projectDir</i>) - <p> Public method to show statistics for a set of patch files. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -1985,10 +1983,10 @@ <a NAME="Git.gitShowRemote" ID="Git.gitShowRemote"></a> <h4>Git.gitShowRemote</h4> <b>gitShowRemote</b>(<i>projectDir, remoteName</i>) - <p> Public method to show information about a remote repository. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2003,10 +2001,10 @@ <a NAME="Git.gitShowRemotes" ID="Git.gitShowRemotes"></a> <h4>Git.gitShowRemotes</h4> <b>gitShowRemotes</b>(<i>projectDir</i>) - <p> Public method to show available remote repositories. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2017,10 +2015,10 @@ <a NAME="Git.gitStashApply" ID="Git.gitStashApply"></a> <h4>Git.gitStashApply</h4> <b>gitStashApply</b>(<i>projectDir, stashName=""</i>) - <p> Public method to apply a stash but keep it. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2047,10 +2045,10 @@ <a NAME="Git.gitStashBranch" ID="Git.gitStashBranch"></a> <h4>Git.gitStashBranch</h4> <b>gitStashBranch</b>(<i>projectDir, stashName=""</i>) - <p> Public method to create a branch from a stash. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2077,10 +2075,10 @@ <a NAME="Git.gitStashBrowser" ID="Git.gitStashBrowser"></a> <h4>Git.gitStashBrowser</h4> <b>gitStashBrowser</b>(<i>projectDir</i>) - <p> Public method used to browse the stashed changes. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2091,10 +2089,10 @@ <a NAME="Git.gitStashClear" ID="Git.gitStashClear"></a> <h4>Git.gitStashClear</h4> <b>gitStashClear</b>(<i>projectDir</i>) - <p> Public method to delete all stashes. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2117,10 +2115,10 @@ <a NAME="Git.gitStashDrop" ID="Git.gitStashDrop"></a> <h4>Git.gitStashDrop</h4> <b>gitStashDrop</b>(<i>projectDir, stashName=""</i>) - <p> Public method to delete a stash. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2147,10 +2145,10 @@ <a NAME="Git.gitStashPop" ID="Git.gitStashPop"></a> <h4>Git.gitStashPop</h4> <b>gitStashPop</b>(<i>projectDir, stashName=""</i>) - <p> Public method to apply a stash and delete it. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2177,10 +2175,10 @@ <a NAME="Git.gitStashSave" ID="Git.gitStashSave"></a> <h4>Git.gitStashSave</h4> <b>gitStashSave</b>(<i>projectDir</i>) - <p> Public method to save the current changes to a new stash. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2203,10 +2201,10 @@ <a NAME="Git.gitStashShowPatch" ID="Git.gitStashShowPatch"></a> <h4>Git.gitStashShowPatch</h4> <b>gitStashShowPatch</b>(<i>projectDir, stashName=""</i>) - <p> Public method to show the contents of a stash. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2221,10 +2219,10 @@ <a NAME="Git.gitStatistics" ID="Git.gitStatistics"></a> <h4>Git.gitStatistics</h4> <b>gitStatistics</b>(<i>projectDir</i>) - <p> Public method to show some statistics of the local repository. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2235,10 +2233,10 @@ <a NAME="Git.gitSubmoduleAdd" ID="Git.gitSubmoduleAdd"></a> <h4>Git.gitSubmoduleAdd</h4> <b>gitSubmoduleAdd</b>(<i>projectDir</i>) - <p> Public method to add a submodule to the project. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2249,10 +2247,10 @@ <a NAME="Git.gitSubmoduleDeinit" ID="Git.gitSubmoduleDeinit"></a> <h4>Git.gitSubmoduleDeinit</h4> <b>gitSubmoduleDeinit</b>(<i>projectDir</i>) - <p> Public method to unregister submodules. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2263,10 +2261,10 @@ <a NAME="Git.gitSubmoduleInit" ID="Git.gitSubmoduleInit"></a> <h4>Git.gitSubmoduleInit</h4> <b>gitSubmoduleInit</b>(<i>projectDir</i>) - <p> Public method to initialize one or all submodules. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2277,10 +2275,10 @@ <a NAME="Git.gitSubmoduleList" ID="Git.gitSubmoduleList"></a> <h4>Git.gitSubmoduleList</h4> <b>gitSubmoduleList</b>(<i>projectDir</i>) - <p> Public method to show a list of all submodules of the project. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2291,10 +2289,10 @@ <a NAME="Git.gitSubmoduleStatus" ID="Git.gitSubmoduleStatus"></a> <h4>Git.gitSubmoduleStatus</h4> <b>gitSubmoduleStatus</b>(<i>projectDir</i>) - <p> Public method to show the status of the submodules. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2305,10 +2303,10 @@ <a NAME="Git.gitSubmoduleSummary" ID="Git.gitSubmoduleSummary"></a> <h4>Git.gitSubmoduleSummary</h4> <b>gitSubmoduleSummary</b>(<i>projectDir</i>) - <p> Public method to show the status of the submodules. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2319,10 +2317,10 @@ <a NAME="Git.gitSubmoduleSync" ID="Git.gitSubmoduleSync"></a> <h4>Git.gitSubmoduleSync</h4> <b>gitSubmoduleSync</b>(<i>projectDir</i>) - <p> Public method to synchronize submodules. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2333,10 +2331,10 @@ <a NAME="Git.gitSubmoduleUpdate" ID="Git.gitSubmoduleUpdate"></a> <h4>Git.gitSubmoduleUpdate</h4> <b>gitSubmoduleUpdate</b>(<i>projectDir, initialize=False, remote=False</i>) - <p> Public method to update submodules. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2355,11 +2353,11 @@ <a NAME="Git.gitSubmoduleUpdateWithOptions" ID="Git.gitSubmoduleUpdateWithOptions"></a> <h4>Git.gitSubmoduleUpdateWithOptions</h4> <b>gitSubmoduleUpdateWithOptions</b>(<i>projectDir</i>) - <p> Public method to update submodules offering a dialog to select the update options. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2370,10 +2368,10 @@ <a NAME="Git.gitUnstage" ID="Git.gitUnstage"></a> <h4>Git.gitUnstage</h4> <b>gitUnstage</b>(<i>name</i>) - <p> Public method used to unstage a file/directory. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -2396,11 +2394,11 @@ <a NAME="Git.gitVerify" ID="Git.gitVerify"></a> <h4>Git.gitVerify</h4> <b>gitVerify</b>(<i>projectDir</i>) - <p> Public method to verify the connectivity and validity of objects of the database. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2411,10 +2409,10 @@ <a NAME="Git.gitVerifyBundle" ID="Git.gitVerifyBundle"></a> <h4>Git.gitVerifyBundle</h4> <b>gitVerifyBundle</b>(<i>projectDir</i>) - <p> Public method to verify a bundle file. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2425,10 +2423,10 @@ <a NAME="Git.gitWorktreeManagement" ID="Git.gitWorktreeManagement"></a> <h4>Git.gitWorktreeManagement</h4> <b>gitWorktreeManagement</b>(<i>projectDir</i>) - <p> Public method to show the worktree list/management dialog. </p> + <dl> <dt><i>projectDir</i> (str)</dt> @@ -2439,10 +2437,10 @@ <a NAME="Git.initCommand" ID="Git.initCommand"></a> <h4>Git.initCommand</h4> <b>initCommand</b>(<i>command</i>) - <p> Public method to initialize a command arguments list. </p> + <dl> <dt><i>command</i> (str)</dt> @@ -2465,10 +2463,10 @@ <a NAME="Git.vcsAdd" ID="Git.vcsAdd"></a> <h4>Git.vcsAdd</h4> <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) - <p> Public method used to add a file/directory to the Git repository. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -2487,11 +2485,11 @@ <a NAME="Git.vcsAddBinary" ID="Git.vcsAddBinary"></a> <h4>Git.vcsAddBinary</h4> <b>vcsAddBinary</b>(<i>name, isDir=False</i>) - <p> Public method used to add a file/directory in binary mode to the Git repository. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -2506,10 +2504,10 @@ <a NAME="Git.vcsAddCommitMessage" ID="Git.vcsAddCommitMessage"></a> <h4>Git.vcsAddCommitMessage</h4> <b>vcsAddCommitMessage</b>(<i>message</i>) - <p> Public method to add a commit message to the list of saved messages. </p> + <dl> <dt><i>message</i> (str)</dt> @@ -2520,11 +2518,11 @@ <a NAME="Git.vcsAddTree" ID="Git.vcsAddTree"></a> <h4>Git.vcsAddTree</h4> <b>vcsAddTree</b>(<i>path</i>) - <p> Public method to add a directory tree rooted at path to the Git repository. </p> + <dl> <dt><i>path</i> (str or list of str)</dt> @@ -2535,7 +2533,6 @@ <a NAME="Git.vcsAllRegisteredStates" ID="Git.vcsAllRegisteredStates"></a> <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. @@ -2545,6 +2542,7 @@ 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> (dict)</dt> @@ -2576,11 +2574,11 @@ <a NAME="Git.vcsCheckout" ID="Git.vcsCheckout"></a> <h4>Git.vcsCheckout</h4> <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) - <p> Public method used to check the project out of a Git repository (clone). </p> + <dl> <dt><i>vcsDataDict</i> (dict)</dt> @@ -2611,10 +2609,10 @@ <a NAME="Git.vcsCleanup" ID="Git.vcsCleanup"></a> <h4>Git.vcsCleanup</h4> <b>vcsCleanup</b>(<i>name</i>) - <p> Public method used to cleanup the working directory. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -2625,17 +2623,17 @@ <a NAME="Git.vcsClearCommitMessages" ID="Git.vcsClearCommitMessages"></a> <h4>Git.vcsClearCommitMessages</h4> <b>vcsClearCommitMessages</b>(<i></i>) - <p> Public method to clear the list of saved messages. </p> + <a NAME="Git.vcsCommandLine" ID="Git.vcsCommandLine"></a> <h4>Git.vcsCommandLine</h4> <b>vcsCommandLine</b>(<i>name</i>) - <p> Public method used to execute arbitrary Git commands. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -2646,11 +2644,11 @@ <a NAME="Git.vcsCommit" ID="Git.vcsCommit"></a> <h4>Git.vcsCommit</h4> <b>vcsCommit</b>(<i>name, message="", noDialog=False, commitAll=True, amend=False</i>) - <p> Public method used to make the change of a file/directory permanent in the Git repository. </p> + <dl> <dt><i>name</i> (str or list of str)</dt> @@ -2677,10 +2675,10 @@ <a NAME="Git.vcsCommitMessages" ID="Git.vcsCommitMessages"></a> <h4>Git.vcsCommitMessages</h4> <b>vcsCommitMessages</b>(<i></i>) - <p> Public method to get the list of saved commit messages. </p> + <dl> <dt>Return:</dt> <dd> @@ -2696,11 +2694,11 @@ <a NAME="Git.vcsConvertProject" ID="Git.vcsConvertProject"></a> <h4>Git.vcsConvertProject</h4> <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>) - <p> Public method to convert an uncontrolled project to a version controlled project. </p> + <dl> <dt><i>vcsDataDict</i> (dict)</dt> @@ -2719,7 +2717,6 @@ <a NAME="Git.vcsDiff" ID="Git.vcsDiff"></a> <h4>Git.vcsDiff</h4> <b>vcsDiff</b>(<i>name</i>) - <p> Public method used to view the difference of a file/directory to the Git repository. @@ -2730,6 +2727,7 @@ being edited and has unsaved modification, they can be saved or the operation may be aborted. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -2740,10 +2738,10 @@ <a NAME="Git.vcsExists" ID="Git.vcsExists"></a> <h4>Git.vcsExists</h4> <b>vcsExists</b>(<i></i>) - <p> Public method used to test for the presence of the git executable. </p> + <dl> <dt>Return:</dt> <dd> @@ -2759,10 +2757,10 @@ <a NAME="Git.vcsExport" ID="Git.vcsExport"></a> <h4>Git.vcsExport</h4> <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>) - <p> Public method used to export a directory from the Git repository. </p> + <dl> <dt><i>vcsDataDict</i> (dict)</dt> @@ -2789,13 +2787,13 @@ <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> @@ -2806,11 +2804,11 @@ <a NAME="Git.vcsGetProjectBrowserHelper" ID="Git.vcsGetProjectBrowserHelper"></a> <h4>Git.vcsGetProjectBrowserHelper</h4> <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) - <p> Public method to instantiate a helper object for the different project browsers. </p> + <dl> <dt><i>browser</i> (ProjectBaseBrowser)</dt> @@ -2842,10 +2840,10 @@ <a NAME="Git.vcsGetProjectHelper" ID="Git.vcsGetProjectHelper"></a> <h4>Git.vcsGetProjectHelper</h4> <b>vcsGetProjectHelper</b>(<i>project</i>) - <p> Public method to instantiate a helper object for the project. </p> + <dl> <dt><i>project</i> (Project)</dt> @@ -2868,10 +2866,10 @@ <a NAME="Git.vcsImport" ID="Git.vcsImport"></a> <h4>Git.vcsImport</h4> <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>) - <p> Public method used to import the project into the Git repository. </p> + <dl> <dt><i>vcsDataDict</i> (dict)</dt> @@ -2907,7 +2905,6 @@ <a NAME="Git.vcsInit" ID="Git.vcsInit"></a> <h4>Git.vcsInit</h4> <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) - <p> Public method used to initialize the Git repository. </p> @@ -2916,6 +2913,7 @@ Git controlled project. Therefore we always return TRUE without doing anything. </p> + <dl> <dt><i>vcsDir</i> (str)</dt> @@ -2942,13 +2940,13 @@ <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a> <h4>Git.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> (Project)</dt> @@ -2959,11 +2957,11 @@ <a NAME="Git.vcsLogBrowser" ID="Git.vcsLogBrowser"></a> <h4>Git.vcsLogBrowser</h4> <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) - <p> Public method used to browse the log of a file/directory from the Git repository. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -2978,10 +2976,10 @@ <a NAME="Git.vcsMerge" ID="Git.vcsMerge"></a> <h4>Git.vcsMerge</h4> <b>vcsMerge</b>(<i>name</i>) - <p> Public method used to merge a URL/revision into the local project. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -2992,10 +2990,10 @@ <a NAME="Git.vcsMove" ID="Git.vcsMove"></a> <h4>Git.vcsMove</h4> <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) - <p> Public method used to move a file/directory. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -3030,10 +3028,10 @@ <a NAME="Git.vcsName" ID="Git.vcsName"></a> <h4>Git.vcsName</h4> <b>vcsName</b>(<i></i>) - <p> Public method returning the name of the vcs. </p> + <dl> <dt>Return:</dt> <dd> @@ -3049,11 +3047,11 @@ <a NAME="Git.vcsNewProjectOptionsDialog" ID="Git.vcsNewProjectOptionsDialog"></a> <h4>Git.vcsNewProjectOptionsDialog</h4> <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) - <p> Public method to get a dialog to enter repository info for getting a new project. </p> + <dl> <dt><i>parent</i> (QWidget)</dt> @@ -3076,10 +3074,10 @@ <a NAME="Git.vcsOptionsDialog" ID="Git.vcsOptionsDialog"></a> <h4>Git.vcsOptionsDialog</h4> <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) - <p> Public method to get a dialog to enter repository info. </p> + <dl> <dt><i>project</i> (Project)</dt> @@ -3114,10 +3112,10 @@ <a NAME="Git.vcsRegisteredState" ID="Git.vcsRegisteredState"></a> <h4>Git.vcsRegisteredState</h4> <b>vcsRegisteredState</b>(<i>name</i>) - <p> Public method used to get the registered state of a file in the vcs. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -3140,7 +3138,6 @@ <a NAME="Git.vcsRemove" ID="Git.vcsRemove"></a> <h4>Git.vcsRemove</h4> <b>vcsRemove</b>(<i>name, project=False, noDialog=False, stageOnly=False</i>) - <p> Public method used to remove a file/directory from the Git repository. @@ -3148,6 +3145,7 @@ <p> The default operation is to remove the local copy as well. </p> + <dl> <dt><i>name</i> (str or list of str)</dt> @@ -3183,10 +3181,10 @@ <a NAME="Git.vcsRepositoryInfos" ID="Git.vcsRepositoryInfos"></a> <h4>Git.vcsRepositoryInfos</h4> <b>vcsRepositoryInfos</b>(<i>ppath</i>) - <p> Public method to retrieve information about the repository. </p> + <dl> <dt><i>ppath</i> (str)</dt> @@ -3209,10 +3207,10 @@ <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> @@ -3236,11 +3234,11 @@ <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> (str)</dt> @@ -3266,18 +3264,18 @@ <a NAME="Git.vcsShutdown" ID="Git.vcsShutdown"></a> <h4>Git.vcsShutdown</h4> <b>vcsShutdown</b>(<i></i>) - <p> Public method used to shutdown the Git interface. </p> + <a NAME="Git.vcsStatus" ID="Git.vcsStatus"></a> <h4>Git.vcsStatus</h4> <b>vcsStatus</b>(<i>name</i>) - <p> Public method used to view the status of files/directories in the Git repository. </p> + <dl> <dt><i>name</i> (str or list of str)</dt> @@ -3288,10 +3286,10 @@ <a NAME="Git.vcsSupportCommandOptions" ID="Git.vcsSupportCommandOptions"></a> <h4>Git.vcsSupportCommandOptions</h4> <b>vcsSupportCommandOptions</b>(<i></i>) - <p> Public method to signal the support of user settable command options. </p> + <dl> <dt>Return:</dt> <dd> @@ -3307,11 +3305,11 @@ <a NAME="Git.vcsSwitch" ID="Git.vcsSwitch"></a> <h4>Git.vcsSwitch</h4> <b>vcsSwitch</b>(<i>name</i>) - <p> Public method used to switch a working directory to a different revision. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -3334,10 +3332,10 @@ <a NAME="Git.vcsTag" ID="Git.vcsTag"></a> <h4>Git.vcsTag</h4> <b>vcsTag</b>(<i>name, revision=None, tagName=None</i>) - <p> Public method used to set/remove a tag in the Git repository. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -3368,11 +3366,11 @@ <a NAME="Git.vcsUpdate" ID="Git.vcsUpdate"></a> <h4>Git.vcsUpdate</h4> <b>vcsUpdate</b>(<i>name, noDialog=False, revision=None</i>) - <p> Public method used to update a file/directory with the Git repository. </p> + <dl> <dt><i>name</i> (str or list of str)</dt> @@ -3402,4 +3400,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>