--- a/src/eric7/Documentation/Source/eric7.VCS.VersionControl.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.VCS.VersionControl.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,35 +7,33 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.VCS.VersionControl</h1>
-
<p>
Module implementing an abstract base class to be subclassed by all specific
VCS interfaces.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#VersionControl">VersionControl</a></td>
<td>Class implementing an abstract base class to be subclassed by all specific VCS interfaces.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="VersionControl" ID="VersionControl"></a>
<h2>VersionControl</h2>
-
<p>
Class implementing an abstract base class to be subclassed by all specific
VCS interfaces.
@@ -44,6 +42,7 @@
It defines the vcs interface to be implemented by subclasses
and the common methods.
</p>
+
<h3>Signals</h3>
<dl>
@@ -79,19 +78,20 @@
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
+<table>
+<tr><td>canBeAdded</td></tr>
+<tr><td>canBeCommitted</td></tr>
+<tr><td>commitHistoryData</td></tr>
+<tr><td>commitHistoryLock</td></tr>
+</table>
-<table>
-<tr><td>canBeAdded</td></tr><tr><td>canBeCommitted</td></tr><tr><td>commitHistoryData</td></tr><tr><td>commitHistoryLock</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#VersionControl.__init__">VersionControl</a></td>
<td>Constructor</td>
@@ -361,19 +361,20 @@
<td>Public method used to update a file/directory in the vcs.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VersionControl.__init__" ID="VersionControl.__init__"></a>
<h4>VersionControl (Constructor)</h4>
<b>VersionControl</b>(<i>parent=None, name=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -388,13 +389,13 @@
<a NAME="VersionControl.__statusMonitorAllData" ID="VersionControl.__statusMonitorAllData"></a>
<h4>VersionControl.__statusMonitorAllData</h4>
<b>__statusMonitorAllData</b>(<i>statusDict</i>)
-
<p>
Private method to receive all status monitor data.
</p>
<p>
It simply re-emits the received status list.
</p>
+
<dl>
<dt><i>statusDict</i> (dict)</dt>
@@ -405,13 +406,13 @@
<a NAME="VersionControl.__statusMonitorData" ID="VersionControl.__statusMonitorData"></a>
<h4>VersionControl.__statusMonitorData</h4>
<b>__statusMonitorData</b>(<i>statusList</i>)
-
<p>
Private method to receive the status monitor data update.
</p>
<p>
It simply re-emits the received status list.
</p>
+
<dl>
<dt><i>statusList</i> (list of str)</dt>
@@ -422,13 +423,13 @@
<a NAME="VersionControl.__statusMonitorInfo" ID="VersionControl.__statusMonitorInfo"></a>
<h4>VersionControl.__statusMonitorInfo</h4>
<b>__statusMonitorInfo</b>(<i>info</i>)
-
<p>
Private slot to receive the status monitor info message.
</p>
<p>
It simply re-emits the received info message.
</p>
+
<dl>
<dt><i>info</i> (str)</dt>
@@ -439,13 +440,13 @@
<a NAME="VersionControl.__statusMonitorStatus" ID="VersionControl.__statusMonitorStatus"></a>
<h4>VersionControl.__statusMonitorStatus</h4>
<b>__statusMonitorStatus</b>(<i>status, statusMsg</i>)
-
<p>
Private slot to receive the status monitor status.
</p>
<p>
It simply re-emits the received status.
</p>
+
<dl>
<dt><i>status</i> (str (one of ok, nok or off))</dt>
@@ -460,7 +461,6 @@
<a NAME="VersionControl._createStatusMonitorThread" ID="VersionControl._createStatusMonitorThread"></a>
<h4>VersionControl._createStatusMonitorThread</h4>
<b>_createStatusMonitorThread</b>(<i>interval, project</i>)
-
<p>
Protected method to create an instance of the VCS status monitor
thread.
@@ -469,6 +469,7 @@
Note: This method should be overwritten in subclasses in order to
support VCS status monitoring.
</p>
+
<dl>
<dt><i>interval</i> (int)</dt>
@@ -495,11 +496,11 @@
<a NAME="VersionControl._vcsAddProjectCommitMessage" ID="VersionControl._vcsAddProjectCommitMessage"></a>
<h4>VersionControl._vcsAddProjectCommitMessage</h4>
<b>_vcsAddProjectCommitMessage</b>(<i>message</i>)
-
<p>
Protected method to add a commit message to the list of project
specific saved messages.
</p>
+
<dl>
<dt><i>message</i> (str)</dt>
@@ -522,10 +523,10 @@
<a NAME="VersionControl._vcsClearProjectCommitMessages" ID="VersionControl._vcsClearProjectCommitMessages"></a>
<h4>VersionControl._vcsClearProjectCommitMessages</h4>
<b>_vcsClearProjectCommitMessages</b>(<i></i>)
-
<p>
Protected method to clear the list of project specific saved messages.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -541,10 +542,10 @@
<a NAME="VersionControl._vcsProjectCommitMessages" ID="VersionControl._vcsProjectCommitMessages"></a>
<h4>VersionControl._vcsProjectCommitMessages</h4>
<b>_vcsProjectCommitMessages</b>(<i></i>)
-
<p>
Protected method to get the list of saved commit messages.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -560,11 +561,11 @@
<a NAME="VersionControl.addArguments" ID="VersionControl.addArguments"></a>
<h4>VersionControl.addArguments</h4>
<b>addArguments</b>(<i>args, argslist</i>)
-
<p>
Public method to add an argument list to the already present
arguments.
</p>
+
<dl>
<dt><i>args</i> (list of str)</dt>
@@ -579,24 +580,24 @@
<a NAME="VersionControl.checkVCSStatus" ID="VersionControl.checkVCSStatus"></a>
<h4>VersionControl.checkVCSStatus</h4>
<b>checkVCSStatus</b>(<i></i>)
-
<p>
Public method to wake up the VCS status monitor thread.
</p>
+
<a NAME="VersionControl.clearStatusCache" ID="VersionControl.clearStatusCache"></a>
<h4>VersionControl.clearStatusCache</h4>
<b>clearStatusCache</b>(<i></i>)
-
<p>
Public method to clear the status cache.
</p>
+
<a NAME="VersionControl.clearStatusMonitorCachedState" ID="VersionControl.clearStatusMonitorCachedState"></a>
<h4>VersionControl.clearStatusMonitorCachedState</h4>
<b>clearStatusMonitorCachedState</b>(<i>name</i>)
-
<p>
Public method to clear the cached VCS state of a file/directory.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -607,10 +608,10 @@
<a NAME="VersionControl.getStatusMonitorAutoUpdate" ID="VersionControl.getStatusMonitorAutoUpdate"></a>
<h4>VersionControl.getStatusMonitorAutoUpdate</h4>
<b>getStatusMonitorAutoUpdate</b>(<i></i>)
-
<p>
Public method to retrieve the status of the auto update function.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -626,10 +627,10 @@
<a NAME="VersionControl.getStatusMonitorInterval" ID="VersionControl.getStatusMonitorInterval"></a>
<h4>VersionControl.getStatusMonitorInterval</h4>
<b>getStatusMonitorInterval</b>(<i></i>)
-
<p>
Public method to get the monitor interval.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -645,10 +646,10 @@
<a NAME="VersionControl.setStatusMonitorAutoUpdate" ID="VersionControl.setStatusMonitorAutoUpdate"></a>
<h4>VersionControl.setStatusMonitorAutoUpdate</h4>
<b>setStatusMonitorAutoUpdate</b>(<i>auto</i>)
-
<p>
Public method to enable the auto update function.
</p>
+
<dl>
<dt><i>auto</i> (bool)</dt>
@@ -659,10 +660,10 @@
<a NAME="VersionControl.setStatusMonitorInterval" ID="VersionControl.setStatusMonitorInterval"></a>
<h4>VersionControl.setStatusMonitorInterval</h4>
<b>setStatusMonitorInterval</b>(<i>interval, project</i>)
-
<p>
Public method to change the monitor interval.
</p>
+
<dl>
<dt><i>interval</i> (int)</dt>
@@ -677,10 +678,10 @@
<a NAME="VersionControl.splitPath" ID="VersionControl.splitPath"></a>
<h4>VersionControl.splitPath</h4>
<b>splitPath</b>(<i>name</i>)
-
<p>
Public method splitting name into a directory part and a file part.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -703,11 +704,11 @@
<a NAME="VersionControl.splitPathList" ID="VersionControl.splitPathList"></a>
<h4>VersionControl.splitPathList</h4>
<b>splitPathList</b>(<i>names</i>)
-
<p>
Public method splitting the list of names into a common directory part
and a file list.
</p>
+
<dl>
<dt><i>names</i> (list of str)</dt>
@@ -730,10 +731,10 @@
<a NAME="VersionControl.startStatusMonitor" ID="VersionControl.startStatusMonitor"></a>
<h4>VersionControl.startStatusMonitor</h4>
<b>startStatusMonitor</b>(<i>project</i>)
-
<p>
Public method to start the VCS status monitor thread.
</p>
+
<dl>
<dt><i>project</i> (Project)</dt>
@@ -756,7 +757,6 @@
<a NAME="VersionControl.startSynchronizedProcess" ID="VersionControl.startSynchronizedProcess"></a>
<h4>VersionControl.startSynchronizedProcess</h4>
<b>startSynchronizedProcess</b>(<i>proc, program, arguments, workingDir=None</i>)
-
<p>
Public method to start a synchroneous process.
</p>
@@ -764,6 +764,7 @@
This method starts a process and waits
for its end while still serving the Qt event loop.
</p>
+
<dl>
<dt><i>proc</i> (QProcess)</dt>
@@ -798,17 +799,17 @@
<a NAME="VersionControl.stopStatusMonitor" ID="VersionControl.stopStatusMonitor"></a>
<h4>VersionControl.stopStatusMonitor</h4>
<b>stopStatusMonitor</b>(<i></i>)
-
<p>
Public method to stop the VCS status monitor thread.
</p>
+
<a NAME="VersionControl.vcsAdd" ID="VersionControl.vcsAdd"></a>
<h4>VersionControl.vcsAdd</h4>
<b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
-
<p>
Public method used to add a file/directory in the vcs.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -835,10 +836,10 @@
<a NAME="VersionControl.vcsAddBinary" ID="VersionControl.vcsAddBinary"></a>
<h4>VersionControl.vcsAddBinary</h4>
<b>vcsAddBinary</b>(<i>name, isDir=False</i>)
-
<p>
Public method used to add a file/directory in binary mode in the vcs.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -861,10 +862,10 @@
<a NAME="VersionControl.vcsAddCommitMessage" ID="VersionControl.vcsAddCommitMessage"></a>
<h4>VersionControl.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>
@@ -883,10 +884,10 @@
<a NAME="VersionControl.vcsAddTree" ID="VersionControl.vcsAddTree"></a>
<h4>VersionControl.vcsAddTree</h4>
<b>vcsAddTree</b>(<i>path</i>)
-
<p>
Public method to add a directory tree rooted at path in the vcs.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -905,11 +906,11 @@
<a NAME="VersionControl.vcsAllRegisteredStates" ID="VersionControl.vcsAllRegisteredStates"></a>
<h4>VersionControl.vcsAllRegisteredStates</h4>
<b>vcsAllRegisteredStates</b>(<i>names, dname</i>)
-
<p>
Public method used to get the registered states of a number of files
in the vcs.
</p>
+
<dl>
<dt><i>names</i> (dict)</dt>
@@ -945,10 +946,10 @@
<a NAME="VersionControl.vcsCheckout" ID="VersionControl.vcsCheckout"></a>
<h4>VersionControl.vcsCheckout</h4>
<b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
-
<p>
Public method used to check the project out of the vcs.
</p>
+
<dl>
<dt><i>vcsDataDict</i> (dict)</dt>
@@ -987,10 +988,10 @@
<a NAME="VersionControl.vcsCleanup" ID="VersionControl.vcsCleanup"></a>
<h4>VersionControl.vcsCleanup</h4>
<b>vcsCleanup</b>(<i>name</i>)
-
<p>
Public method used to cleanup the local copy.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1009,10 +1010,10 @@
<a NAME="VersionControl.vcsClearCommitMessages" ID="VersionControl.vcsClearCommitMessages"></a>
<h4>VersionControl.vcsClearCommitMessages</h4>
<b>vcsClearCommitMessages</b>(<i></i>)
-
<p>
Public method to clear the list of saved messages.
</p>
+
<dl>
<dt>Raises <b>NotImplementedError</b>:</dt>
@@ -1024,10 +1025,10 @@
<a NAME="VersionControl.vcsCommandLine" ID="VersionControl.vcsCommandLine"></a>
<h4>VersionControl.vcsCommandLine</h4>
<b>vcsCommandLine</b>(<i>name</i>)
-
<p>
Public method used to execute arbitrary vcs commands.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1046,11 +1047,11 @@
<a NAME="VersionControl.vcsCommit" ID="VersionControl.vcsCommit"></a>
<h4>VersionControl.vcsCommit</h4>
<b>vcsCommit</b>(<i>name, message, noDialog=False</i>)
-
<p>
Public method used to make the change of a file/directory permanent in
the vcs.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1089,10 +1090,10 @@
<a NAME="VersionControl.vcsCommitMessages" ID="VersionControl.vcsCommitMessages"></a>
<h4>VersionControl.vcsCommitMessages</h4>
<b>vcsCommitMessages</b>(<i></i>)
-
<p>
Public method to get the list of saved commit messages.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1116,11 +1117,11 @@
<a NAME="VersionControl.vcsConvertProject" ID="VersionControl.vcsConvertProject"></a>
<h4>VersionControl.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>
@@ -1147,10 +1148,10 @@
<a NAME="VersionControl.vcsDiff" ID="VersionControl.vcsDiff"></a>
<h4>VersionControl.vcsDiff</h4>
<b>vcsDiff</b>(<i>name</i>)
-
<p>
Public method used to view the diff of a file/directory in the vcs.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1169,10 +1170,10 @@
<a NAME="VersionControl.vcsExists" ID="VersionControl.vcsExists"></a>
<h4>VersionControl.vcsExists</h4>
<b>vcsExists</b>(<i></i>)
-
<p>
Public method used to test for the presence of the vcs.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1197,10 +1198,10 @@
<a NAME="VersionControl.vcsExport" ID="VersionControl.vcsExport"></a>
<h4>VersionControl.vcsExport</h4>
<b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
-
<p>
Public method used to export a directory from the vcs.
</p>
+
<dl>
<dt><i>vcsDataDict</i> (dict)</dt>
@@ -1235,10 +1236,10 @@
<a NAME="VersionControl.vcsForget" ID="VersionControl.vcsForget"></a>
<h4>VersionControl.vcsForget</h4>
<b>vcsForget</b>(<i>name</i>)
-
<p>
Public method used to remove a file from the repository.
</p>
+
<dl>
<dt><i>name</i> (str or list of str)</dt>
@@ -1257,10 +1258,10 @@
<a NAME="VersionControl.vcsGetOptions" ID="VersionControl.vcsGetOptions"></a>
<h4>VersionControl.vcsGetOptions</h4>
<b>vcsGetOptions</b>(<i></i>)
-
<p>
Public method used to retrieve the options of the vcs.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1277,10 +1278,10 @@
<a NAME="VersionControl.vcsGetOtherData" ID="VersionControl.vcsGetOtherData"></a>
<h4>VersionControl.vcsGetOtherData</h4>
<b>vcsGetOtherData</b>(<i></i>)
-
<p>
Public method used to retrieve vcs specific data.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1296,11 +1297,11 @@
<a NAME="VersionControl.vcsGetProjectBrowserHelper" ID="VersionControl.vcsGetProjectBrowserHelper"></a>
<h4>VersionControl.vcsGetProjectBrowserHelper</h4>
<b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
-
<p>
Public method to instanciate a helper object for the different
project browsers.
</p>
+
<dl>
<dt><i>browser</i> (ProjectBaseBrowser)</dt>
@@ -1340,10 +1341,10 @@
<a NAME="VersionControl.vcsGetProjectHelper" ID="VersionControl.vcsGetProjectHelper"></a>
<h4>VersionControl.vcsGetProjectHelper</h4>
<b>vcsGetProjectHelper</b>(<i>project</i>)
-
<p>
Public method to instanciate a helper object for the project.
</p>
+
<dl>
<dt><i>project</i> (Project)</dt>
@@ -1374,10 +1375,10 @@
<a NAME="VersionControl.vcsImport" ID="VersionControl.vcsImport"></a>
<h4>VersionControl.vcsImport</h4>
<b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>)
-
<p>
Public method used to import the project into the vcs.
</p>
+
<dl>
<dt><i>vcsDataDict</i> (dict)</dt>
@@ -1421,10 +1422,10 @@
<a NAME="VersionControl.vcsInit" ID="VersionControl.vcsInit"></a>
<h4>VersionControl.vcsInit</h4>
<b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
-
<p>
Public method used to initialize the vcs.
</p>
+
<dl>
<dt><i>vcsDir</i> (str)</dt>
@@ -1459,7 +1460,6 @@
<a NAME="VersionControl.vcsInitConfig" ID="VersionControl.vcsInitConfig"></a>
<h4>VersionControl.vcsInitConfig</h4>
<b>vcsInitConfig</b>(<i>project</i>)
-
<p>
Public method to initialize the VCS configuration.
</p>
@@ -1467,6 +1467,7 @@
This method could ensure, that certain files or directories are
exclude from being version controlled.
</p>
+
<dl>
<dt><i>project</i> (Project)</dt>
@@ -1477,11 +1478,11 @@
<a NAME="VersionControl.vcsLogBrowser" ID="VersionControl.vcsLogBrowser"></a>
<h4>VersionControl.vcsLogBrowser</h4>
<b>vcsLogBrowser</b>(<i>name, isFile=False</i>)
-
<p>
Public method used to view the log of a file/directory in the vcs
with a log browser dialog.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1504,10 +1505,10 @@
<a NAME="VersionControl.vcsMerge" ID="VersionControl.vcsMerge"></a>
<h4>VersionControl.vcsMerge</h4>
<b>vcsMerge</b>(<i>name</i>)
-
<p>
Public method used to merge a tag/branch into the local project.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1526,10 +1527,10 @@
<a NAME="VersionControl.vcsMove" ID="VersionControl.vcsMove"></a>
<h4>VersionControl.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>
@@ -1572,10 +1573,10 @@
<a NAME="VersionControl.vcsName" ID="VersionControl.vcsName"></a>
<h4>VersionControl.vcsName</h4>
<b>vcsName</b>(<i></i>)
-
<p>
Public method returning the name of the vcs.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1599,11 +1600,11 @@
<a NAME="VersionControl.vcsNewProjectOptionsDialog" ID="VersionControl.vcsNewProjectOptionsDialog"></a>
<h4>VersionControl.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>
@@ -1622,10 +1623,10 @@
<a NAME="VersionControl.vcsOptionsDialog" ID="VersionControl.vcsOptionsDialog"></a>
<h4>VersionControl.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>
@@ -1656,10 +1657,10 @@
<a NAME="VersionControl.vcsRegisteredState" ID="VersionControl.vcsRegisteredState"></a>
<h4>VersionControl.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>
@@ -1690,10 +1691,10 @@
<a NAME="VersionControl.vcsRemove" ID="VersionControl.vcsRemove"></a>
<h4>VersionControl.vcsRemove</h4>
<b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
-
<p>
Public method used to add a file/directory in the vcs.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1732,10 +1733,10 @@
<a NAME="VersionControl.vcsRepositoryInfos" ID="VersionControl.vcsRepositoryInfos"></a>
<h4>VersionControl.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>
@@ -1766,10 +1767,10 @@
<a NAME="VersionControl.vcsResolved" ID="VersionControl.vcsResolved"></a>
<h4>VersionControl.vcsResolved</h4>
<b>vcsResolved</b>(<i>name</i>)
-
<p>
Public method used to resolve conflicts of a file/directory.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1780,10 +1781,10 @@
<a NAME="VersionControl.vcsRevert" ID="VersionControl.vcsRevert"></a>
<h4>VersionControl.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>
@@ -1815,11 +1816,11 @@
<a NAME="VersionControl.vcsSbsDiff" ID="VersionControl.vcsSbsDiff"></a>
<h4>VersionControl.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 Mercurial
repository side-by-side.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1846,10 +1847,10 @@
<a NAME="VersionControl.vcsSetData" ID="VersionControl.vcsSetData"></a>
<h4>VersionControl.vcsSetData</h4>
<b>vcsSetData</b>(<i>key, value</i>)
-
<p>
Public method used to set an entry in the otherData dictionary.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1864,10 +1865,10 @@
<a NAME="VersionControl.vcsSetDataFromDict" ID="VersionControl.vcsSetDataFromDict"></a>
<h4>VersionControl.vcsSetDataFromDict</h4>
<b>vcsSetDataFromDict</b>(<i>dictionary</i>)
-
<p>
Public method used to set entries in the otherData dictionary.
</p>
+
<dl>
<dt><i>dictionary</i> (dict)</dt>
@@ -1878,10 +1879,10 @@
<a NAME="VersionControl.vcsSetOptions" ID="VersionControl.vcsSetOptions"></a>
<h4>VersionControl.vcsSetOptions</h4>
<b>vcsSetOptions</b>(<i>options</i>)
-
<p>
Public method used to set the options for the vcs.
</p>
+
<dl>
<dt><i>options</i> (dict)</dt>
@@ -1893,10 +1894,10 @@
<a NAME="VersionControl.vcsSetOtherData" ID="VersionControl.vcsSetOtherData"></a>
<h4>VersionControl.vcsSetOtherData</h4>
<b>vcsSetOtherData</b>(<i>data</i>)
-
<p>
Public method used to set vcs specific data.
</p>
+
<dl>
<dt><i>data</i> (dict)</dt>
@@ -1907,10 +1908,10 @@
<a NAME="VersionControl.vcsShutdown" ID="VersionControl.vcsShutdown"></a>
<h4>VersionControl.vcsShutdown</h4>
<b>vcsShutdown</b>(<i></i>)
-
<p>
Public method used to shutdown the vcs interface.
</p>
+
<dl>
<dt>Raises <b>NotImplementedError</b>:</dt>
@@ -1922,10 +1923,10 @@
<a NAME="VersionControl.vcsStatus" ID="VersionControl.vcsStatus"></a>
<h4>VersionControl.vcsStatus</h4>
<b>vcsStatus</b>(<i>name</i>)
-
<p>
Public method used to view the status of a file/directory in the vcs.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1944,10 +1945,10 @@
<a NAME="VersionControl.vcsSupportCommandOptions" ID="VersionControl.vcsSupportCommandOptions"></a>
<h4>VersionControl.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>
@@ -1963,10 +1964,10 @@
<a NAME="VersionControl.vcsSwitch" ID="VersionControl.vcsSwitch"></a>
<h4>VersionControl.vcsSwitch</h4>
<b>vcsSwitch</b>(<i>name</i>)
-
<p>
Public method used to switch a directory to a different tag/branch.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1998,10 +1999,10 @@
<a NAME="VersionControl.vcsTag" ID="VersionControl.vcsTag"></a>
<h4>VersionControl.vcsTag</h4>
<b>vcsTag</b>(<i>name</i>)
-
<p>
Public method used to set the tag of a file/directory in the vcs.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -2020,10 +2021,10 @@
<a NAME="VersionControl.vcsUpdate" ID="VersionControl.vcsUpdate"></a>
<h4>VersionControl.vcsUpdate</h4>
<b>vcsUpdate</b>(<i>name, noDialog=False</i>)
-
<p>
Public method used to update a file/directory in the vcs.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -2058,4 +2059,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
