eric: comparison src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html

-:e7764f992a01
+:b51dfacef37f
 <td><a href="#Hg.stopClient">stopClient</a></td>
 <td>Public method to stop the command server client.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsAdd">vcsAdd</a></td>
-<td></td>
+<td>Public method used to add a file/directory to the Mercurial repository.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsAddBinary">vcsAddBinary</a></td>
 <td>Public method used to add a file/directory in binary mode to the Mercurial repository.</td>
 </tr>
 <td><a href="#Hg.vcsAddTree">vcsAddTree</a></td>
 <td>Public method to add a directory tree rooted at path to the Mercurial repository.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
-<td></td>
+<td>Public method used to get the registered states of a number of files in the vcs.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsCheckout">vcsCheckout</a></td>
 <td>Public method used to check the project out of a Mercurial repository (clone).</td>
 </tr>
 <td><a href="#Hg.vcsImport">vcsImport</a></td>
 <td>Public method used to import the project into the Mercurial repository.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsInit">vcsInit</a></td>
-<td></td>
+<td>Public method used to initialize the mercurial repository.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsInitConfig">vcsInitConfig</a></td>
 <td>Public method to initialize the VCS configuration.</td>
 </tr>
 <td><a href="#Hg.vcsLogBrowser">vcsLogBrowser</a></td>
 <td>Public method used to browse the log of a file/directory from the Mercurial repository.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsMerge">vcsMerge</a></td>
-<td></td>
+<td>Public method used to merge a URL/revision into the local project.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsMove">vcsMove</a></td>
 <td>Public method used to move a file/directory.</td>
 </tr>
 <td><a href="#Hg.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="#Hg.vcsRemove">vcsRemove</a></td>
-<td></td>
+<td>Public method used to remove a file/directory from the Mercurial repository.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsRepositoryInfos">vcsRepositoryInfos</a></td>
-<td></td>
+<td>Public method to retrieve information about the repository.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsResolved">vcsResolved</a></td>
 <td>Public method used to resolve conflicts of a file/directory.</td>
 </tr>
 <td><a href="#Hg.vcsSwitch">vcsSwitch</a></td>
 <td>Public method used to switch a working directory to a different revision.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsTag">vcsTag</a></td>
-<td></td>
+<td>Public method used to set/remove a tag in the Mercurial repository.</td>
 </tr>
 <tr>
 <td><a href="#Hg.vcsUpdate">vcsUpdate</a></td>
-<td></td>
+<td>Public method used to update a file/directory with the Mercurial repository.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 </p>
 <a NAME="Hg.vcsAdd" ID="Hg.vcsAdd"></a>
 <h4>Hg.vcsAdd</h4>
 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
+<p>
+Public method used to add a file/directory to the Mercurial repository.
+</p>
+<dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name to be added (string)
+</dd>
+<dt><i>isDir</i></dt>
+<dd>
+flag indicating name is a directory (boolean)
+</dd>
+<dt><i>noDialog</i></dt>
+<dd>
+flag indicating quiet operations
+</dd>
+</dl>
 <a NAME="Hg.vcsAddBinary" ID="Hg.vcsAddBinary"></a>
 <h4>Hg.vcsAddBinary</h4>
 <b>vcsAddBinary</b>(<i>name, isDir=False</i>)
 <p>
 </dl>
 <a NAME="Hg.vcsAllRegisteredStates" ID="Hg.vcsAllRegisteredStates"></a>
 <h4>Hg.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.
+</p>
+<p>
+<b>Note:</b> If a shortcut is to be taken, the code will only check,
+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></dt>
+<dd>
+dictionary with all filenames to be checked as keys
+</dd>
+<dt><i>dname</i></dt>
+<dd>
+directory to check in (string)
+</dd>
+<dt><i>shortcut</i></dt>
+<dd>
+flag indicating a shortcut should be taken (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+the received dictionary completed with a combination of
+canBeCommited and canBeAdded or None in order to signal an error
+</dd>
+</dl>
 <a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a>
 <h4>Hg.vcsCheckout</h4>
 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
 <p>
 </dl>
 <a NAME="Hg.vcsInit" ID="Hg.vcsInit"></a>
 <h4>Hg.vcsInit</h4>
 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
+<p>
+Public method used to initialize the mercurial repository.
+</p>
+<p>
+The initialization is done, when a project is converted into a
+Mercurial controlled project. Therefore we always return TRUE without
+doing anything.
+</p>
+<dl>
+<dt><i>vcsDir</i></dt>
+<dd>
+name of the VCS directory (string)
+</dd>
+<dt><i>noDialog</i></dt>
+<dd>
+flag indicating quiet operations (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+always TRUE
+</dd>
+</dl>
 <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a>
 <h4>Hg.vcsInitConfig</h4>
 <b>vcsInitConfig</b>(<i>project</i>)
 <p>
 </dl>
 <a NAME="Hg.vcsMerge" ID="Hg.vcsMerge"></a>
 <h4>Hg.vcsMerge</h4>
 <b>vcsMerge</b>(<i>name, rev=""</i>)
+<p>
+Public method used to merge a URL/revision into the local project.
+</p>
+<dl>
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be merged
+</dd>
+<dt><i>rev</i> (str)</dt>
+<dd>
+revision to merge with
+</dd>
+</dl>
 <a NAME="Hg.vcsMove" ID="Hg.vcsMove"></a>
 <h4>Hg.vcsMove</h4>
 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>)
 <p>
 </dl>
 <a NAME="Hg.vcsRemove" ID="Hg.vcsRemove"></a>
 <h4>Hg.vcsRemove</h4>
 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
+<p>
+Public method used to remove a file/directory from the Mercurial
+repository.
+</p>
+<p>
+The default operation is to remove the local copy as well.
+</p>
+<dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name to be removed (string or list of
+strings))
+</dd>
+<dt><i>project</i></dt>
+<dd>
+flag indicating deletion of a project tree (boolean)
+(not needed)
+</dd>
+<dt><i>noDialog</i></dt>
+<dd>
+flag indicating quiet operations
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating successfull operation (boolean)
+</dd>
+</dl>
 <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a>
 <h4>Hg.vcsRepositoryInfos</h4>
 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
+<p>
+Public method to retrieve information about the repository.
+</p>
+<dl>
+<dt><i>ppath</i></dt>
+<dd>
+local path to get the repository infos (string)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+string with ready formated info for display (string)
+</dd>
+</dl>
 <a NAME="Hg.vcsResolved" ID="Hg.vcsResolved"></a>
 <h4>Hg.vcsResolved</h4>
 <b>vcsResolved</b>(<i>name, unresolve=False</i>)
 <p>
 </dl>
 <a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a>
 <h4>Hg.vcsTag</h4>
 <b>vcsTag</b>(<i>name=None, revision=None, tagName=None</i>)
+<p>
+Public method used to set/remove a tag in the Mercurial repository.
+</p>
+<dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name to determine the repo root from
+(string)
+</dd>
+<dt><i>revision</i></dt>
+<dd>
+revision to set tag for (string)
+</dd>
+<dt><i>tagName</i></dt>
+<dd>
+name of the tag (string)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a performed tag action (boolean)
+</dd>
+</dl>
 <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a>
 <h4>Hg.vcsUpdate</h4>
 <b>vcsUpdate</b>(<i>name=None, noDialog=False, revision=None</i>)
+<p>
+Public method used to update a file/directory with the Mercurial
+repository.
+</p>
+<dl>
+<dt><i>name</i></dt>
+<dd>
+file/directory name to be updated (not used)
+</dd>
+<dt><i>noDialog</i></dt>
+<dd>
+flag indicating quiet operations (boolean)
+</dd>
+<dt><i>revision</i></dt>
+<dd>
+revision to update to (string)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating, that the update contained an add
+or delete (boolean)
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html

src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html