diff -r 866adc8c315b -r 0acf98cd089a eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.hg.html
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.hg.html Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.hg.html Mon Feb 01 10:38:16 2021 +0100
@@ -610,31 +610,27 @@
</p>
<a NAME="Hg.__getInOutBookmarks" ID="Hg.__getInOutBookmarks"></a>
<h4>Hg.__getInOutBookmarks</h4>
-<b>__getInOutBookmarks</b>(<i>repodir, incoming</i>)
+<b>__getInOutBookmarks</b>(<i>incoming</i>)
<p>
Private method to get the list of incoming or outgoing bookmarks.
</p>
<dl>
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
<dt><i>incoming</i></dt>
<dd>
flag indicating to get incoming bookmarks (boolean)
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of bookmarks (list of string)
</dd>
</dl>
<a NAME="Hg.__getMostRecentCommitMessage" ID="Hg.__getMostRecentCommitMessage"></a>
<h4>Hg.__getMostRecentCommitMessage</h4>
-<b>__getMostRecentCommitMessage</b>(<i>repodir</i>)
+<b>__getMostRecentCommitMessage</b>(<i></i>)
<p>
Private method to get the most recent commit message.
@@ -644,14 +640,7 @@
working directory.
</p>
<dl>
-
-<dt><i>repodir</i> (str)</dt>
-<dd>
-path containing the repository
-</dd>
-</dl>
-<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
most recent commit message
</dd>
@@ -676,30 +665,26 @@
<dd>
file name to get from the repository (string)
</dd>
-<dt><i>rev=</i></dt>
+<dt><i>rev</i></dt>
<dd>
revision to retrieve (string)
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
contents of the file (string) and an error message (string)
</dd>
</dl>
<a NAME="Hg.__hgGraftSubCommand" ID="Hg.__hgGraftSubCommand"></a>
<h4>Hg.__hgGraftSubCommand</h4>
-<b>__hgGraftSubCommand</b>(<i>path, subcommand, title</i>)
+<b>__hgGraftSubCommand</b>(<i>subcommand, title</i>)
<p>
Private method to perform a Mercurial graft subcommand.
</p>
<dl>
-<dt><i>path</i> (str)</dt>
-<dd>
-directory name of the project
-</dd>
<dt><i>subcommand</i> (str)</dt>
<dd>
subcommand flag
@@ -710,7 +695,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating that the project should be reread
</dd>
@@ -737,7 +722,7 @@
</dl>
<a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a>
<h4>Hg.__monitorRepoIniFile</h4>
-<b>__monitorRepoIniFile</b>(<i>name</i>)
+<b>__monitorRepoIniFile</b>(<i>repodir</i>)
<p>
Private slot to add a repository configuration file to the list of
@@ -745,9 +730,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>repodir</i> (str)</dt>
<dd>
-directory name pointing into the repository (string)
+directory name of the repository
</dd>
</dl>
<a NAME="Hg.__vcsCommit_Step2" ID="Hg.__vcsCommit_Step2"></a>
@@ -778,28 +763,21 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the monitor thread (QThread)
</dd>
</dl>
<a NAME="Hg.canCommitMerge" ID="Hg.canCommitMerge"></a>
<h4>Hg.canCommitMerge</h4>
-<b>canCommitMerge</b>(<i>name</i>)
+<b>canCommitMerge</b>(<i></i>)
<p>
Public method to check, if the working directory is an uncommitted
merge.
</p>
<dl>
-
-<dt><i>name</i> (str)</dt>
-<dd>
-file/directory name
-</dd>
-</dl>
-<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating commit merge capability
</dd>
@@ -818,7 +796,7 @@
Public method to check, if pull is possible.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating pull capability (boolean)
</dd>
@@ -831,7 +809,7 @@
Public method to check, if push is possible.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating push capability (boolean)
</dd>
@@ -851,7 +829,7 @@
Public method to get a reference to the command server interface.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the client (HgClient)
</dd>
@@ -864,7 +842,7 @@
Public method to get the encoding to be used by Mercurial.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
encoding (string)
</dd>
@@ -884,7 +862,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the extension object (boolean)
</dd>
@@ -898,7 +876,7 @@
definitions of sub-repositories.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
full path of the .hgsub file (string)
</dd>
@@ -911,7 +889,7 @@
Public method to get a reference to the plugin object.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the plugin object (VcsMercurialPlugin)
</dd>
@@ -924,27 +902,20 @@
Public method to check, if the project might have sub-repositories.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating the existence of sub-repositories (boolean)
</dd>
</dl>
<a NAME="Hg.hgAbortMerge" ID="Hg.hgAbortMerge"></a>
<h4>Hg.hgAbortMerge</h4>
-<b>hgAbortMerge</b>(<i>name</i>)
+<b>hgAbortMerge</b>(<i></i>)
<p>
Public method to abort an uncommitted merge.
</p>
<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
-<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating, that the abortion contained an add
or delete (boolean)
@@ -980,35 +951,24 @@
</p>
<a NAME="Hg.hgBackout" ID="Hg.hgBackout"></a>
<h4>Hg.hgBackout</h4>
-<b>hgBackout</b>(<i>name</i>)
+<b>hgBackout</b>(<i></i>)
<p>
Public method used to backout an earlier changeset from the Mercurial
repository.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-directory name (string or list of strings)
-</dd>
-</dl>
<a NAME="Hg.hgBisect" ID="Hg.hgBisect"></a>
<h4>Hg.hgBisect</h4>
-<b>hgBisect</b>(<i>name, subcommand</i>)
+<b>hgBisect</b>(<i>subcommand</i>)
<p>
Public method to perform bisect commands.
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>subcommand</i> (str)</dt>
<dd>
-file/directory name (string)
-</dd>
-<dt><i>subcommand</i></dt>
-<dd>
-name of the subcommand (string, one of 'good', 'bad',
+name of the subcommand (one of 'good', 'bad',
'skip' or 'reset')
</dd>
</dl>
@@ -1021,17 +981,13 @@
</dl>
<a NAME="Hg.hgBookmarkDefine" ID="Hg.hgBookmarkDefine"></a>
<h4>Hg.hgBookmarkDefine</h4>
-<b>hgBookmarkDefine</b>(<i>name, revision=None, bookmark=None</i>)
+<b>hgBookmarkDefine</b>(<i>revision=None, bookmark=None</i>)
<p>
Public method to define a bookmark.
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
<dt><i>revision</i></dt>
<dd>
revision to set bookmark for (string)
@@ -1043,17 +999,13 @@
</dl>
<a NAME="Hg.hgBookmarkDelete" ID="Hg.hgBookmarkDelete"></a>
<h4>Hg.hgBookmarkDelete</h4>
-<b>hgBookmarkDelete</b>(<i>name, bookmark=None</i>)
+<b>hgBookmarkDelete</b>(<i>bookmark=None</i>)
<p>
Public method to delete a bookmark.
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
<dt><i>bookmark</i></dt>
<dd>
name of the bookmark (string)
@@ -1061,31 +1013,20 @@
</dl>
<a NAME="Hg.hgBookmarkIncoming" ID="Hg.hgBookmarkIncoming"></a>
<h4>Hg.hgBookmarkIncoming</h4>
-<b>hgBookmarkIncoming</b>(<i>name</i>)
+<b>hgBookmarkIncoming</b>(<i></i>)
<p>
Public method to show a list of incoming bookmarks.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
<a NAME="Hg.hgBookmarkMove" ID="Hg.hgBookmarkMove"></a>
<h4>Hg.hgBookmarkMove</h4>
-<b>hgBookmarkMove</b>(<i>name, revision=None, bookmark=None</i>)
+<b>hgBookmarkMove</b>(<i>revision=None, bookmark=None</i>)
<p>
Public method to move a bookmark.
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
<dt><i>revision</i></dt>
<dd>
revision to set bookmark for (string)
@@ -1097,31 +1038,20 @@
</dl>
<a NAME="Hg.hgBookmarkOutgoing" ID="Hg.hgBookmarkOutgoing"></a>
<h4>Hg.hgBookmarkOutgoing</h4>
-<b>hgBookmarkOutgoing</b>(<i>name</i>)
+<b>hgBookmarkOutgoing</b>(<i></i>)
<p>
Public method to show a list of outgoing bookmarks.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
<a NAME="Hg.hgBookmarkPull" ID="Hg.hgBookmarkPull"></a>
<h4>Hg.hgBookmarkPull</h4>
-<b>hgBookmarkPull</b>(<i>name, current=False, bookmark=None</i>)
+<b>hgBookmarkPull</b>(<i>current=False, bookmark=None</i>)
<p>
Public method to pull a bookmark from a remote repository.
</p>
<dl>
-<dt><i>name</i> (str)</dt>
-<dd>
-file/directory name
-</dd>
<dt><i>current</i> (bool)</dt>
<dd>
flag indicating to pull the current bookmark
@@ -1133,17 +1063,13 @@
</dl>
<a NAME="Hg.hgBookmarkPush" ID="Hg.hgBookmarkPush"></a>
<h4>Hg.hgBookmarkPush</h4>
-<b>hgBookmarkPush</b>(<i>name, current=False, bookmark=None</i>)
+<b>hgBookmarkPush</b>(<i>current=False, bookmark=None</i>)
<p>
Public method to push a bookmark to a remote repository.
</p>
<dl>
-<dt><i>name</i> (str)</dt>
-<dd>
-file/directory name
-</dd>
<dt><i>current</i> (bool)</dt>
<dd>
flag indicating to push the current bookmark
@@ -1155,17 +1081,13 @@
</dl>
<a NAME="Hg.hgBookmarkRename" ID="Hg.hgBookmarkRename"></a>
<h4>Hg.hgBookmarkRename</h4>
-<b>hgBookmarkRename</b>(<i>name, renameInfo=None</i>)
+<b>hgBookmarkRename</b>(<i>renameInfo=None</i>)
<p>
Public method to rename a bookmark.
</p>
<dl>
-<dt><i>name</i> (str)</dt>
-<dd>
-file/directory name
-</dd>
<dt><i>renameInfo</i> (tuple of str and str)</dt>
<dd>
old and new names of the bookmark
@@ -1173,31 +1095,20 @@
</dl>
<a NAME="Hg.hgBranch" ID="Hg.hgBranch"></a>
<h4>Hg.hgBranch</h4>
-<b>hgBranch</b>(<i>name</i>)
+<b>hgBranch</b>(<i></i>)
<p>
Public method used to create a branch in the Mercurial repository.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be branched (string)
-</dd>
-</dl>
<a NAME="Hg.hgBundle" ID="Hg.hgBundle"></a>
<h4>Hg.hgBundle</h4>
-<b>hgBundle</b>(<i>name, bundleData=None</i>)
+<b>hgBundle</b>(<i>bundleData=None</i>)
<p>
Public method to create a changegroup file.
</p>
<dl>
-<dt><i>name</i> (str)</dt>
-<dd>
-file/directory name
-</dd>
<dt><i>bundleData</i> (dict)</dt>
<dd>
dictionary containing the bundle creation information
@@ -1205,18 +1116,11 @@
</dl>
<a NAME="Hg.hgConflicts" ID="Hg.hgConflicts"></a>
<h4>Hg.hgConflicts</h4>
-<b>hgConflicts</b>(<i>name</i>)
+<b>hgConflicts</b>(<i></i>)
<p>
Public method used to show a list of files containing conflicts.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name to be resolved (string)
-</dd>
-</dl>
<a NAME="Hg.hgCopy" ID="Hg.hgCopy"></a>
<h4>Hg.hgCopy</h4>
<b>hgCopy</b>(<i>name, project</i>)
@@ -1236,7 +1140,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating successful operation (boolean)
</dd>
@@ -1260,7 +1164,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success
</dd>
@@ -1274,26 +1178,26 @@
</p>
<a NAME="Hg.hgEditConfig" ID="Hg.hgEditConfig"></a>
<h4>Hg.hgEditConfig</h4>
-<b>hgEditConfig</b>(<i>name, withLargefiles=True, largefilesData=None</i>)
+<b>hgEditConfig</b>(<i>repoName=None, withLargefiles=True, largefilesData=None</i>)
<p>
Public method used to edit the repository configuration file.
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>repoName</i> (str)</dt>
<dd>
-file/directory name (string)
+directory name containing the repository
</dd>
-<dt><i>withLargefiles</i></dt>
+<dt><i>withLargefiles</i> (bool)</dt>
<dd>
flag indicating to configure the largefiles
- section (boolean)
+ section
</dd>
-<dt><i>largefilesData</i></dt>
+<dt><i>largefilesData</i> (dict)</dt>
<dd>
dictionary with data for the largefiles
- section of the data dialog (dict)
+ section of the data dialog
</dd>
</dl>
<a NAME="Hg.hgEditUserConfig" ID="Hg.hgEditUserConfig"></a>
@@ -1305,18 +1209,11 @@
</p>
<a NAME="Hg.hgExport" ID="Hg.hgExport"></a>
<h4>Hg.hgExport</h4>
-<b>hgExport</b>(<i>name</i>)
+<b>hgExport</b>(<i></i>)
<p>
Public method to export patches to files.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-directory name of the project to export from (string)
-</dd>
-</dl>
<a NAME="Hg.hgExtendedDiff" ID="Hg.hgExtendedDiff"></a>
<h4>Hg.hgExtendedDiff</h4>
<b>hgExtendedDiff</b>(<i>name</i>)
@@ -1361,60 +1258,39 @@
</dl>
<a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a>
<h4>Hg.hgGetBookmarksList</h4>
-<b>hgGetBookmarksList</b>(<i>repodir</i>)
+<b>hgGetBookmarksList</b>(<i></i>)
<p>
Public method to get the list of bookmarks.
</p>
<dl>
-
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
-</dl>
-<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of bookmarks (list of string)
</dd>
</dl>
<a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a>
<h4>Hg.hgGetBranchesList</h4>
-<b>hgGetBranchesList</b>(<i>repodir</i>)
+<b>hgGetBranchesList</b>(<i></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>
-</dl>
-<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of branches (list of string)
</dd>
</dl>
<a NAME="Hg.hgGetCurrentBranch" ID="Hg.hgGetCurrentBranch"></a>
<h4>Hg.hgGetCurrentBranch</h4>
-<b>hgGetCurrentBranch</b>(<i>repodir</i>)
+<b>hgGetCurrentBranch</b>(<i></i>)
<p>
Public method to get the current branch of the working directory.
</p>
<dl>
-
-<dt><i>repodir</i> (str)</dt>
-<dd>
-directory name of the repository
-</dd>
-</dl>
-<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
name of the current branch
</dd>
@@ -1427,24 +1303,20 @@
</dl>
<a NAME="Hg.hgGetTagsList" ID="Hg.hgGetTagsList"></a>
<h4>Hg.hgGetTagsList</h4>
-<b>hgGetTagsList</b>(<i>repodir, withType=False</i>)
+<b>hgGetTagsList</b>(<i>withType=False</i>)
<p>
Public method to get the list of tags.
</p>
<dl>
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
<dt><i>withType</i></dt>
<dd>
flag indicating to get the tag type as well (boolean)
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of tags (list of string) or list of tuples of
tag name and flag indicating a local tag (list of tuple of string
@@ -1453,17 +1325,13 @@
</dl>
<a NAME="Hg.hgGraft" ID="Hg.hgGraft"></a>
<h4>Hg.hgGraft</h4>
-<b>hgGraft</b>(<i>path, revs=None</i>)
+<b>hgGraft</b>(<i>revs=None</i>)
<p>
Public method to copy changesets from another branch.
</p>
<dl>
-<dt><i>path</i></dt>
-<dd>
-directory name of the project (string)
-</dd>
<dt><i>revs</i></dt>
<dd>
list of revisions to show in the revisions pane (list of
@@ -1471,7 +1339,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating that the project should be reread (boolean)
</dd>
@@ -1492,7 +1360,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating that the project should be reread
</dd>
@@ -1518,7 +1386,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating that the project should be reread
</dd>
@@ -1544,7 +1412,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating that the project should be reread
</dd>
@@ -1557,34 +1425,20 @@
</dl>
<a NAME="Hg.hgIdentify" ID="Hg.hgIdentify"></a>
<h4>Hg.hgIdentify</h4>
-<b>hgIdentify</b>(<i>name</i>)
+<b>hgIdentify</b>(<i></i>)
<p>
Public method to identify the current working directory.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
<a NAME="Hg.hgImport" ID="Hg.hgImport"></a>
<h4>Hg.hgImport</h4>
-<b>hgImport</b>(<i>name</i>)
+<b>hgImport</b>(<i></i>)
<p>
Public method to import a patch file.
</p>
<dl>
-
-<dt><i>name</i></dt>
-<dd>
-directory name of the project to import into (string)
-</dd>
-</dl>
-<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating, that the import contained an add, a delete
or a change to the project file (boolean)
@@ -1592,33 +1446,22 @@
</dl>
<a NAME="Hg.hgIncoming" ID="Hg.hgIncoming"></a>
<h4>Hg.hgIncoming</h4>
-<b>hgIncoming</b>(<i>name</i>)
+<b>hgIncoming</b>(<i></i>)
<p>
Public method used to view the log of incoming changes from the
Mercurial repository.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name to show the log of (string)
-</dd>
-</dl>
<a NAME="Hg.hgInfo" ID="Hg.hgInfo"></a>
<h4>Hg.hgInfo</h4>
-<b>hgInfo</b>(<i>ppath, mode="heads"</i>)
+<b>hgInfo</b>(<i>mode="heads"</i>)
<p>
Public method to show information about the heads of the repository.
</p>
<dl>
-<dt><i>ppath</i></dt>
-<dd>
-local path to get the repository infos (string)
-</dd>
-<dt><i>mode=</i></dt>
+<dt><i>mode</i></dt>
<dd>
mode of the operation (string, one of heads, parents,
tip)
@@ -1626,31 +1469,20 @@
</dl>
<a NAME="Hg.hgListBookmarks" ID="Hg.hgListBookmarks"></a>
<h4>Hg.hgListBookmarks</h4>
-<b>hgListBookmarks</b>(<i>path</i>)
+<b>hgListBookmarks</b>(<i></i>)
<p>
Public method used to list the available bookmarks.
</p>
-<dl>
-
-<dt><i>path</i></dt>
-<dd>
-directory name of the project (string)
-</dd>
-</dl>
<a NAME="Hg.hgListTagBranch" ID="Hg.hgListTagBranch"></a>
<h4>Hg.hgListTagBranch</h4>
-<b>hgListTagBranch</b>(<i>path, tags=True</i>)
+<b>hgListTagBranch</b>(<i>tags=True</i>)
<p>
Public method used to list the available tags or branches.
</p>
<dl>
-<dt><i>path</i></dt>
-<dd>
-directory name of the project (string)
-</dd>
<dt><i>tags</i></dt>
<dd>
flag indicating listing of branches or tags
@@ -1672,39 +1504,28 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
properly normalized url for mercurial (string)
</dd>
</dl>
<a NAME="Hg.hgOutgoing" ID="Hg.hgOutgoing"></a>
<h4>Hg.hgOutgoing</h4>
-<b>hgOutgoing</b>(<i>name</i>)
+<b>hgOutgoing</b>(<i></i>)
<p>
Public method used to view the log of outgoing changes from the
Mercurial repository.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name to show the log of (string)
-</dd>
-</dl>
<a NAME="Hg.hgPhase" ID="Hg.hgPhase"></a>
<h4>Hg.hgPhase</h4>
-<b>hgPhase</b>(<i>name, data=None</i>)
+<b>hgPhase</b>(<i>data=None</i>)
<p>
Public method to change the phase of revisions.
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-directory name of the project to export from (string)
-</dd>
<dt><i>data</i></dt>
<dd>
tuple giving phase data (list of revisions, phase, flag
@@ -1712,7 +1533,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -1726,39 +1547,28 @@
</dl>
<a NAME="Hg.hgPreviewBundle" ID="Hg.hgPreviewBundle"></a>
<h4>Hg.hgPreviewBundle</h4>
-<b>hgPreviewBundle</b>(<i>name</i>)
+<b>hgPreviewBundle</b>(<i></i>)
<p>
Public method used to view the log of incoming changes from a
changegroup file.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-directory name on which to base the changegroup (string)
-</dd>
-</dl>
<a NAME="Hg.hgPull" ID="Hg.hgPull"></a>
<h4>Hg.hgPull</h4>
-<b>hgPull</b>(<i>name, revisions=None</i>)
+<b>hgPull</b>(<i>revisions=None</i>)
<p>
Public method used to pull changes from a remote Mercurial repository.
</p>
<dl>
-<dt><i>name</i> (str)</dt>
-<dd>
-directory name of the project to be pulled to
-</dd>
<dt><i>revisions</i> (list of str)</dt>
<dd>
list of revisions to be pulled
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating, that the update contained an add
or delete
@@ -1772,26 +1582,22 @@
</dl>
<a NAME="Hg.hgPush" ID="Hg.hgPush"></a>
<h4>Hg.hgPush</h4>
-<b>hgPush</b>(<i>name, force=False, newBranch=False, rev=None</i>)
+<b>hgPush</b>(<i>force=False, newBranch=False, rev=None</i>)
<p>
Public method used to push changes to a remote Mercurial repository.
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-directory name of the project to be pushed from (string)
-</dd>
-<dt><i>force=</i></dt>
+<dt><i>force</i></dt>
<dd>
flag indicating a forced push (boolean)
</dd>
-<dt><i>newBranch=</i></dt>
+<dt><i>newBranch</i></dt>
<dd>
flag indicating to push a new branch (boolean)
</dd>
-<dt><i>rev=</i></dt>
+<dt><i>rev</i></dt>
<dd>
revision to be pushed (including all ancestors) (string)
</dd>
@@ -1812,18 +1618,11 @@
</dl>
<a NAME="Hg.hgRecover" ID="Hg.hgRecover"></a>
<h4>Hg.hgRecover</h4>
-<b>hgRecover</b>(<i>name</i>)
+<b>hgRecover</b>(<i></i>)
<p>
Public method to recover an interrupted transaction.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
<a NAME="Hg.hgRemoveSubrepositories" ID="Hg.hgRemoveSubrepositories"></a>
<h4>Hg.hgRemoveSubrepositories</h4>
<b>hgRemoveSubrepositories</b>(<i></i>)
@@ -1865,7 +1664,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating, that the update contained an add
or delete (boolean)
@@ -1873,18 +1672,11 @@
</dl>
<a NAME="Hg.hgRollback" ID="Hg.hgRollback"></a>
<h4>Hg.hgRollback</h4>
-<b>hgRollback</b>(<i>name</i>)
+<b>hgRollback</b>(<i></i>)
<p>
Public method used to rollback the last transaction.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-directory name (string or list of strings)
-</dd>
-</dl>
<a NAME="Hg.hgSbsDiff" ID="Hg.hgSbsDiff"></a>
<h4>Hg.hgSbsDiff</h4>
<b>hgSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
@@ -1899,11 +1691,11 @@
<dd>
file name to be diffed (string)
</dd>
-<dt><i>extended=</i></dt>
+<dt><i>extended</i></dt>
<dd>
flag indicating the extended variant (boolean)
</dd>
-<dt><i>revisions=</i></dt>
+<dt><i>revisions</i></dt>
<dd>
tuple of two revisions (tuple of strings)
</dd>
@@ -1917,60 +1709,39 @@
</dl>
<a NAME="Hg.hgServe" ID="Hg.hgServe"></a>
<h4>Hg.hgServe</h4>
-<b>hgServe</b>(<i>name</i>)
+<b>hgServe</b>(<i>repoPath</i>)
<p>
Public method used to serve the project.
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>repoPath</i> (str)</dt>
<dd>
-directory name (string)
+directory containing the repository
</dd>
</dl>
<a NAME="Hg.hgShowBranch" ID="Hg.hgShowBranch"></a>
<h4>Hg.hgShowBranch</h4>
-<b>hgShowBranch</b>(<i>name</i>)
+<b>hgShowBranch</b>(<i></i>)
<p>
Public method used to show the current branch of the working directory.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
<a NAME="Hg.hgShowConfig" ID="Hg.hgShowConfig"></a>
<h4>Hg.hgShowConfig</h4>
-<b>hgShowConfig</b>(<i>name</i>)
+<b>hgShowConfig</b>(<i></i>)
<p>
Public method to show the combined configuration.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
<a NAME="Hg.hgShowPaths" ID="Hg.hgShowPaths"></a>
<h4>Hg.hgShowPaths</h4>
-<b>hgShowPaths</b>(<i>name</i>)
+<b>hgShowPaths</b>(<i></i>)
<p>
Public method to show the path aliases for remote repositories.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
<a NAME="Hg.hgSummary" ID="Hg.hgSummary"></a>
<h4>Hg.hgSummary</h4>
<b>hgSummary</b>(<i>mq=False, largefiles=False</i>)
@@ -1993,24 +1764,20 @@
</dl>
<a NAME="Hg.hgUnbundle" ID="Hg.hgUnbundle"></a>
<h4>Hg.hgUnbundle</h4>
-<b>hgUnbundle</b>(<i>name, files=None</i>)
+<b>hgUnbundle</b>(<i>files=None</i>)
<p>
Public method to apply changegroup files.
</p>
<dl>
-<dt><i>name</i> (str)</dt>
-<dd>
-directory name
-</dd>
<dt><i>files</i> (list of str)</dt>
<dd>
list of bundle files to be applied
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating, that the update contained an add
or delete
@@ -2024,18 +1791,11 @@
</dl>
<a NAME="Hg.hgVerify" ID="Hg.hgVerify"></a>
<h4>Hg.hgVerify</h4>
-<b>hgVerify</b>(<i>name</i>)
+<b>hgVerify</b>(<i></i>)
<p>
Public method to verify the integrity of the repository.
</p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
<a NAME="Hg.initCommand" ID="Hg.initCommand"></a>
<h4>Hg.initCommand</h4>
<b>initCommand</b>(<i>command</i>)
@@ -2051,7 +1811,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of command options (list of string)
</dd>
@@ -2071,7 +1831,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating an active extension (boolean)
</dd>
@@ -2169,7 +1929,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the received dictionary completed with a combination of
canBeCommited and canBeAdded or None in order to signal an error
@@ -2199,7 +1959,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating an execution without errors (boolean)
</dd>
@@ -2255,15 +2015,15 @@
<dd>
flag indicating quiet operations
</dd>
-<dt><i>closeBranch=</i></dt>
+<dt><i>closeBranch</i></dt>
<dd>
flag indicating a close branch commit (boolean)
</dd>
-<dt><i>mq=</i></dt>
+<dt><i>mq</i></dt>
<dd>
flag indicating a queue commit (boolean)
</dd>
-<dt><i>merge=</i></dt>
+<dt><i>merge</i></dt>
<dd>
flag indicating a merge commit (boolean)
</dd>
@@ -2320,7 +2080,7 @@
Public method used to test for the presence of the hg executable.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating the existence (boolean) and an error message
(string)
@@ -2345,7 +2105,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating an execution without errors (boolean)
</dd>
@@ -2375,7 +2135,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the project browser helper object
</dd>
@@ -2395,7 +2155,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the project helper object
</dd>
@@ -2427,7 +2187,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
tuple containing a flag indicating an execution without errors
and a flag indicating the version controll status
@@ -2463,7 +2223,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
always TRUE
</dd>
@@ -2487,7 +2247,7 @@
</dl>
<a NAME="Hg.vcsLogBrowser" ID="Hg.vcsLogBrowser"></a>
<h4>Hg.vcsLogBrowser</h4>
-<b>vcsLogBrowser</b>(<i>name, isFile=False</i>)
+<b>vcsLogBrowser</b>(<i>name=None, isFile=False</i>)
<p>
Public method used to browse the log of a file/directory from the
@@ -2499,7 +2259,7 @@
<dd>
file/directory name to show the log of (string)
</dd>
-<dt><i>isFile=</i></dt>
+<dt><i>isFile</i></dt>
<dd>
flag indicating log for a file is to be shown
(boolean)
@@ -2518,7 +2278,7 @@
<dd>
file/directory name to be merged
</dd>
-<dt><i>rev=</i> (str)</dt>
+<dt><i>rev</i> (str)</dt>
<dd>
revision to merge with
</dd>
@@ -2550,7 +2310,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating successfull operation (boolean)
</dd>
@@ -2563,7 +2323,7 @@
Public method returning the name of the vcs.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
always 'Mercurial' (string)
</dd>
@@ -2584,7 +2344,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the instantiated options dialog
(HgNewProjectOptionsDialog)
@@ -2618,7 +2378,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the instantiated options dialog (HgOptionsDialog)
</dd>
@@ -2632,17 +2392,23 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-filename to check (string)
+file or directory name to check
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
a combination of canBeCommited and canBeAdded
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl>
<a NAME="Hg.vcsRemove" ID="Hg.vcsRemove"></a>
<h4>Hg.vcsRemove</h4>
<b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
@@ -2672,7 +2438,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating successfull operation (boolean)
</dd>
@@ -2692,7 +2458,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
string with ready formated info for display (string)
</dd>
@@ -2728,7 +2494,7 @@
Public method to signal the support of user settable command options.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating the support of user settable command options
(boolean)
@@ -2750,7 +2516,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating, that the switch contained an add
or delete (boolean)
@@ -2758,7 +2524,7 @@
</dl>
<a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a>
<h4>Hg.vcsTag</h4>
-<b>vcsTag</b>(<i>name, revision=None, tagName=None</i>)
+<b>vcsTag</b>(<i>name=None, revision=None, tagName=None</i>)
<p>
Public method used to set/remove a tag in the Mercurial repository.
@@ -2780,14 +2546,14 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<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, noDialog=False, revision=None</i>)
+<b>vcsUpdate</b>(<i>name=None, noDialog=False, revision=None</i>)
<p>
Public method used to update a file/directory with the Mercurial
@@ -2797,20 +2563,19 @@
<dt><i>name</i></dt>
<dd>
-file/directory name to be updated (string or list of
- strings)
+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>
+<dt><i>revision</i></dt>
<dd>
revision to update to (string)
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating, that the update contained an add
or delete (boolean)
