eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html

changeset 7976
a8a20f558176
parent 7900
72b88fb20261
child 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html	Wed Jan 13 19:07:20 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html	Wed Jan 13 19:08:16 2021 +0100
@@ -203,19 +203,12 @@
 </dl>
 <a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a>
 <h4>Queues.__getCommitMessage</h4>
-<b>__getCommitMessage</b>(<i>repodir</i>)
+<b>__getCommitMessage</b>(<i></i>)
 
 <p>
         Private method to get the commit message of the current patch.
 </p>
 <dl>
-
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
-</dl>
-<dl>
 <dt>Returns:</dt>
 <dd>
 name of the current patch (string)
@@ -223,19 +216,12 @@
 </dl>
 <a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a>
 <h4>Queues.__getCurrentPatch</h4>
-<b>__getCurrentPatch</b>(<i>repodir</i>)
+<b>__getCurrentPatch</b>(<i></i>)
 
 <p>
         Private method to get the name of the current patch.
 </p>
 <dl>
-
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
-</dl>
-<dl>
 <dt>Returns:</dt>
 <dd>
 name of the current patch (string)
@@ -243,17 +229,13 @@
 </dl>
 <a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a>
 <h4>Queues.__getPatchesList</h4>
-<b>__getPatchesList</b>(<i>repodir, listType, withSummary=False</i>)
+<b>__getPatchesList</b>(<i>listType, withSummary=False</i>)
 
 <p>
         Private method to get a list of patches of a given type.
 </p>
 <dl>
 
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
 <dt><i>listType</i></dt>
 <dd>
 type of patches list to get
@@ -279,17 +261,13 @@
 </dl>
 <a NAME="Queues.getGuardsList" ID="Queues.getGuardsList"></a>
 <h4>Queues.getGuardsList</h4>
-<b>getGuardsList</b>(<i>repodir, allGuards=True</i>)
+<b>getGuardsList</b>(<i>allGuards=True</i>)
 
 <p>
         Public method to get a list of all guards defined.
 </p>
 <dl>
 
-<dt><i>repodir</i></dt>
-<dd>
-directory name of the repository (string)
-</dd>
 <dt><i>allGuards</i></dt>
 <dd>
 flag indicating to get all guards (boolean)
@@ -303,17 +281,13 @@
 </dl>
 <a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a>
 <h4>Queues.hgQueueCreateRenameQueue</h4>
-<b>hgQueueCreateRenameQueue</b>(<i>name, isCreate</i>)
+<b>hgQueueCreateRenameQueue</b>(<i>isCreate</i>)
 
 <p>
         Public method to create a new queue or rename the active queue.
 </p>
 <dl>
 
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
 <dt><i>isCreate</i></dt>
 <dd>
 flag indicating to create a new queue (boolean)
@@ -321,21 +295,14 @@
 </dl>
 <a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a>
 <h4>Queues.hgQueueDeletePatch</h4>
-<b>hgQueueDeletePatch</b>(<i>name</i>)
+<b>hgQueueDeletePatch</b>(<i></i>)
 
 <p>
         Public method to delete a selected unapplied patch.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueDeletePurgeActivateQueue" ID="Queues.hgQueueDeletePurgeActivateQueue"></a>
 <h4>Queues.hgQueueDeletePurgeActivateQueue</h4>
-<b>hgQueueDeletePurgeActivateQueue</b>(<i>name, operation</i>)
+<b>hgQueueDeletePurgeActivateQueue</b>(<i>operation</i>)
 
 <p>
         Public method to delete the reference to a queue and optionally
@@ -343,10 +310,6 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
 <dt><i>operation</i></dt>
 <dd>
 operation to be performed (Queues.QUEUE_DELETE,
@@ -362,130 +325,67 @@
 </dl>
 <a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a>
 <h4>Queues.hgQueueFinishAppliedPatches</h4>
-<b>hgQueueFinishAppliedPatches</b>(<i>name</i>)
+<b>hgQueueFinishAppliedPatches</b>(<i></i>)
 
 <p>
         Public method to finish all applied patches.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueFoldUnappliedPatches" ID="Queues.hgQueueFoldUnappliedPatches"></a>
 <h4>Queues.hgQueueFoldUnappliedPatches</h4>
-<b>hgQueueFoldUnappliedPatches</b>(<i>name</i>)
+<b>hgQueueFoldUnappliedPatches</b>(<i></i>)
 
 <p>
         Public method to fold patches into the current patch.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueGuardsDeactivate" ID="Queues.hgQueueGuardsDeactivate"></a>
 <h4>Queues.hgQueueGuardsDeactivate</h4>
-<b>hgQueueGuardsDeactivate</b>(<i>name</i>)
+<b>hgQueueGuardsDeactivate</b>(<i></i>)
 
 <p>
         Public method to deactivate all active guards.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueGuardsDefine" ID="Queues.hgQueueGuardsDefine"></a>
 <h4>Queues.hgQueueGuardsDefine</h4>
-<b>hgQueueGuardsDefine</b>(<i>name</i>)
+<b>hgQueueGuardsDefine</b>(<i></i>)
 
 <p>
         Public method to define guards for the current or a named patch.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueGuardsDropAll" ID="Queues.hgQueueGuardsDropAll"></a>
 <h4>Queues.hgQueueGuardsDropAll</h4>
-<b>hgQueueGuardsDropAll</b>(<i>name</i>)
+<b>hgQueueGuardsDropAll</b>(<i></i>)
 
 <p>
         Public method to drop all guards of the current or a named patch.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueGuardsIdentifyActive" ID="Queues.hgQueueGuardsIdentifyActive"></a>
 <h4>Queues.hgQueueGuardsIdentifyActive</h4>
-<b>hgQueueGuardsIdentifyActive</b>(<i>name</i>)
+<b>hgQueueGuardsIdentifyActive</b>(<i></i>)
 
 <p>
         Public method to list all active guards.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueGuardsList" ID="Queues.hgQueueGuardsList"></a>
 <h4>Queues.hgQueueGuardsList</h4>
-<b>hgQueueGuardsList</b>(<i>name</i>)
+<b>hgQueueGuardsList</b>(<i></i>)
 
 <p>
         Public method to list the guards for the current or a named patch.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueGuardsListAll" ID="Queues.hgQueueGuardsListAll"></a>
 <h4>Queues.hgQueueGuardsListAll</h4>
-<b>hgQueueGuardsListAll</b>(<i>name</i>)
+<b>hgQueueGuardsListAll</b>(<i></i>)
 
 <p>
         Public method to list all guards of all patches.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueGuardsSetActive" ID="Queues.hgQueueGuardsSetActive"></a>
 <h4>Queues.hgQueueGuardsSetActive</h4>
-<b>hgQueueGuardsSetActive</b>(<i>name</i>)
+<b>hgQueueGuardsSetActive</b>(<i></i>)
 
 <p>
         Public method to set the active guards.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueInit" ID="Queues.hgQueueInit"></a>
 <h4>Queues.hgQueueInit</h4>
 <b>hgQueueInit</b>(<i>name</i>)
@@ -502,49 +402,28 @@
 </dl>
 <a NAME="Queues.hgQueueListPatches" ID="Queues.hgQueueListPatches"></a>
 <h4>Queues.hgQueueListPatches</h4>
-<b>hgQueueListPatches</b>(<i>name</i>)
+<b>hgQueueListPatches</b>(<i></i>)
 
 <p>
         Public method to show a list of all patches.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueListQueues" ID="Queues.hgQueueListQueues"></a>
 <h4>Queues.hgQueueListQueues</h4>
-<b>hgQueueListQueues</b>(<i>name</i>)
+<b>hgQueueListQueues</b>(<i></i>)
 
 <p>
         Public method to list available queues.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueNewPatch" ID="Queues.hgQueueNewPatch"></a>
 <h4>Queues.hgQueueNewPatch</h4>
-<b>hgQueueNewPatch</b>(<i>name</i>)
+<b>hgQueueNewPatch</b>(<i></i>)
 
 <p>
         Public method to create a new named patch.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueuePushPopPatches" ID="Queues.hgQueuePushPopPatches"></a>
 <h4>Queues.hgQueuePushPopPatches</h4>
-<b>hgQueuePushPopPatches</b>(<i>name, operation, doAll=False, named=False, force=False</i>)
+<b>hgQueuePushPopPatches</b>(<i>operation, doAll=False, named=False, force=False</i>)
 
 <p>
         Public method to push patches onto the stack or pop patches off the
@@ -552,10 +431,6 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
 <dt><i>operation</i></dt>
 <dd>
 operation type to be performed (Queues.POP,
@@ -590,17 +465,13 @@
 </dl>
 <a NAME="Queues.hgQueueRefreshPatch" ID="Queues.hgQueueRefreshPatch"></a>
 <h4>Queues.hgQueueRefreshPatch</h4>
-<b>hgQueueRefreshPatch</b>(<i>name, editMessage=False</i>)
+<b>hgQueueRefreshPatch</b>(<i>editMessage=False</i>)
 
 <p>
         Public method to refresh the current patch.
 </p>
 <dl>
 
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
 <dt><i>editMessage</i></dt>
 <dd>
 flag indicating to edit the current
@@ -609,32 +480,18 @@
 </dl>
 <a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a>
 <h4>Queues.hgQueueRenamePatch</h4>
-<b>hgQueueRenamePatch</b>(<i>name</i>)
+<b>hgQueueRenamePatch</b>(<i></i>)
 
 <p>
         Public method to rename the current or a selected patch.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueShowHeader" ID="Queues.hgQueueShowHeader"></a>
 <h4>Queues.hgQueueShowHeader</h4>
-<b>hgQueueShowHeader</b>(<i>name</i>)
+<b>hgQueueShowHeader</b>(<i></i>)
 
 <p>
         Public method to show the commit message of the current patch.
 </p>
-<dl>
-
-<dt><i>name</i></dt>
-<dd>
-file/directory name (string)
-</dd>
-</dl>
 <a NAME="Queues.hgQueueShowPatch" ID="Queues.hgQueueShowPatch"></a>
 <h4>Queues.hgQueueShowPatch</h4>
 <b>hgQueueShowPatch</b>(<i>name</i>)

eric ide

mercurial