Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7900
72b88fb20261
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues</h1>
24
23 <p> 25 <p>
24 Module implementing the queues extension interface. 26 Module implementing the queues extension interface.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#Queues">Queues</a></td> 38 <td><a href="#Queues">Queues</a></td>
34 <td>Class implementing the queues extension interface.</td> 39 <td>Class implementing the queues extension interface.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="Queues" ID="Queues"></a> 49 <a NAME="Queues" ID="Queues"></a>
43 <h2>Queues</h2> 50 <h2>Queues</h2>
51
44 <p> 52 <p>
45 Class implementing the queues extension interface. 53 Class implementing the queues extension interface.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 HgExtension 56 HgExtension
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>APPLIED_LIST</td></tr><tr><td>GOTO</td></tr><tr><td>POP</td></tr><tr><td>PUSH</td></tr><tr><td>QUEUE_ACTIVATE</td></tr><tr><td>QUEUE_DELETE</td></tr><tr><td>QUEUE_PURGE</td></tr><tr><td>SERIES_LIST</td></tr><tr><td>UNAPPLIED_LIST</td></tr> 60 <tr><td>APPLIED_LIST</td></tr><tr><td>GOTO</td></tr><tr><td>POP</td></tr><tr><td>PUSH</td></tr><tr><td>QUEUE_ACTIVATE</td></tr><tr><td>QUEUE_DELETE</td></tr><tr><td>QUEUE_PURGE</td></tr><tr><td>SERIES_LIST</td></tr><tr><td>UNAPPLIED_LIST</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
68
58 <table> 69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#Queues.__init__">Queues</a></td> 72 <td><a href="#Queues.__init__">Queues</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#Queues.__getCommitMessage">__getCommitMessage</a></td> 76 <td><a href="#Queues.__getCommitMessage">__getCommitMessage</a></td>
64 <td>Private method to get the commit message of the current patch.</td> 77 <td>Private method to get the commit message of the current patch.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#Queues.__getCurrentPatch">__getCurrentPatch</a></td> 80 <td><a href="#Queues.__getCurrentPatch">__getCurrentPatch</a></td>
67 <td>Private method to get the name of the current patch.</td> 81 <td>Private method to get the name of the current patch.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#Queues.__getPatchesList">__getPatchesList</a></td> 84 <td><a href="#Queues.__getPatchesList">__getPatchesList</a></td>
70 <td>Private method to get a list of patches of a given type.</td> 85 <td>Private method to get a list of patches of a given type.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#Queues.getGuardsList">getGuardsList</a></td> 88 <td><a href="#Queues.getGuardsList">getGuardsList</a></td>
73 <td>Public method to get a list of all guards defined.</td> 89 <td>Public method to get a list of all guards defined.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#Queues.hgQueueCreateRenameQueue">hgQueueCreateRenameQueue</a></td> 92 <td><a href="#Queues.hgQueueCreateRenameQueue">hgQueueCreateRenameQueue</a></td>
76 <td>Public method to create a new queue or rename the active queue.</td> 93 <td>Public method to create a new queue or rename the active queue.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#Queues.hgQueueDeletePatch">hgQueueDeletePatch</a></td> 96 <td><a href="#Queues.hgQueueDeletePatch">hgQueueDeletePatch</a></td>
79 <td>Public method to delete a selected unapplied patch.</td> 97 <td>Public method to delete a selected unapplied patch.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#Queues.hgQueueDeletePurgeActivateQueue">hgQueueDeletePurgeActivateQueue</a></td> 100 <td><a href="#Queues.hgQueueDeletePurgeActivateQueue">hgQueueDeletePurgeActivateQueue</a></td>
82 <td>Public method to delete the reference to a queue and optionally remove the patch directory or set the active queue.</td> 101 <td>Public method to delete the reference to a queue and optionally remove the patch directory or set the active queue.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#Queues.hgQueueFinishAppliedPatches">hgQueueFinishAppliedPatches</a></td> 104 <td><a href="#Queues.hgQueueFinishAppliedPatches">hgQueueFinishAppliedPatches</a></td>
85 <td>Public method to finish all applied patches.</td> 105 <td>Public method to finish all applied patches.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#Queues.hgQueueFoldUnappliedPatches">hgQueueFoldUnappliedPatches</a></td> 108 <td><a href="#Queues.hgQueueFoldUnappliedPatches">hgQueueFoldUnappliedPatches</a></td>
88 <td>Public method to fold patches into the current patch.</td> 109 <td>Public method to fold patches into the current patch.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#Queues.hgQueueGuardsDeactivate">hgQueueGuardsDeactivate</a></td> 112 <td><a href="#Queues.hgQueueGuardsDeactivate">hgQueueGuardsDeactivate</a></td>
91 <td>Public method to deactivate all active guards.</td> 113 <td>Public method to deactivate all active guards.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#Queues.hgQueueGuardsDefine">hgQueueGuardsDefine</a></td> 116 <td><a href="#Queues.hgQueueGuardsDefine">hgQueueGuardsDefine</a></td>
94 <td>Public method to define guards for the current or a named patch.</td> 117 <td>Public method to define guards for the current or a named patch.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#Queues.hgQueueGuardsDropAll">hgQueueGuardsDropAll</a></td> 120 <td><a href="#Queues.hgQueueGuardsDropAll">hgQueueGuardsDropAll</a></td>
97 <td>Public method to drop all guards of the current or a named patch.</td> 121 <td>Public method to drop all guards of the current or a named patch.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#Queues.hgQueueGuardsIdentifyActive">hgQueueGuardsIdentifyActive</a></td> 124 <td><a href="#Queues.hgQueueGuardsIdentifyActive">hgQueueGuardsIdentifyActive</a></td>
100 <td>Public method to list all active guards.</td> 125 <td>Public method to list all active guards.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#Queues.hgQueueGuardsList">hgQueueGuardsList</a></td> 128 <td><a href="#Queues.hgQueueGuardsList">hgQueueGuardsList</a></td>
103 <td>Public method to list the guards for the current or a named patch.</td> 129 <td>Public method to list the guards for the current or a named patch.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#Queues.hgQueueGuardsListAll">hgQueueGuardsListAll</a></td> 132 <td><a href="#Queues.hgQueueGuardsListAll">hgQueueGuardsListAll</a></td>
106 <td>Public method to list all guards of all patches.</td> 133 <td>Public method to list all guards of all patches.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#Queues.hgQueueGuardsSetActive">hgQueueGuardsSetActive</a></td> 136 <td><a href="#Queues.hgQueueGuardsSetActive">hgQueueGuardsSetActive</a></td>
109 <td>Public method to set the active guards.</td> 137 <td>Public method to set the active guards.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#Queues.hgQueueInit">hgQueueInit</a></td> 140 <td><a href="#Queues.hgQueueInit">hgQueueInit</a></td>
112 <td>Public method to initialize a new queue repository.</td> 141 <td>Public method to initialize a new queue repository.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#Queues.hgQueueListPatches">hgQueueListPatches</a></td> 144 <td><a href="#Queues.hgQueueListPatches">hgQueueListPatches</a></td>
115 <td>Public method to show a list of all patches.</td> 145 <td>Public method to show a list of all patches.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#Queues.hgQueueListQueues">hgQueueListQueues</a></td> 148 <td><a href="#Queues.hgQueueListQueues">hgQueueListQueues</a></td>
118 <td>Public method to list available queues.</td> 149 <td>Public method to list available queues.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#Queues.hgQueueNewPatch">hgQueueNewPatch</a></td> 152 <td><a href="#Queues.hgQueueNewPatch">hgQueueNewPatch</a></td>
121 <td>Public method to create a new named patch.</td> 153 <td>Public method to create a new named patch.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#Queues.hgQueuePushPopPatches">hgQueuePushPopPatches</a></td> 156 <td><a href="#Queues.hgQueuePushPopPatches">hgQueuePushPopPatches</a></td>
124 <td>Public method to push patches onto the stack or pop patches off the stack.</td> 157 <td>Public method to push patches onto the stack or pop patches off the stack.</td>
125 </tr><tr> 158 </tr>
159 <tr>
126 <td><a href="#Queues.hgQueueRefreshPatch">hgQueueRefreshPatch</a></td> 160 <td><a href="#Queues.hgQueueRefreshPatch">hgQueueRefreshPatch</a></td>
127 <td>Public method to refresh the current patch.</td> 161 <td>Public method to refresh the current patch.</td>
128 </tr><tr> 162 </tr>
163 <tr>
129 <td><a href="#Queues.hgQueueRenamePatch">hgQueueRenamePatch</a></td> 164 <td><a href="#Queues.hgQueueRenamePatch">hgQueueRenamePatch</a></td>
130 <td>Public method to rename the current or a selected patch.</td> 165 <td>Public method to rename the current or a selected patch.</td>
131 </tr><tr> 166 </tr>
167 <tr>
132 <td><a href="#Queues.hgQueueShowHeader">hgQueueShowHeader</a></td> 168 <td><a href="#Queues.hgQueueShowHeader">hgQueueShowHeader</a></td>
133 <td>Public method to show the commit message of the current patch.</td> 169 <td>Public method to show the commit message of the current patch.</td>
134 </tr><tr> 170 </tr>
171 <tr>
135 <td><a href="#Queues.hgQueueShowPatch">hgQueueShowPatch</a></td> 172 <td><a href="#Queues.hgQueueShowPatch">hgQueueShowPatch</a></td>
136 <td>Public method to show the contents of the current patch.</td> 173 <td>Public method to show the contents of the current patch.</td>
137 </tr><tr> 174 </tr>
175 <tr>
138 <td><a href="#Queues.hgQueueStatus">hgQueueStatus</a></td> 176 <td><a href="#Queues.hgQueueStatus">hgQueueStatus</a></td>
139 <td>Public method used to view the status of a queue repository.</td> 177 <td>Public method used to view the status of a queue repository.</td>
140 </tr><tr> 178 </tr>
179 <tr>
141 <td><a href="#Queues.shutdown">shutdown</a></td> 180 <td><a href="#Queues.shutdown">shutdown</a></td>
142 <td>Public method used to shutdown the queues interface.</td> 181 <td>Public method used to shutdown the queues interface.</td>
143 </tr> 182 </tr>
144 </table> 183 </table>
145 <h3>Static Methods</h3> 184 <h3>Static Methods</h3>
185
146 <table> 186 <table>
147 <tr><td>None</td></tr> 187 <tr><td>None</td></tr>
148 </table> 188 </table>
189
149 <a NAME="Queues.__init__" ID="Queues.__init__"></a> 190 <a NAME="Queues.__init__" ID="Queues.__init__"></a>
150 <h4>Queues (Constructor)</h4> 191 <h4>Queues (Constructor)</h4>
151 <b>Queues</b>(<i>vcs</i>) 192 <b>Queues</b>(<i>vcs</i>)
193
152 <p> 194 <p>
153 Constructor 195 Constructor
154 </p><dl> 196 </p>
197 <dl>
198
155 <dt><i>vcs</i></dt> 199 <dt><i>vcs</i></dt>
156 <dd> 200 <dd>
157 reference to the Mercurial vcs object 201 reference to the Mercurial vcs object
158 </dd> 202 </dd>
159 </dl><a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a> 203 </dl>
204 <a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a>
160 <h4>Queues.__getCommitMessage</h4> 205 <h4>Queues.__getCommitMessage</h4>
161 <b>__getCommitMessage</b>(<i>repodir</i>) 206 <b>__getCommitMessage</b>(<i>repodir</i>)
207
162 <p> 208 <p>
163 Private method to get the commit message of the current patch. 209 Private method to get the commit message of the current patch.
164 </p><dl> 210 </p>
211 <dl>
212
165 <dt><i>repodir</i></dt> 213 <dt><i>repodir</i></dt>
166 <dd> 214 <dd>
167 directory name of the repository (string) 215 directory name of the repository (string)
168 </dd> 216 </dd>
169 </dl><dl> 217 </dl>
218 <dl>
170 <dt>Returns:</dt> 219 <dt>Returns:</dt>
171 <dd> 220 <dd>
172 name of the current patch (string) 221 name of the current patch (string)
173 </dd> 222 </dd>
174 </dl><a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a> 223 </dl>
224 <a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a>
175 <h4>Queues.__getCurrentPatch</h4> 225 <h4>Queues.__getCurrentPatch</h4>
176 <b>__getCurrentPatch</b>(<i>repodir</i>) 226 <b>__getCurrentPatch</b>(<i>repodir</i>)
227
177 <p> 228 <p>
178 Private method to get the name of the current patch. 229 Private method to get the name of the current patch.
179 </p><dl> 230 </p>
231 <dl>
232
180 <dt><i>repodir</i></dt> 233 <dt><i>repodir</i></dt>
181 <dd> 234 <dd>
182 directory name of the repository (string) 235 directory name of the repository (string)
183 </dd> 236 </dd>
184 </dl><dl> 237 </dl>
238 <dl>
185 <dt>Returns:</dt> 239 <dt>Returns:</dt>
186 <dd> 240 <dd>
187 name of the current patch (string) 241 name of the current patch (string)
188 </dd> 242 </dd>
189 </dl><a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a> 243 </dl>
244 <a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a>
190 <h4>Queues.__getPatchesList</h4> 245 <h4>Queues.__getPatchesList</h4>
191 <b>__getPatchesList</b>(<i>repodir, listType, withSummary=False</i>) 246 <b>__getPatchesList</b>(<i>repodir, listType, withSummary=False</i>)
247
192 <p> 248 <p>
193 Private method to get a list of patches of a given type. 249 Private method to get a list of patches of a given type.
194 </p><dl> 250 </p>
251 <dl>
252
195 <dt><i>repodir</i></dt> 253 <dt><i>repodir</i></dt>
196 <dd> 254 <dd>
197 directory name of the repository (string) 255 directory name of the repository (string)
198 </dd><dt><i>listType</i></dt> 256 </dd>
257 <dt><i>listType</i></dt>
199 <dd> 258 <dd>
200 type of patches list to get 259 type of patches list to get
201 (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST) 260 (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST)
202 </dd><dt><i>withSummary</i></dt> 261 </dd>
262 <dt><i>withSummary</i></dt>
203 <dd> 263 <dd>
204 flag indicating to get a summary as well (boolean) 264 flag indicating to get a summary as well (boolean)
205 </dd> 265 </dd>
206 </dl><dl> 266 </dl>
267 <dl>
207 <dt>Returns:</dt> 268 <dt>Returns:</dt>
208 <dd> 269 <dd>
209 list of patches (list of string) 270 list of patches (list of string)
210 </dd> 271 </dd>
211 </dl><dl> 272 </dl>
273 <dl>
274
212 <dt>Raises <b>ValueError</b>:</dt> 275 <dt>Raises <b>ValueError</b>:</dt>
213 <dd> 276 <dd>
214 raised to indicate an invalid patch list type 277 raised to indicate an invalid patch list type
215 </dd> 278 </dd>
216 </dl><a NAME="Queues.getGuardsList" ID="Queues.getGuardsList"></a> 279 </dl>
280 <a NAME="Queues.getGuardsList" ID="Queues.getGuardsList"></a>
217 <h4>Queues.getGuardsList</h4> 281 <h4>Queues.getGuardsList</h4>
218 <b>getGuardsList</b>(<i>repodir, allGuards=True</i>) 282 <b>getGuardsList</b>(<i>repodir, allGuards=True</i>)
283
219 <p> 284 <p>
220 Public method to get a list of all guards defined. 285 Public method to get a list of all guards defined.
221 </p><dl> 286 </p>
287 <dl>
288
222 <dt><i>repodir</i></dt> 289 <dt><i>repodir</i></dt>
223 <dd> 290 <dd>
224 directory name of the repository (string) 291 directory name of the repository (string)
225 </dd><dt><i>allGuards</i></dt> 292 </dd>
293 <dt><i>allGuards</i></dt>
226 <dd> 294 <dd>
227 flag indicating to get all guards (boolean) 295 flag indicating to get all guards (boolean)
228 </dd> 296 </dd>
229 </dl><dl> 297 </dl>
298 <dl>
230 <dt>Returns:</dt> 299 <dt>Returns:</dt>
231 <dd> 300 <dd>
232 sorted list of guards (list of strings) 301 sorted list of guards (list of strings)
233 </dd> 302 </dd>
234 </dl><a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a> 303 </dl>
304 <a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a>
235 <h4>Queues.hgQueueCreateRenameQueue</h4> 305 <h4>Queues.hgQueueCreateRenameQueue</h4>
236 <b>hgQueueCreateRenameQueue</b>(<i>name, isCreate</i>) 306 <b>hgQueueCreateRenameQueue</b>(<i>name, isCreate</i>)
307
237 <p> 308 <p>
238 Public method to create a new queue or rename the active queue. 309 Public method to create a new queue or rename the active queue.
239 </p><dl> 310 </p>
240 <dt><i>name</i></dt> 311 <dl>
241 <dd> 312
242 file/directory name (string) 313 <dt><i>name</i></dt>
243 </dd><dt><i>isCreate</i></dt> 314 <dd>
315 file/directory name (string)
316 </dd>
317 <dt><i>isCreate</i></dt>
244 <dd> 318 <dd>
245 flag indicating to create a new queue (boolean) 319 flag indicating to create a new queue (boolean)
246 </dd> 320 </dd>
247 </dl><a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a> 321 </dl>
322 <a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a>
248 <h4>Queues.hgQueueDeletePatch</h4> 323 <h4>Queues.hgQueueDeletePatch</h4>
249 <b>hgQueueDeletePatch</b>(<i>name</i>) 324 <b>hgQueueDeletePatch</b>(<i>name</i>)
325
250 <p> 326 <p>
251 Public method to delete a selected unapplied patch. 327 Public method to delete a selected unapplied patch.
252 </p><dl> 328 </p>
253 <dt><i>name</i></dt> 329 <dl>
254 <dd> 330
255 file/directory name (string) 331 <dt><i>name</i></dt>
256 </dd> 332 <dd>
257 </dl><a NAME="Queues.hgQueueDeletePurgeActivateQueue" ID="Queues.hgQueueDeletePurgeActivateQueue"></a> 333 file/directory name (string)
334 </dd>
335 </dl>
336 <a NAME="Queues.hgQueueDeletePurgeActivateQueue" ID="Queues.hgQueueDeletePurgeActivateQueue"></a>
258 <h4>Queues.hgQueueDeletePurgeActivateQueue</h4> 337 <h4>Queues.hgQueueDeletePurgeActivateQueue</h4>
259 <b>hgQueueDeletePurgeActivateQueue</b>(<i>name, operation</i>) 338 <b>hgQueueDeletePurgeActivateQueue</b>(<i>name, operation</i>)
339
260 <p> 340 <p>
261 Public method to delete the reference to a queue and optionally 341 Public method to delete the reference to a queue and optionally
262 remove the patch directory or set the active queue. 342 remove the patch directory or set the active queue.
263 </p><dl> 343 </p>
264 <dt><i>name</i></dt> 344 <dl>
265 <dd> 345
266 file/directory name (string) 346 <dt><i>name</i></dt>
267 </dd><dt><i>operation</i></dt> 347 <dd>
348 file/directory name (string)
349 </dd>
350 <dt><i>operation</i></dt>
268 <dd> 351 <dd>
269 operation to be performed (Queues.QUEUE_DELETE, 352 operation to be performed (Queues.QUEUE_DELETE,
270 Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE) 353 Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE)
271 </dd> 354 </dd>
272 </dl><dl> 355 </dl>
356 <dl>
357
273 <dt>Raises <b>ValueError</b>:</dt> 358 <dt>Raises <b>ValueError</b>:</dt>
274 <dd> 359 <dd>
275 raised to indicate an invalid operation 360 raised to indicate an invalid operation
276 </dd> 361 </dd>
277 </dl><a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a> 362 </dl>
363 <a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a>
278 <h4>Queues.hgQueueFinishAppliedPatches</h4> 364 <h4>Queues.hgQueueFinishAppliedPatches</h4>
279 <b>hgQueueFinishAppliedPatches</b>(<i>name</i>) 365 <b>hgQueueFinishAppliedPatches</b>(<i>name</i>)
366
280 <p> 367 <p>
281 Public method to finish all applied patches. 368 Public method to finish all applied patches.
282 </p><dl> 369 </p>
283 <dt><i>name</i></dt> 370 <dl>
284 <dd> 371
285 file/directory name (string) 372 <dt><i>name</i></dt>
286 </dd> 373 <dd>
287 </dl><a NAME="Queues.hgQueueFoldUnappliedPatches" ID="Queues.hgQueueFoldUnappliedPatches"></a> 374 file/directory name (string)
375 </dd>
376 </dl>
377 <a NAME="Queues.hgQueueFoldUnappliedPatches" ID="Queues.hgQueueFoldUnappliedPatches"></a>
288 <h4>Queues.hgQueueFoldUnappliedPatches</h4> 378 <h4>Queues.hgQueueFoldUnappliedPatches</h4>
289 <b>hgQueueFoldUnappliedPatches</b>(<i>name</i>) 379 <b>hgQueueFoldUnappliedPatches</b>(<i>name</i>)
380
290 <p> 381 <p>
291 Public method to fold patches into the current patch. 382 Public method to fold patches into the current patch.
292 </p><dl> 383 </p>
293 <dt><i>name</i></dt> 384 <dl>
294 <dd> 385
295 file/directory name (string) 386 <dt><i>name</i></dt>
296 </dd> 387 <dd>
297 </dl><a NAME="Queues.hgQueueGuardsDeactivate" ID="Queues.hgQueueGuardsDeactivate"></a> 388 file/directory name (string)
389 </dd>
390 </dl>
391 <a NAME="Queues.hgQueueGuardsDeactivate" ID="Queues.hgQueueGuardsDeactivate"></a>
298 <h4>Queues.hgQueueGuardsDeactivate</h4> 392 <h4>Queues.hgQueueGuardsDeactivate</h4>
299 <b>hgQueueGuardsDeactivate</b>(<i>name</i>) 393 <b>hgQueueGuardsDeactivate</b>(<i>name</i>)
394
300 <p> 395 <p>
301 Public method to deactivate all active guards. 396 Public method to deactivate all active guards.
302 </p><dl> 397 </p>
303 <dt><i>name</i></dt> 398 <dl>
304 <dd> 399
305 file/directory name (string) 400 <dt><i>name</i></dt>
306 </dd> 401 <dd>
307 </dl><a NAME="Queues.hgQueueGuardsDefine" ID="Queues.hgQueueGuardsDefine"></a> 402 file/directory name (string)
403 </dd>
404 </dl>
405 <a NAME="Queues.hgQueueGuardsDefine" ID="Queues.hgQueueGuardsDefine"></a>
308 <h4>Queues.hgQueueGuardsDefine</h4> 406 <h4>Queues.hgQueueGuardsDefine</h4>
309 <b>hgQueueGuardsDefine</b>(<i>name</i>) 407 <b>hgQueueGuardsDefine</b>(<i>name</i>)
408
310 <p> 409 <p>
311 Public method to define guards for the current or a named patch. 410 Public method to define guards for the current or a named patch.
312 </p><dl> 411 </p>
313 <dt><i>name</i></dt> 412 <dl>
314 <dd> 413
315 file/directory name (string) 414 <dt><i>name</i></dt>
316 </dd> 415 <dd>
317 </dl><a NAME="Queues.hgQueueGuardsDropAll" ID="Queues.hgQueueGuardsDropAll"></a> 416 file/directory name (string)
417 </dd>
418 </dl>
419 <a NAME="Queues.hgQueueGuardsDropAll" ID="Queues.hgQueueGuardsDropAll"></a>
318 <h4>Queues.hgQueueGuardsDropAll</h4> 420 <h4>Queues.hgQueueGuardsDropAll</h4>
319 <b>hgQueueGuardsDropAll</b>(<i>name</i>) 421 <b>hgQueueGuardsDropAll</b>(<i>name</i>)
422
320 <p> 423 <p>
321 Public method to drop all guards of the current or a named patch. 424 Public method to drop all guards of the current or a named patch.
322 </p><dl> 425 </p>
323 <dt><i>name</i></dt> 426 <dl>
324 <dd> 427
325 file/directory name (string) 428 <dt><i>name</i></dt>
326 </dd> 429 <dd>
327 </dl><a NAME="Queues.hgQueueGuardsIdentifyActive" ID="Queues.hgQueueGuardsIdentifyActive"></a> 430 file/directory name (string)
431 </dd>
432 </dl>
433 <a NAME="Queues.hgQueueGuardsIdentifyActive" ID="Queues.hgQueueGuardsIdentifyActive"></a>
328 <h4>Queues.hgQueueGuardsIdentifyActive</h4> 434 <h4>Queues.hgQueueGuardsIdentifyActive</h4>
329 <b>hgQueueGuardsIdentifyActive</b>(<i>name</i>) 435 <b>hgQueueGuardsIdentifyActive</b>(<i>name</i>)
436
330 <p> 437 <p>
331 Public method to list all active guards. 438 Public method to list all active guards.
332 </p><dl> 439 </p>
333 <dt><i>name</i></dt> 440 <dl>
334 <dd> 441
335 file/directory name (string) 442 <dt><i>name</i></dt>
336 </dd> 443 <dd>
337 </dl><a NAME="Queues.hgQueueGuardsList" ID="Queues.hgQueueGuardsList"></a> 444 file/directory name (string)
445 </dd>
446 </dl>
447 <a NAME="Queues.hgQueueGuardsList" ID="Queues.hgQueueGuardsList"></a>
338 <h4>Queues.hgQueueGuardsList</h4> 448 <h4>Queues.hgQueueGuardsList</h4>
339 <b>hgQueueGuardsList</b>(<i>name</i>) 449 <b>hgQueueGuardsList</b>(<i>name</i>)
450
340 <p> 451 <p>
341 Public method to list the guards for the current or a named patch. 452 Public method to list the guards for the current or a named patch.
342 </p><dl> 453 </p>
343 <dt><i>name</i></dt> 454 <dl>
344 <dd> 455
345 file/directory name (string) 456 <dt><i>name</i></dt>
346 </dd> 457 <dd>
347 </dl><a NAME="Queues.hgQueueGuardsListAll" ID="Queues.hgQueueGuardsListAll"></a> 458 file/directory name (string)
459 </dd>
460 </dl>
461 <a NAME="Queues.hgQueueGuardsListAll" ID="Queues.hgQueueGuardsListAll"></a>
348 <h4>Queues.hgQueueGuardsListAll</h4> 462 <h4>Queues.hgQueueGuardsListAll</h4>
349 <b>hgQueueGuardsListAll</b>(<i>name</i>) 463 <b>hgQueueGuardsListAll</b>(<i>name</i>)
464
350 <p> 465 <p>
351 Public method to list all guards of all patches. 466 Public method to list all guards of all patches.
352 </p><dl> 467 </p>
353 <dt><i>name</i></dt> 468 <dl>
354 <dd> 469
355 file/directory name (string) 470 <dt><i>name</i></dt>
356 </dd> 471 <dd>
357 </dl><a NAME="Queues.hgQueueGuardsSetActive" ID="Queues.hgQueueGuardsSetActive"></a> 472 file/directory name (string)
473 </dd>
474 </dl>
475 <a NAME="Queues.hgQueueGuardsSetActive" ID="Queues.hgQueueGuardsSetActive"></a>
358 <h4>Queues.hgQueueGuardsSetActive</h4> 476 <h4>Queues.hgQueueGuardsSetActive</h4>
359 <b>hgQueueGuardsSetActive</b>(<i>name</i>) 477 <b>hgQueueGuardsSetActive</b>(<i>name</i>)
478
360 <p> 479 <p>
361 Public method to set the active guards. 480 Public method to set the active guards.
362 </p><dl> 481 </p>
363 <dt><i>name</i></dt> 482 <dl>
364 <dd> 483
365 file/directory name (string) 484 <dt><i>name</i></dt>
366 </dd> 485 <dd>
367 </dl><a NAME="Queues.hgQueueInit" ID="Queues.hgQueueInit"></a> 486 file/directory name (string)
487 </dd>
488 </dl>
489 <a NAME="Queues.hgQueueInit" ID="Queues.hgQueueInit"></a>
368 <h4>Queues.hgQueueInit</h4> 490 <h4>Queues.hgQueueInit</h4>
369 <b>hgQueueInit</b>(<i>name</i>) 491 <b>hgQueueInit</b>(<i>name</i>)
492
370 <p> 493 <p>
371 Public method to initialize a new queue repository. 494 Public method to initialize a new queue repository.
372 </p><dl> 495 </p>
496 <dl>
497
373 <dt><i>name</i></dt> 498 <dt><i>name</i></dt>
374 <dd> 499 <dd>
375 directory name (string) 500 directory name (string)
376 </dd> 501 </dd>
377 </dl><a NAME="Queues.hgQueueListPatches" ID="Queues.hgQueueListPatches"></a> 502 </dl>
503 <a NAME="Queues.hgQueueListPatches" ID="Queues.hgQueueListPatches"></a>
378 <h4>Queues.hgQueueListPatches</h4> 504 <h4>Queues.hgQueueListPatches</h4>
379 <b>hgQueueListPatches</b>(<i>name</i>) 505 <b>hgQueueListPatches</b>(<i>name</i>)
506
380 <p> 507 <p>
381 Public method to show a list of all patches. 508 Public method to show a list of all patches.
382 </p><dl> 509 </p>
383 <dt><i>name</i></dt> 510 <dl>
384 <dd> 511
385 file/directory name (string) 512 <dt><i>name</i></dt>
386 </dd> 513 <dd>
387 </dl><a NAME="Queues.hgQueueListQueues" ID="Queues.hgQueueListQueues"></a> 514 file/directory name (string)
515 </dd>
516 </dl>
517 <a NAME="Queues.hgQueueListQueues" ID="Queues.hgQueueListQueues"></a>
388 <h4>Queues.hgQueueListQueues</h4> 518 <h4>Queues.hgQueueListQueues</h4>
389 <b>hgQueueListQueues</b>(<i>name</i>) 519 <b>hgQueueListQueues</b>(<i>name</i>)
520
390 <p> 521 <p>
391 Public method to list available queues. 522 Public method to list available queues.
392 </p><dl> 523 </p>
393 <dt><i>name</i></dt> 524 <dl>
394 <dd> 525
395 file/directory name (string) 526 <dt><i>name</i></dt>
396 </dd> 527 <dd>
397 </dl><a NAME="Queues.hgQueueNewPatch" ID="Queues.hgQueueNewPatch"></a> 528 file/directory name (string)
529 </dd>
530 </dl>
531 <a NAME="Queues.hgQueueNewPatch" ID="Queues.hgQueueNewPatch"></a>
398 <h4>Queues.hgQueueNewPatch</h4> 532 <h4>Queues.hgQueueNewPatch</h4>
399 <b>hgQueueNewPatch</b>(<i>name</i>) 533 <b>hgQueueNewPatch</b>(<i>name</i>)
534
400 <p> 535 <p>
401 Public method to create a new named patch. 536 Public method to create a new named patch.
402 </p><dl> 537 </p>
403 <dt><i>name</i></dt> 538 <dl>
404 <dd> 539
405 file/directory name (string) 540 <dt><i>name</i></dt>
406 </dd> 541 <dd>
407 </dl><a NAME="Queues.hgQueuePushPopPatches" ID="Queues.hgQueuePushPopPatches"></a> 542 file/directory name (string)
543 </dd>
544 </dl>
545 <a NAME="Queues.hgQueuePushPopPatches" ID="Queues.hgQueuePushPopPatches"></a>
408 <h4>Queues.hgQueuePushPopPatches</h4> 546 <h4>Queues.hgQueuePushPopPatches</h4>
409 <b>hgQueuePushPopPatches</b>(<i>name, operation, doAll=False, named=False, force=False</i>) 547 <b>hgQueuePushPopPatches</b>(<i>name, operation, doAll=False, named=False, force=False</i>)
548
410 <p> 549 <p>
411 Public method to push patches onto the stack or pop patches off the 550 Public method to push patches onto the stack or pop patches off the
412 stack. 551 stack.
413 </p><dl> 552 </p>
414 <dt><i>name</i></dt> 553 <dl>
415 <dd> 554
416 file/directory name (string) 555 <dt><i>name</i></dt>
417 </dd><dt><i>operation</i></dt> 556 <dd>
557 file/directory name (string)
558 </dd>
559 <dt><i>operation</i></dt>
418 <dd> 560 <dd>
419 operation type to be performed (Queues.POP, 561 operation type to be performed (Queues.POP,
420 Queues.PUSH, Queues.GOTO) 562 Queues.PUSH, Queues.GOTO)
421 </dd><dt><i>doAll=</i></dt> 563 </dd>
564 <dt><i>doAll=</i></dt>
422 <dd> 565 <dd>
423 flag indicating to push/pop all (boolean) 566 flag indicating to push/pop all (boolean)
424 </dd><dt><i>named=</i></dt> 567 </dd>
568 <dt><i>named=</i></dt>
425 <dd> 569 <dd>
426 flag indicating to push/pop until a named patch 570 flag indicating to push/pop until a named patch
427 is at the top of the stack (boolean) 571 is at the top of the stack (boolean)
428 </dd><dt><i>force=</i></dt> 572 </dd>
573 <dt><i>force=</i></dt>
429 <dd> 574 <dd>
430 flag indicating a forceful pop (boolean) 575 flag indicating a forceful pop (boolean)
431 </dd> 576 </dd>
432 </dl><dl> 577 </dl>
578 <dl>
433 <dt>Returns:</dt> 579 <dt>Returns:</dt>
434 <dd> 580 <dd>
435 flag indicating that the project should be reread (boolean) 581 flag indicating that the project should be reread (boolean)
436 </dd> 582 </dd>
437 </dl><dl> 583 </dl>
584 <dl>
585
438 <dt>Raises <b>ValueError</b>:</dt> 586 <dt>Raises <b>ValueError</b>:</dt>
439 <dd> 587 <dd>
440 raised to indicate an invalid operation 588 raised to indicate an invalid operation
441 </dd> 589 </dd>
442 </dl><a NAME="Queues.hgQueueRefreshPatch" ID="Queues.hgQueueRefreshPatch"></a> 590 </dl>
591 <a NAME="Queues.hgQueueRefreshPatch" ID="Queues.hgQueueRefreshPatch"></a>
443 <h4>Queues.hgQueueRefreshPatch</h4> 592 <h4>Queues.hgQueueRefreshPatch</h4>
444 <b>hgQueueRefreshPatch</b>(<i>name, editMessage=False</i>) 593 <b>hgQueueRefreshPatch</b>(<i>name, editMessage=False</i>)
594
445 <p> 595 <p>
446 Public method to refresh the current patch. 596 Public method to refresh the current patch.
447 </p><dl> 597 </p>
448 <dt><i>name</i></dt> 598 <dl>
449 <dd> 599
450 file/directory name (string) 600 <dt><i>name</i></dt>
451 </dd><dt><i>editMessage</i></dt> 601 <dd>
602 file/directory name (string)
603 </dd>
604 <dt><i>editMessage</i></dt>
452 <dd> 605 <dd>
453 flag indicating to edit the current 606 flag indicating to edit the current
454 commit message (boolean) 607 commit message (boolean)
455 </dd> 608 </dd>
456 </dl><a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a> 609 </dl>
610 <a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a>
457 <h4>Queues.hgQueueRenamePatch</h4> 611 <h4>Queues.hgQueueRenamePatch</h4>
458 <b>hgQueueRenamePatch</b>(<i>name</i>) 612 <b>hgQueueRenamePatch</b>(<i>name</i>)
613
459 <p> 614 <p>
460 Public method to rename the current or a selected patch. 615 Public method to rename the current or a selected patch.
461 </p><dl> 616 </p>
462 <dt><i>name</i></dt> 617 <dl>
463 <dd> 618
464 file/directory name (string) 619 <dt><i>name</i></dt>
465 </dd> 620 <dd>
466 </dl><a NAME="Queues.hgQueueShowHeader" ID="Queues.hgQueueShowHeader"></a> 621 file/directory name (string)
622 </dd>
623 </dl>
624 <a NAME="Queues.hgQueueShowHeader" ID="Queues.hgQueueShowHeader"></a>
467 <h4>Queues.hgQueueShowHeader</h4> 625 <h4>Queues.hgQueueShowHeader</h4>
468 <b>hgQueueShowHeader</b>(<i>name</i>) 626 <b>hgQueueShowHeader</b>(<i>name</i>)
627
469 <p> 628 <p>
470 Public method to show the commit message of the current patch. 629 Public method to show the commit message of the current patch.
471 </p><dl> 630 </p>
472 <dt><i>name</i></dt> 631 <dl>
473 <dd> 632
474 file/directory name (string) 633 <dt><i>name</i></dt>
475 </dd> 634 <dd>
476 </dl><a NAME="Queues.hgQueueShowPatch" ID="Queues.hgQueueShowPatch"></a> 635 file/directory name (string)
636 </dd>
637 </dl>
638 <a NAME="Queues.hgQueueShowPatch" ID="Queues.hgQueueShowPatch"></a>
477 <h4>Queues.hgQueueShowPatch</h4> 639 <h4>Queues.hgQueueShowPatch</h4>
478 <b>hgQueueShowPatch</b>(<i>name</i>) 640 <b>hgQueueShowPatch</b>(<i>name</i>)
641
479 <p> 642 <p>
480 Public method to show the contents of the current patch. 643 Public method to show the contents of the current patch.
481 </p><dl> 644 </p>
482 <dt><i>name</i></dt> 645 <dl>
483 <dd> 646
484 file/directory name (string) 647 <dt><i>name</i></dt>
485 </dd> 648 <dd>
486 </dl><a NAME="Queues.hgQueueStatus" ID="Queues.hgQueueStatus"></a> 649 file/directory name (string)
650 </dd>
651 </dl>
652 <a NAME="Queues.hgQueueStatus" ID="Queues.hgQueueStatus"></a>
487 <h4>Queues.hgQueueStatus</h4> 653 <h4>Queues.hgQueueStatus</h4>
488 <b>hgQueueStatus</b>(<i>name</i>) 654 <b>hgQueueStatus</b>(<i>name</i>)
655
489 <p> 656 <p>
490 Public method used to view the status of a queue repository. 657 Public method used to view the status of a queue repository.
491 </p><dl> 658 </p>
659 <dl>
660
492 <dt><i>name</i></dt> 661 <dt><i>name</i></dt>
493 <dd> 662 <dd>
494 directory name (string) 663 directory name (string)
495 </dd> 664 </dd>
496 </dl><a NAME="Queues.shutdown" ID="Queues.shutdown"></a> 665 </dl>
666 <a NAME="Queues.shutdown" ID="Queues.shutdown"></a>
497 <h4>Queues.shutdown</h4> 667 <h4>Queues.shutdown</h4>
498 <b>shutdown</b>(<i></i>) 668 <b>shutdown</b>(<i></i>)
669
499 <p> 670 <p>
500 Public method used to shutdown the queues interface. 671 Public method used to shutdown the queues interface.
501 </p> 672 </p>
502 <div align="right"><a href="#top">Up</a></div> 673 <div align="right"><a href="#top">Up</a></div>
503 <hr /> 674 <hr />

Mercurial Repository: eric

eric ide

mercurial