eric: Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.git.html@baf6da1ae288 (annotated)

 <!DOCTYPE html>
 <html><head>
 <title>eric6.Plugins.VcsPlugins.vcsGit.git</title>
 <meta charset="UTF-8">
 <style>
 body {
     background: #EDECE6;
     margin: 0em 1em 10em 1em;
     color: black;
 }
 h1 { color: white; background: #85774A; }
 h2 { color: white; background: #85774A; }
 h3 { color: white; background: #9D936E; }
 h4 { color: white; background: #9D936E; }
 a { color: #BA6D36; }
 </style>
 </head>
 <body><a NAME="top" ID="top"></a>
 <h1>eric6.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>
 <dt>committed()</dt>
 <dd>
 emitted after the commit action has completed
 </dd>
 </dl>
 <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>
 </tr><tr>
 <td><a href="#Git.__gitGetFileForRevision">__gitGetFileForRevision</a></td>
 <td>Private method to get a file for a specific revision from the repository.</td>
 </tr><tr>
 <td><a href="#Git.__gitGetStashesList">__gitGetStashesList</a></td>
 <td>Private method to get a list of stash names.</td>
 </tr><tr>
 <td><a href="#Git.__gitSubmodulesList">__gitSubmodulesList</a></td>
 <td>Private method to get the data of defined submodules.</td>
 </tr><tr>
 <td><a href="#Git.__selectSubmodulePath">__selectSubmodulePath</a></td>
 <td>Private method to select a submodule path.</td>
 </tr><tr>
 <td><a href="#Git.__selectSubmodulePaths">__selectSubmodulePaths</a></td>
 <td>Private method to select a list of submodule paths.</td>
 </tr><tr>
 <td><a href="#Git.__vcsCommit_Step2">__vcsCommit_Step2</a></td>
 <td>Private slot performing the second step of the commit action.</td>
 </tr><tr>
 <td><a href="#Git._createStatusMonitorThread">_createStatusMonitorThread</a></td>
 <td>Protected method to create an instance of the VCS status monitor thread.</td>
 </tr><tr>
 <td><a href="#Git.clearStatusCache">clearStatusCache</a></td>
 <td>Public method to clear the status cache.</td>
 </tr><tr>
 <td><a href="#Git.getPlugin">getPlugin</a></td>
 <td>Public method to get a reference to the plugin object.</td>
 </tr><tr>
 <td><a href="#Git.gitAddRemote">gitAddRemote</a></td>
 <td>Public method to add a remote repository.</td>
 </tr><tr>
 <td><a href="#Git.gitApply">gitApply</a></td>
 <td>Public method to apply a patch stored in a given file.</td>
 </tr><tr>
 <td><a href="#Git.gitApplyCheckPatches">gitApplyCheckPatches</a></td>
 <td>Public method to apply a list of patch files or check, if they would apply cleanly.</td>
 </tr><tr>
 <td><a href="#Git.gitBisect">gitBisect</a></td>
 <td>Public method to perform bisect commands.</td>
 </tr><tr>
 <td><a href="#Git.gitBisectCreateReplayFile">gitBisectCreateReplayFile</a></td>
 <td>Public method used to create a bisect replay file for the project.</td>
 </tr><tr>
 <td><a href="#Git.gitBisectEditReplayFile">gitBisectEditReplayFile</a></td>
 <td>Public method used to edit a bisect replay file.</td>
 </tr><tr>
 <td><a href="#Git.gitBisectLogBrowser">gitBisectLogBrowser</a></td>
 <td>Public method used to browse the bisect log of the project.</td>
 </tr><tr>
 <td><a href="#Git.gitBisectReplay">gitBisectReplay</a></td>
 <td>Public method to replay a bisect session.</td>
 </tr><tr>
 <td><a href="#Git.gitBlame">gitBlame</a></td>
 <td>Public method to show the output of the git blame command.</td>
 </tr><tr>
 <td><a href="#Git.gitBranch">gitBranch</a></td>
 <td>Public method used to create, delete or move a branch in the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.gitBundle">gitBundle</a></td>
 <td>Public method to create a bundle file.</td>
 </tr><tr>
 <td><a href="#Git.gitBundleFetch">gitBundleFetch</a></td>
 <td>Public method to fetch a head of a bundle file into the local repository.</td>
 </tr><tr>
 <td><a href="#Git.gitBundleListHeads">gitBundleListHeads</a></td>
 <td>Public method to list the heads contained in a bundle file.</td>
 </tr><tr>
 <td><a href="#Git.gitBundlePull">gitBundlePull</a></td>
 <td>Public method to pull a head of a bundle file into the local repository and working area.</td>
 </tr><tr>
 <td><a href="#Git.gitCancelMerge">gitCancelMerge</a></td>
 <td>Public method to cancel an uncommitted or failed merge.</td>
 </tr><tr>
 <td><a href="#Git.gitCherryPick">gitCherryPick</a></td>
 <td>Public method to cherry pick commits and apply them to the current branch.</td>
 </tr><tr>
 <td><a href="#Git.gitCherryPickAbort">gitCherryPickAbort</a></td>
 <td>Public method to cancel the last copying session and return to the previous state.</td>
 </tr><tr>
 <td><a href="#Git.gitCherryPickContinue">gitCherryPickContinue</a></td>
 <td>Public method to continue the last copying session after conflicts were resolved.</td>
 </tr><tr>
 <td><a href="#Git.gitCherryPickQuit">gitCherryPickQuit</a></td>
 <td>Public method to quit the current copying operation.</td>
 </tr><tr>
 <td><a href="#Git.gitCommitMerge">gitCommitMerge</a></td>
 <td>Public method to commit a failed merge.</td>
 </tr><tr>
 <td><a href="#Git.gitCopy">gitCopy</a></td>
 <td>Public method used to copy a file/directory.</td>
 </tr><tr>
 <td><a href="#Git.gitCreateArchive">gitCreateArchive</a></td>
 <td>Public method to show some statistics of the local repository.</td>
 </tr><tr>
 <td><a href="#Git.gitCreateIgnoreFile">gitCreateIgnoreFile</a></td>
 <td>Public method to create the ignore file.</td>
 </tr><tr>
 <td><a href="#Git.gitDeleteRemoteBranch">gitDeleteRemoteBranch</a></td>
 <td>Public method to delete a branch from a remote repository.</td>
 </tr><tr>
 <td><a href="#Git.gitDescribe">gitDescribe</a></td>
 <td>Public method to find the most recent tag reachable from each commit.</td>
 </tr><tr>
 <td><a href="#Git.gitEditConfig">gitEditConfig</a></td>
 <td>Public method used to edit the repository configuration file.</td>
 </tr><tr>
 <td><a href="#Git.gitEditUserConfig">gitEditUserConfig</a></td>
 <td>Public method used to edit the user configuration file.</td>
 </tr><tr>
 <td><a href="#Git.gitExtendedDiff">gitExtendedDiff</a></td>
 <td>Public method used to view the difference of a file/directory to the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.gitFetch">gitFetch</a></td>
 <td>Public method to fetch changes from a remote repository.</td>
 </tr><tr>
 <td><a href="#Git.gitGetArchiveFormats">gitGetArchiveFormats</a></td>
 <td>Public method to get a list of supported archive formats.</td>
 </tr><tr>
 <td><a href="#Git.gitGetBranchesList">gitGetBranchesList</a></td>
 <td>Public method to get the list of branches.</td>
 </tr><tr>
 <td><a href="#Git.gitGetBundleHeads">gitGetBundleHeads</a></td>
 <td>Public method to get a list of heads contained in a bundle file.</td>
 </tr><tr>
 <td><a href="#Git.gitGetCurrentBranch">gitGetCurrentBranch</a></td>
 <td>Public method used to show the current branch of the working directory.</td>
 </tr><tr>
 <td><a href="#Git.gitGetRemoteBranchesList">gitGetRemoteBranchesList</a></td>
 <td>Public method to get the list of a remote repository branches.</td>
 </tr><tr>
 <td><a href="#Git.gitGetRemoteUrlsList">gitGetRemoteUrlsList</a></td>
 <td>Public method to get the list of remote repos and their URLs.</td>
 </tr><tr>
 <td><a href="#Git.gitGetRemotesList">gitGetRemotesList</a></td>
 <td>Public method to get the list of remote repos.</td>
 </tr><tr>
 <td><a href="#Git.gitGetTagsList">gitGetTagsList</a></td>
 <td>Public method to get the list of tags.</td>
 </tr><tr>
 <td><a href="#Git.gitHouseKeeping">gitHouseKeeping</a></td>
 <td>Public method to cleanup and optimize the local repository.</td>
 </tr><tr>
 <td><a href="#Git.gitListTagBranch">gitListTagBranch</a></td>
 <td>Public method used to list the available tags or branches.</td>
 </tr><tr>
 <td><a href="#Git.gitNormalizeURL">gitNormalizeURL</a></td>
 <td>Public method to normalize a url for Git.</td>
 </tr><tr>
 <td><a href="#Git.gitPruneRemote">gitPruneRemote</a></td>
 <td>Public method to prune stale remote-tracking branches.</td>
 </tr><tr>
 <td><a href="#Git.gitPull">gitPull</a></td>
 <td>Public method used to pull changes from a remote Git repository.</td>
 </tr><tr>
 <td><a href="#Git.gitPush">gitPush</a></td>
 <td>Public method used to push changes to a remote Git repository.</td>
 </tr><tr>
 <td><a href="#Git.gitReflogBrowser">gitReflogBrowser</a></td>
 <td>Public method used to browse the reflog of the project.</td>
 </tr><tr>
 <td><a href="#Git.gitRemoveRemote">gitRemoveRemote</a></td>
 <td>Public method to remove a remote repository.</td>
 </tr><tr>
 <td><a href="#Git.gitRenameRemote">gitRenameRemote</a></td>
 <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><tr>
 <td><a href="#Git.gitShowBranch">gitShowBranch</a></td>
 <td>Public method used to show the current branch of the working directory.</td>
 </tr><tr>
 <td><a href="#Git.gitShowConfig">gitShowConfig</a></td>
 <td>Public method to show the combined configuration.</td>
 </tr><tr>
 <td><a href="#Git.gitShowPatchesStatistics">gitShowPatchesStatistics</a></td>
 <td>Public method to show statistics for a set of patch files.</td>
 </tr><tr>
 <td><a href="#Git.gitShowRemote">gitShowRemote</a></td>
 <td>Public method to show information about a remote repository.</td>
 </tr><tr>
 <td><a href="#Git.gitShowRemotes">gitShowRemotes</a></td>
 <td>Public method to show available remote repositories.</td>
 </tr><tr>
 <td><a href="#Git.gitStashApply">gitStashApply</a></td>
 <td>Public method to apply a stash but keep it.</td>
 </tr><tr>
 <td><a href="#Git.gitStashBranch">gitStashBranch</a></td>
 <td>Public method to create a branch from a stash.</td>
 </tr><tr>
 <td><a href="#Git.gitStashBrowser">gitStashBrowser</a></td>
 <td>Public method used to browse the stashed changes.</td>
 </tr><tr>
 <td><a href="#Git.gitStashClear">gitStashClear</a></td>
 <td>Public method to delete all stashes.</td>
 </tr><tr>
 <td><a href="#Git.gitStashDrop">gitStashDrop</a></td>
 <td>Public method to delete a stash.</td>
 </tr><tr>
 <td><a href="#Git.gitStashPop">gitStashPop</a></td>
 <td>Public method to apply a stash and delete it.</td>
 </tr><tr>
 <td><a href="#Git.gitStashSave">gitStashSave</a></td>
 <td>Public method to save the current changes to a new stash.</td>
 </tr><tr>
 <td><a href="#Git.gitStashShowPatch">gitStashShowPatch</a></td>
 <td>Public method to show the contents of a stash.</td>
 </tr><tr>
 <td><a href="#Git.gitStatistics">gitStatistics</a></td>
 <td>Public method to show some statistics of the local repository.</td>
 </tr><tr>
 <td><a href="#Git.gitSubmoduleAdd">gitSubmoduleAdd</a></td>
 <td>Public method to add a submodule to the project.</td>
 </tr><tr>
 <td><a href="#Git.gitSubmoduleDeinit">gitSubmoduleDeinit</a></td>
 <td>Public method to unregister submodules.</td>
 </tr><tr>
 <td><a href="#Git.gitSubmoduleInit">gitSubmoduleInit</a></td>
 <td>Public method to initialize one or all submodules.</td>
 </tr><tr>
 <td><a href="#Git.gitSubmoduleList">gitSubmoduleList</a></td>
 <td>Public method to show a list of all submodules of the project.</td>
 </tr><tr>
 <td><a href="#Git.gitSubmoduleStatus">gitSubmoduleStatus</a></td>
 <td>Public method to show the status of the submodules.</td>
 </tr><tr>
 <td><a href="#Git.gitSubmoduleSummary">gitSubmoduleSummary</a></td>
 <td>Public method to show the status of the submodules.</td>
 </tr><tr>
 <td><a href="#Git.gitSubmoduleSync">gitSubmoduleSync</a></td>
 <td>Public method to synchronize submodules.</td>
 </tr><tr>
 <td><a href="#Git.gitSubmoduleUpdate">gitSubmoduleUpdate</a></td>
 <td>Public method to update submodules.</td>
 </tr><tr>
 <td><a href="#Git.gitSubmoduleUpdateWithOptions">gitSubmoduleUpdateWithOptions</a></td>
 <td>Public method to update submodules offering a dialog to select the update options.</td>
 </tr><tr>
 <td><a href="#Git.gitUnstage">gitUnstage</a></td>
 <td>Public method used to unstage a file/directory.</td>
 </tr><tr>
 <td><a href="#Git.gitVerify">gitVerify</a></td>
 <td>Public method to verify the connectivity and validity of objects of the database.</td>
 </tr><tr>
 <td><a href="#Git.gitVerifyBundle">gitVerifyBundle</a></td>
 <td>Public method to verify a bundle file.</td>
 </tr><tr>
 <td><a href="#Git.initCommand">initCommand</a></td>
 <td>Public method to initialize a command arguments list.</td>
 </tr><tr>
 <td><a href="#Git.vcsAdd">vcsAdd</a></td>
 <td>Public method used to add a file/directory to the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsAddBinary">vcsAddBinary</a></td>
 <td>Public method used to add a file/directory in binary mode to the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsAddTree">vcsAddTree</a></td>
 <td>Public method to add a directory tree rooted at path to the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsAllRegisteredStates">vcsAllRegisteredStates</a></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>
 <td>Public method used to check the project out of a Git repository (clone).</td>
 </tr><tr>
 <td><a href="#Git.vcsCleanup">vcsCleanup</a></td>
 <td>Public method used to cleanup the working directory.</td>
 </tr><tr>
 <td><a href="#Git.vcsCommandLine">vcsCommandLine</a></td>
 <td>Public method used to execute arbitrary Git commands.</td>
 </tr><tr>
 <td><a href="#Git.vcsCommit">vcsCommit</a></td>
 <td>Public method used to make the change of a file/directory permanent in the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsConvertProject">vcsConvertProject</a></td>
 <td>Public method to convert an uncontrolled project to a version controlled project.</td>
 </tr><tr>
 <td><a href="#Git.vcsDiff">vcsDiff</a></td>
 <td>Public method used to view the difference of a file/directory to the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsExists">vcsExists</a></td>
 <td>Public method used to test for the presence of the git executable.</td>
 </tr><tr>
 <td><a href="#Git.vcsExport">vcsExport</a></td>
 <td>Public method used to export a directory from the Git 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><tr>
 <td><a href="#Git.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
 <td>Public method to instantiate a helper object for the project.</td>
 </tr><tr>
 <td><a href="#Git.vcsImport">vcsImport</a></td>
 <td>Public method used to import the project into the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsInit">vcsInit</a></td>
 <td>Public method used to initialize the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsInitConfig">vcsInitConfig</a></td>
 <td>Public method to initialize the VCS configuration.</td>
 </tr><tr>
 <td><a href="#Git.vcsLogBrowser">vcsLogBrowser</a></td>
 <td>Public method used to browse the log of a file/directory from the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsMerge">vcsMerge</a></td>
 <td>Public method used to merge a URL/revision into the local project.</td>
 </tr><tr>
 <td><a href="#Git.vcsMove">vcsMove</a></td>
 <td>Public method used to move a file/directory.</td>
 </tr><tr>
 <td><a href="#Git.vcsName">vcsName</a></td>
 <td>Public method returning the name of the vcs.</td>
 </tr><tr>
 <td><a href="#Git.vcsNewProjectOptionsDialog">vcsNewProjectOptionsDialog</a></td>
 <td>Public method to get a dialog to enter repository info for getting a new project.</td>
 </tr><tr>
 <td><a href="#Git.vcsOptionsDialog">vcsOptionsDialog</a></td>
 <td>Public method to get a dialog to enter repository info.</td>
 </tr><tr>
 <td><a href="#Git.vcsRegisteredState">vcsRegisteredState</a></td>
 <td>Public method used to get the registered state of a file in the vcs.</td>
 </tr><tr>
 <td><a href="#Git.vcsRemove">vcsRemove</a></td>
 <td>Public method used to remove a file/directory from the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
 <td>Public method to retrieve information about the repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsShutdown">vcsShutdown</a></td>
 <td>Public method used to shutdown the Git interface.</td>
 </tr><tr>
 <td><a href="#Git.vcsStatus">vcsStatus</a></td>
 <td>Public method used to view the status of files/directories in the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsSupportCommandOptions">vcsSupportCommandOptions</a></td>
 <td>Public method to signal the support of user settable command options.</td>
 </tr><tr>
 <td><a href="#Git.vcsSwitch">vcsSwitch</a></td>
 <td>Public method used to switch a working directory to a different revision.</td>
 </tr><tr>
 <td><a href="#Git.vcsTag">vcsTag</a></td>
 <td>Public method used to set/remove a tag in the Git repository.</td>
 </tr><tr>
 <td><a href="#Git.vcsUpdate">vcsUpdate</a></td>
 <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></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)
 </dd>
 </dl><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></dt>
 <dd>
 file name to get from the repository (string)
 </dd><dt><i>rev=</i></dt>
 <dd>
 revision to retrieve (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 contents of the file (string) and an error message (string)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 list of available stashes (list of string)
 </dd>
 </dl><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>
 <dd>
 name of the directory containing the repo subdirectory
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 list of dictionaries with submodule name, path, URL and branch
 </dd>
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
 list of dict
 </dd>
 </dl><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>
 <dd>
 name of the directory containing the repo subdirectory
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 tuple of selected submodule path and flag indicating
             a cancellation
 </dd>
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
 tuple of (str, bool)
 </dd>
 </dl><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>
 <dd>
 name of the directory containing the repo subdirectory
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 tuple of selected submodule paths and flag indicating
             a cancellation
 </dd>
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
 tuple of (list of str, bool)
 </dd>
 </dl><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></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>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 reference to the monitor thread (QThread)
 </dd>
 </dl><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.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>Returns:</dt>
 <dd>
 reference to the plugin object (VcsGitPlugin)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><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></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>
 <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>
 </dl><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></dt>
 <dd>
 directory name of the project (string)
 </dd><dt><i>check</i></dt>
 <dd>
 flag indicating to perform a check operation (boolean)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd><dt><i>subcommand</i></dt>
 <dd>
 name of the subcommand (string, one of 'start',
             'start_extended', 'good', 'bad', 'skip' or 'reset')
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating, that the update contained an add
             or delete (boolean)
 </dd>
 </dl><dl>
 <dt>Raises <b>ValueError</b>:</dt>
 <dd>
 raised to indicate an invalid bisect subcommand
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating, that the update contained an add
             or delete (boolean)
 </dd>
 </dl><a NAME="Git.gitBlame" ID="Git.gitBlame"></a>
 <h4>Git.gitBlame</h4>
 <b>gitBlame</b>(<i>name</i>)
 <p>
         Public method to show the output of the git blame command.
 </p><dl>
 <dt><i>name</i></dt>
 <dd>
 file name to show the annotations for (string)
 </dd>
 </dl><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></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)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a performed branch action (boolean) and
             a flag indicating, that the branch operation contained an add
             or delete (boolean)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating, that the update contained an add
             or delete (boolean)
 </dd>
 </dl><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></dt>
 <dd>
 file/directory name (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating, that the cancellation contained an add
             or delete (boolean)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd><dt><i>commits</i></dt>
 <dd>
 list of commits to be applied (list of strings)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating that the project should be reread (boolean)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating that the project should be reread (boolean)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating that the project should be reread (boolean)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating that the project should be reread (boolean)
 </dd>
 </dl><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></dt>
 <dd>
 file/directory name (string)
 </dd>
 </dl><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></dt>
 <dd>
 file/directory name to be copied (string)
 </dd><dt><i>project</i></dt>
 <dd>
 reference to the project object
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating successful operation (boolean)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><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></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)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating success
 </dd>
 </dl><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></dt>
 <dd>
 file/directory name (string)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd><dt><i>commits</i></dt>
 <dd>
 list of commits to start the search from
             (list of strings)
 </dd>
 </dl><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></dt>
 <dd>
 name of the project directory (string)
 </dd>
 </dl><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.
 </p><p>
         If name is a directory and is the project directory, all project files
         are saved first. If name is a file (or list of files), which is/are
         being edited and has unsaved modification, they can be saved or the
         operation may be aborted.
 </p><p>
         This method gives the chance to enter the revisions to be compared.
 </p><dl>
 <dt><i>name</i></dt>
 <dd>
 file/directory name to be diffed (string)
 </dd>
 </dl><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></dt>
 <dd>
 directory name (string)
 </dd>
 </dl><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></dt>
 <dd>
 directory name of the repository (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 list of supported archive formats (list of strings)
 </dd>
 </dl><a NAME="Git.gitGetBranchesList" ID="Git.gitGetBranchesList"></a>
 <h4>Git.gitGetBranchesList</h4>
 <b>gitGetBranchesList</b>(<i>repodir, withMaster=False, allBranches=False, remotes=False</i>)
 <p>
         Public method to get the list of branches.
 </p><dl>
 <dt><i>repodir</i></dt>
 <dd>
 directory name of the repository (string)
 </dd><dt><i>withMaster</i></dt>
 <dd>
 flag indicating to get 'master' 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)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 list of branches (list of string)
 </dd>
 </dl><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></dt>
 <dd>
 directory name of the repository (string)
 </dd><dt><i>bundleFile</i></dt>
 <dd>
 file name of a git bundle file (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 list of heads (list of strings)
 baf6da1ae288
Added the git plug-in to the core plug-ins.

Detlev Offenbach <detlev@die-offenbachs.de>

Mercurial Repositories > eric / annotate

Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.git.html@baf6da1ae288 (annotated)

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