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

changeset 7976
a8a20f558176
parent 7900
72b88fb20261
child 7989
a21d673a8f99
equal deleted inserted replaced
7975:7d493839a8fc 7976:a8a20f558176
201 reference to the Mercurial vcs object 201 reference to the Mercurial vcs object
202 </dd> 202 </dd>
203 </dl> 203 </dl>
204 <a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a> 204 <a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a>
205 <h4>Queues.__getCommitMessage</h4> 205 <h4>Queues.__getCommitMessage</h4>
206 <b>__getCommitMessage</b>(<i>repodir</i>) 206 <b>__getCommitMessage</b>(<i></i>)
207 207
208 <p> 208 <p>
209 Private method to get the commit message of the current patch. 209 Private method to get the commit message of the current patch.
210 </p> 210 </p>
211 <dl>
212
213 <dt><i>repodir</i></dt>
214 <dd>
215 directory name of the repository (string)
216 </dd>
217 </dl>
218 <dl> 211 <dl>
219 <dt>Returns:</dt> 212 <dt>Returns:</dt>
220 <dd> 213 <dd>
221 name of the current patch (string) 214 name of the current patch (string)
222 </dd> 215 </dd>
223 </dl> 216 </dl>
224 <a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a> 217 <a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a>
225 <h4>Queues.__getCurrentPatch</h4> 218 <h4>Queues.__getCurrentPatch</h4>
226 <b>__getCurrentPatch</b>(<i>repodir</i>) 219 <b>__getCurrentPatch</b>(<i></i>)
227 220
228 <p> 221 <p>
229 Private method to get the name of the current patch. 222 Private method to get the name of the current patch.
230 </p> 223 </p>
231 <dl>
232
233 <dt><i>repodir</i></dt>
234 <dd>
235 directory name of the repository (string)
236 </dd>
237 </dl>
238 <dl> 224 <dl>
239 <dt>Returns:</dt> 225 <dt>Returns:</dt>
240 <dd> 226 <dd>
241 name of the current patch (string) 227 name of the current patch (string)
242 </dd> 228 </dd>
243 </dl> 229 </dl>
244 <a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a> 230 <a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a>
245 <h4>Queues.__getPatchesList</h4> 231 <h4>Queues.__getPatchesList</h4>
246 <b>__getPatchesList</b>(<i>repodir, listType, withSummary=False</i>) 232 <b>__getPatchesList</b>(<i>listType, withSummary=False</i>)
247 233
248 <p> 234 <p>
249 Private method to get a list of patches of a given type. 235 Private method to get a list of patches of a given type.
250 </p> 236 </p>
251 <dl> 237 <dl>
252 238
253 <dt><i>repodir</i></dt>
254 <dd>
255 directory name of the repository (string)
256 </dd>
257 <dt><i>listType</i></dt> 239 <dt><i>listType</i></dt>
258 <dd> 240 <dd>
259 type of patches list to get 241 type of patches list to get
260 (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST) 242 (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST)
261 </dd> 243 </dd>
277 raised to indicate an invalid patch list type 259 raised to indicate an invalid patch list type
278 </dd> 260 </dd>
279 </dl> 261 </dl>
280 <a NAME="Queues.getGuardsList" ID="Queues.getGuardsList"></a> 262 <a NAME="Queues.getGuardsList" ID="Queues.getGuardsList"></a>
281 <h4>Queues.getGuardsList</h4> 263 <h4>Queues.getGuardsList</h4>
282 <b>getGuardsList</b>(<i>repodir, allGuards=True</i>) 264 <b>getGuardsList</b>(<i>allGuards=True</i>)
283 265
284 <p> 266 <p>
285 Public method to get a list of all guards defined. 267 Public method to get a list of all guards defined.
286 </p> 268 </p>
287 <dl> 269 <dl>
288 270
289 <dt><i>repodir</i></dt>
290 <dd>
291 directory name of the repository (string)
292 </dd>
293 <dt><i>allGuards</i></dt> 271 <dt><i>allGuards</i></dt>
294 <dd> 272 <dd>
295 flag indicating to get all guards (boolean) 273 flag indicating to get all guards (boolean)
296 </dd> 274 </dd>
297 </dl> 275 </dl>
301 sorted list of guards (list of strings) 279 sorted list of guards (list of strings)
302 </dd> 280 </dd>
303 </dl> 281 </dl>
304 <a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a> 282 <a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a>
305 <h4>Queues.hgQueueCreateRenameQueue</h4> 283 <h4>Queues.hgQueueCreateRenameQueue</h4>
306 <b>hgQueueCreateRenameQueue</b>(<i>name, isCreate</i>) 284 <b>hgQueueCreateRenameQueue</b>(<i>isCreate</i>)
307 285
308 <p> 286 <p>
309 Public method to create a new queue or rename the active queue. 287 Public method to create a new queue or rename the active queue.
310 </p> 288 </p>
311 <dl> 289 <dl>
312 290
313 <dt><i>name</i></dt>
314 <dd>
315 file/directory name (string)
316 </dd>
317 <dt><i>isCreate</i></dt> 291 <dt><i>isCreate</i></dt>
318 <dd> 292 <dd>
319 flag indicating to create a new queue (boolean) 293 flag indicating to create a new queue (boolean)
320 </dd> 294 </dd>
321 </dl> 295 </dl>
322 <a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a> 296 <a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a>
323 <h4>Queues.hgQueueDeletePatch</h4> 297 <h4>Queues.hgQueueDeletePatch</h4>
324 <b>hgQueueDeletePatch</b>(<i>name</i>) 298 <b>hgQueueDeletePatch</b>(<i></i>)
325 299
326 <p> 300 <p>
327 Public method to delete a selected unapplied patch. 301 Public method to delete a selected unapplied patch.
328 </p> 302 </p>
329 <dl>
330
331 <dt><i>name</i></dt>
332 <dd>
333 file/directory name (string)
334 </dd>
335 </dl>
336 <a NAME="Queues.hgQueueDeletePurgeActivateQueue" ID="Queues.hgQueueDeletePurgeActivateQueue"></a> 303 <a NAME="Queues.hgQueueDeletePurgeActivateQueue" ID="Queues.hgQueueDeletePurgeActivateQueue"></a>
337 <h4>Queues.hgQueueDeletePurgeActivateQueue</h4> 304 <h4>Queues.hgQueueDeletePurgeActivateQueue</h4>
338 <b>hgQueueDeletePurgeActivateQueue</b>(<i>name, operation</i>) 305 <b>hgQueueDeletePurgeActivateQueue</b>(<i>operation</i>)
339 306
340 <p> 307 <p>
341 Public method to delete the reference to a queue and optionally 308 Public method to delete the reference to a queue and optionally
342 remove the patch directory or set the active queue. 309 remove the patch directory or set the active queue.
343 </p> 310 </p>
344 <dl> 311 <dl>
345 312
346 <dt><i>name</i></dt>
347 <dd>
348 file/directory name (string)
349 </dd>
350 <dt><i>operation</i></dt> 313 <dt><i>operation</i></dt>
351 <dd> 314 <dd>
352 operation to be performed (Queues.QUEUE_DELETE, 315 operation to be performed (Queues.QUEUE_DELETE,
353 Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE) 316 Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE)
354 </dd> 317 </dd>
360 raised to indicate an invalid operation 323 raised to indicate an invalid operation
361 </dd> 324 </dd>
362 </dl> 325 </dl>
363 <a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a> 326 <a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a>
364 <h4>Queues.hgQueueFinishAppliedPatches</h4> 327 <h4>Queues.hgQueueFinishAppliedPatches</h4>
365 <b>hgQueueFinishAppliedPatches</b>(<i>name</i>) 328 <b>hgQueueFinishAppliedPatches</b>(<i></i>)
366 329
367 <p> 330 <p>
368 Public method to finish all applied patches. 331 Public method to finish all applied patches.
369 </p> 332 </p>
370 <dl>
371
372 <dt><i>name</i></dt>
373 <dd>
374 file/directory name (string)
375 </dd>
376 </dl>
377 <a NAME="Queues.hgQueueFoldUnappliedPatches" ID="Queues.hgQueueFoldUnappliedPatches"></a> 333 <a NAME="Queues.hgQueueFoldUnappliedPatches" ID="Queues.hgQueueFoldUnappliedPatches"></a>
378 <h4>Queues.hgQueueFoldUnappliedPatches</h4> 334 <h4>Queues.hgQueueFoldUnappliedPatches</h4>
379 <b>hgQueueFoldUnappliedPatches</b>(<i>name</i>) 335 <b>hgQueueFoldUnappliedPatches</b>(<i></i>)
380 336
381 <p> 337 <p>
382 Public method to fold patches into the current patch. 338 Public method to fold patches into the current patch.
383 </p> 339 </p>
384 <dl>
385
386 <dt><i>name</i></dt>
387 <dd>
388 file/directory name (string)
389 </dd>
390 </dl>
391 <a NAME="Queues.hgQueueGuardsDeactivate" ID="Queues.hgQueueGuardsDeactivate"></a> 340 <a NAME="Queues.hgQueueGuardsDeactivate" ID="Queues.hgQueueGuardsDeactivate"></a>
392 <h4>Queues.hgQueueGuardsDeactivate</h4> 341 <h4>Queues.hgQueueGuardsDeactivate</h4>
393 <b>hgQueueGuardsDeactivate</b>(<i>name</i>) 342 <b>hgQueueGuardsDeactivate</b>(<i></i>)
394 343
395 <p> 344 <p>
396 Public method to deactivate all active guards. 345 Public method to deactivate all active guards.
397 </p> 346 </p>
398 <dl>
399
400 <dt><i>name</i></dt>
401 <dd>
402 file/directory name (string)
403 </dd>
404 </dl>
405 <a NAME="Queues.hgQueueGuardsDefine" ID="Queues.hgQueueGuardsDefine"></a> 347 <a NAME="Queues.hgQueueGuardsDefine" ID="Queues.hgQueueGuardsDefine"></a>
406 <h4>Queues.hgQueueGuardsDefine</h4> 348 <h4>Queues.hgQueueGuardsDefine</h4>
407 <b>hgQueueGuardsDefine</b>(<i>name</i>) 349 <b>hgQueueGuardsDefine</b>(<i></i>)
408 350
409 <p> 351 <p>
410 Public method to define guards for the current or a named patch. 352 Public method to define guards for the current or a named patch.
411 </p> 353 </p>
412 <dl>
413
414 <dt><i>name</i></dt>
415 <dd>
416 file/directory name (string)
417 </dd>
418 </dl>
419 <a NAME="Queues.hgQueueGuardsDropAll" ID="Queues.hgQueueGuardsDropAll"></a> 354 <a NAME="Queues.hgQueueGuardsDropAll" ID="Queues.hgQueueGuardsDropAll"></a>
420 <h4>Queues.hgQueueGuardsDropAll</h4> 355 <h4>Queues.hgQueueGuardsDropAll</h4>
421 <b>hgQueueGuardsDropAll</b>(<i>name</i>) 356 <b>hgQueueGuardsDropAll</b>(<i></i>)
422 357
423 <p> 358 <p>
424 Public method to drop all guards of the current or a named patch. 359 Public method to drop all guards of the current or a named patch.
425 </p> 360 </p>
426 <dl>
427
428 <dt><i>name</i></dt>
429 <dd>
430 file/directory name (string)
431 </dd>
432 </dl>
433 <a NAME="Queues.hgQueueGuardsIdentifyActive" ID="Queues.hgQueueGuardsIdentifyActive"></a> 361 <a NAME="Queues.hgQueueGuardsIdentifyActive" ID="Queues.hgQueueGuardsIdentifyActive"></a>
434 <h4>Queues.hgQueueGuardsIdentifyActive</h4> 362 <h4>Queues.hgQueueGuardsIdentifyActive</h4>
435 <b>hgQueueGuardsIdentifyActive</b>(<i>name</i>) 363 <b>hgQueueGuardsIdentifyActive</b>(<i></i>)
436 364
437 <p> 365 <p>
438 Public method to list all active guards. 366 Public method to list all active guards.
439 </p> 367 </p>
440 <dl>
441
442 <dt><i>name</i></dt>
443 <dd>
444 file/directory name (string)
445 </dd>
446 </dl>
447 <a NAME="Queues.hgQueueGuardsList" ID="Queues.hgQueueGuardsList"></a> 368 <a NAME="Queues.hgQueueGuardsList" ID="Queues.hgQueueGuardsList"></a>
448 <h4>Queues.hgQueueGuardsList</h4> 369 <h4>Queues.hgQueueGuardsList</h4>
449 <b>hgQueueGuardsList</b>(<i>name</i>) 370 <b>hgQueueGuardsList</b>(<i></i>)
450 371
451 <p> 372 <p>
452 Public method to list the guards for the current or a named patch. 373 Public method to list the guards for the current or a named patch.
453 </p> 374 </p>
454 <dl>
455
456 <dt><i>name</i></dt>
457 <dd>
458 file/directory name (string)
459 </dd>
460 </dl>
461 <a NAME="Queues.hgQueueGuardsListAll" ID="Queues.hgQueueGuardsListAll"></a> 375 <a NAME="Queues.hgQueueGuardsListAll" ID="Queues.hgQueueGuardsListAll"></a>
462 <h4>Queues.hgQueueGuardsListAll</h4> 376 <h4>Queues.hgQueueGuardsListAll</h4>
463 <b>hgQueueGuardsListAll</b>(<i>name</i>) 377 <b>hgQueueGuardsListAll</b>(<i></i>)
464 378
465 <p> 379 <p>
466 Public method to list all guards of all patches. 380 Public method to list all guards of all patches.
467 </p> 381 </p>
468 <dl>
469
470 <dt><i>name</i></dt>
471 <dd>
472 file/directory name (string)
473 </dd>
474 </dl>
475 <a NAME="Queues.hgQueueGuardsSetActive" ID="Queues.hgQueueGuardsSetActive"></a> 382 <a NAME="Queues.hgQueueGuardsSetActive" ID="Queues.hgQueueGuardsSetActive"></a>
476 <h4>Queues.hgQueueGuardsSetActive</h4> 383 <h4>Queues.hgQueueGuardsSetActive</h4>
477 <b>hgQueueGuardsSetActive</b>(<i>name</i>) 384 <b>hgQueueGuardsSetActive</b>(<i></i>)
478 385
479 <p> 386 <p>
480 Public method to set the active guards. 387 Public method to set the active guards.
481 </p> 388 </p>
482 <dl>
483
484 <dt><i>name</i></dt>
485 <dd>
486 file/directory name (string)
487 </dd>
488 </dl>
489 <a NAME="Queues.hgQueueInit" ID="Queues.hgQueueInit"></a> 389 <a NAME="Queues.hgQueueInit" ID="Queues.hgQueueInit"></a>
490 <h4>Queues.hgQueueInit</h4> 390 <h4>Queues.hgQueueInit</h4>
491 <b>hgQueueInit</b>(<i>name</i>) 391 <b>hgQueueInit</b>(<i>name</i>)
492 392
493 <p> 393 <p>
500 directory name (string) 400 directory name (string)
501 </dd> 401 </dd>
502 </dl> 402 </dl>
503 <a NAME="Queues.hgQueueListPatches" ID="Queues.hgQueueListPatches"></a> 403 <a NAME="Queues.hgQueueListPatches" ID="Queues.hgQueueListPatches"></a>
504 <h4>Queues.hgQueueListPatches</h4> 404 <h4>Queues.hgQueueListPatches</h4>
505 <b>hgQueueListPatches</b>(<i>name</i>) 405 <b>hgQueueListPatches</b>(<i></i>)
506 406
507 <p> 407 <p>
508 Public method to show a list of all patches. 408 Public method to show a list of all patches.
509 </p> 409 </p>
510 <dl>
511
512 <dt><i>name</i></dt>
513 <dd>
514 file/directory name (string)
515 </dd>
516 </dl>
517 <a NAME="Queues.hgQueueListQueues" ID="Queues.hgQueueListQueues"></a> 410 <a NAME="Queues.hgQueueListQueues" ID="Queues.hgQueueListQueues"></a>
518 <h4>Queues.hgQueueListQueues</h4> 411 <h4>Queues.hgQueueListQueues</h4>
519 <b>hgQueueListQueues</b>(<i>name</i>) 412 <b>hgQueueListQueues</b>(<i></i>)
520 413
521 <p> 414 <p>
522 Public method to list available queues. 415 Public method to list available queues.
523 </p> 416 </p>
524 <dl>
525
526 <dt><i>name</i></dt>
527 <dd>
528 file/directory name (string)
529 </dd>
530 </dl>
531 <a NAME="Queues.hgQueueNewPatch" ID="Queues.hgQueueNewPatch"></a> 417 <a NAME="Queues.hgQueueNewPatch" ID="Queues.hgQueueNewPatch"></a>
532 <h4>Queues.hgQueueNewPatch</h4> 418 <h4>Queues.hgQueueNewPatch</h4>
533 <b>hgQueueNewPatch</b>(<i>name</i>) 419 <b>hgQueueNewPatch</b>(<i></i>)
534 420
535 <p> 421 <p>
536 Public method to create a new named patch. 422 Public method to create a new named patch.
537 </p> 423 </p>
538 <dl>
539
540 <dt><i>name</i></dt>
541 <dd>
542 file/directory name (string)
543 </dd>
544 </dl>
545 <a NAME="Queues.hgQueuePushPopPatches" ID="Queues.hgQueuePushPopPatches"></a> 424 <a NAME="Queues.hgQueuePushPopPatches" ID="Queues.hgQueuePushPopPatches"></a>
546 <h4>Queues.hgQueuePushPopPatches</h4> 425 <h4>Queues.hgQueuePushPopPatches</h4>
547 <b>hgQueuePushPopPatches</b>(<i>name, operation, doAll=False, named=False, force=False</i>) 426 <b>hgQueuePushPopPatches</b>(<i>operation, doAll=False, named=False, force=False</i>)
548 427
549 <p> 428 <p>
550 Public method to push patches onto the stack or pop patches off the 429 Public method to push patches onto the stack or pop patches off the
551 stack. 430 stack.
552 </p> 431 </p>
553 <dl> 432 <dl>
554 433
555 <dt><i>name</i></dt>
556 <dd>
557 file/directory name (string)
558 </dd>
559 <dt><i>operation</i></dt> 434 <dt><i>operation</i></dt>
560 <dd> 435 <dd>
561 operation type to be performed (Queues.POP, 436 operation type to be performed (Queues.POP,
562 Queues.PUSH, Queues.GOTO) 437 Queues.PUSH, Queues.GOTO)
563 </dd> 438 </dd>
588 raised to indicate an invalid operation 463 raised to indicate an invalid operation
589 </dd> 464 </dd>
590 </dl> 465 </dl>
591 <a NAME="Queues.hgQueueRefreshPatch" ID="Queues.hgQueueRefreshPatch"></a> 466 <a NAME="Queues.hgQueueRefreshPatch" ID="Queues.hgQueueRefreshPatch"></a>
592 <h4>Queues.hgQueueRefreshPatch</h4> 467 <h4>Queues.hgQueueRefreshPatch</h4>
593 <b>hgQueueRefreshPatch</b>(<i>name, editMessage=False</i>) 468 <b>hgQueueRefreshPatch</b>(<i>editMessage=False</i>)
594 469
595 <p> 470 <p>
596 Public method to refresh the current patch. 471 Public method to refresh the current patch.
597 </p> 472 </p>
598 <dl> 473 <dl>
599 474
600 <dt><i>name</i></dt>
601 <dd>
602 file/directory name (string)
603 </dd>
604 <dt><i>editMessage</i></dt> 475 <dt><i>editMessage</i></dt>
605 <dd> 476 <dd>
606 flag indicating to edit the current 477 flag indicating to edit the current
607 commit message (boolean) 478 commit message (boolean)
608 </dd> 479 </dd>
609 </dl> 480 </dl>
610 <a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a> 481 <a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a>
611 <h4>Queues.hgQueueRenamePatch</h4> 482 <h4>Queues.hgQueueRenamePatch</h4>
612 <b>hgQueueRenamePatch</b>(<i>name</i>) 483 <b>hgQueueRenamePatch</b>(<i></i>)
613 484
614 <p> 485 <p>
615 Public method to rename the current or a selected patch. 486 Public method to rename the current or a selected patch.
616 </p> 487 </p>
617 <dl>
618
619 <dt><i>name</i></dt>
620 <dd>
621 file/directory name (string)
622 </dd>
623 </dl>
624 <a NAME="Queues.hgQueueShowHeader" ID="Queues.hgQueueShowHeader"></a> 488 <a NAME="Queues.hgQueueShowHeader" ID="Queues.hgQueueShowHeader"></a>
625 <h4>Queues.hgQueueShowHeader</h4> 489 <h4>Queues.hgQueueShowHeader</h4>
626 <b>hgQueueShowHeader</b>(<i>name</i>) 490 <b>hgQueueShowHeader</b>(<i></i>)
627 491
628 <p> 492 <p>
629 Public method to show the commit message of the current patch. 493 Public method to show the commit message of the current patch.
630 </p> 494 </p>
631 <dl>
632
633 <dt><i>name</i></dt>
634 <dd>
635 file/directory name (string)
636 </dd>
637 </dl>
638 <a NAME="Queues.hgQueueShowPatch" ID="Queues.hgQueueShowPatch"></a> 495 <a NAME="Queues.hgQueueShowPatch" ID="Queues.hgQueueShowPatch"></a>
639 <h4>Queues.hgQueueShowPatch</h4> 496 <h4>Queues.hgQueueShowPatch</h4>
640 <b>hgQueueShowPatch</b>(<i>name</i>) 497 <b>hgQueueShowPatch</b>(<i>name</i>)
641 498
642 <p> 499 <p>

eric ide

mercurial