src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html

branch
eric7
changeset 10479
856476537696
parent 10441
a79201e0e149
child 10493
f795d68d8e09
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsSubversion.subversion</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsSubversion.subversion</h1>
10
11 <p> 10 <p>
12 Module implementing the version control systems interface to Subversion. 11 Module implementing the version control systems interface to Subversion.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#Subversion">Subversion</a></td> 22 <td><a href="#Subversion">Subversion</a></td>
25 <td>Class implementing the version control systems interface to Subversion.</td> 23 <td>Class implementing the version control systems interface to Subversion.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="Subversion" ID="Subversion"></a> 34 <a NAME="Subversion" ID="Subversion"></a>
36 <h2>Subversion</h2> 35 <h2>Subversion</h2>
37
38 <p> 36 <p>
39 Class implementing the version control systems interface to Subversion. 37 Class implementing the version control systems interface to Subversion.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>committed()</dt> 43 <dt>committed()</dt>
45 <dd> 44 <dd>
47 </dd> 46 </dd>
48 </dl> 47 </dl>
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 VersionControl 49 VersionControl
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52
53 <table> 51 <table>
54 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
55 </table> 53 </table>
54
56 <h3>Class Methods</h3> 55 <h3>Class Methods</h3>
57
58 <table> 56 <table>
59 <tr><td>None</td></tr> 57 <tr><td>None</td></tr>
60 </table> 58 </table>
59
61 <h3>Methods</h3> 60 <h3>Methods</h3>
62
63 <table> 61 <table>
64
65 <tr> 62 <tr>
66 <td><a href="#Subversion.__init__">Subversion</a></td> 63 <td><a href="#Subversion.__init__">Subversion</a></td>
67 <td>Constructor</td> 64 <td>Constructor</td>
68 </tr> 65 </tr>
69 <tr> 66 <tr>
333 <tr> 330 <tr>
334 <td><a href="#Subversion.vcsUpdate">vcsUpdate</a></td> 331 <td><a href="#Subversion.vcsUpdate">vcsUpdate</a></td>
335 <td>Public method used to update a file/directory with the Subversion repository.</td> 332 <td>Public method used to update a file/directory with the Subversion repository.</td>
336 </tr> 333 </tr>
337 </table> 334 </table>
335
338 <h3>Static Methods</h3> 336 <h3>Static Methods</h3>
339
340 <table> 337 <table>
341 <tr><td>None</td></tr> 338 <tr><td>None</td></tr>
342 </table> 339 </table>
343 340
341
344 <a NAME="Subversion.__init__" ID="Subversion.__init__"></a> 342 <a NAME="Subversion.__init__" ID="Subversion.__init__"></a>
345 <h4>Subversion (Constructor)</h4> 343 <h4>Subversion (Constructor)</h4>
346 <b>Subversion</b>(<i>plugin, parent=None, name=None</i>) 344 <b>Subversion</b>(<i>plugin, parent=None, name=None</i>)
347
348 <p> 345 <p>
349 Constructor 346 Constructor
350 </p> 347 </p>
348
351 <dl> 349 <dl>
352 350
353 <dt><i>plugin</i> (VcsSubversionPlugin)</dt> 351 <dt><i>plugin</i> (VcsSubversionPlugin)</dt>
354 <dd> 352 <dd>
355 reference to the plugin object 353 reference to the plugin object
364 </dd> 362 </dd>
365 </dl> 363 </dl>
366 <a NAME="Subversion.__svnGetFileForRevision" ID="Subversion.__svnGetFileForRevision"></a> 364 <a NAME="Subversion.__svnGetFileForRevision" ID="Subversion.__svnGetFileForRevision"></a>
367 <h4>Subversion.__svnGetFileForRevision</h4> 365 <h4>Subversion.__svnGetFileForRevision</h4>
368 <b>__svnGetFileForRevision</b>(<i>name, rev=""</i>) 366 <b>__svnGetFileForRevision</b>(<i>name, rev=""</i>)
369
370 <p> 367 <p>
371 Private method to get a file for a specific revision from the 368 Private method to get a file for a specific revision from the
372 repository. 369 repository.
373 </p> 370 </p>
371
374 <dl> 372 <dl>
375 373
376 <dt><i>name</i> (str)</dt> 374 <dt><i>name</i> (str)</dt>
377 <dd> 375 <dd>
378 file name to get from the repository 376 file name to get from the repository
395 </dd> 393 </dd>
396 </dl> 394 </dl>
397 <a NAME="Subversion.__svnURL" ID="Subversion.__svnURL"></a> 395 <a NAME="Subversion.__svnURL" ID="Subversion.__svnURL"></a>
398 <h4>Subversion.__svnURL</h4> 396 <h4>Subversion.__svnURL</h4>
399 <b>__svnURL</b>(<i>url</i>) 397 <b>__svnURL</b>(<i>url</i>)
400
401 <p> 398 <p>
402 Private method to format a url for subversion. 399 Private method to format a url for subversion.
403 </p> 400 </p>
401
404 <dl> 402 <dl>
405 403
406 <dt><i>url</i> (str)</dt> 404 <dt><i>url</i> (str)</dt>
407 <dd> 405 <dd>
408 unformatted url string 406 unformatted url string
421 </dd> 419 </dd>
422 </dl> 420 </dl>
423 <a NAME="Subversion.__vcsAllRegisteredStates_wc" ID="Subversion.__vcsAllRegisteredStates_wc"></a> 421 <a NAME="Subversion.__vcsAllRegisteredStates_wc" ID="Subversion.__vcsAllRegisteredStates_wc"></a>
424 <h4>Subversion.__vcsAllRegisteredStates_wc</h4> 422 <h4>Subversion.__vcsAllRegisteredStates_wc</h4>
425 <b>__vcsAllRegisteredStates_wc</b>(<i>names, dname, shortcut=True</i>) 423 <b>__vcsAllRegisteredStates_wc</b>(<i>names, dname, shortcut=True</i>)
426
427 <p> 424 <p>
428 Private method used to get the registered states of a number of files 425 Private method used to get the registered states of a number of files
429 in the VCS. 426 in the VCS.
430 </p> 427 </p>
431 <p> 428 <p>
435 <p> 432 <p>
436 <b>Note:</b> If a shortcut is to be taken, the code will only check, 433 <b>Note:</b> If a shortcut is to be taken, the code will only check,
437 if the named directory has been scanned already. If so, it is assumed, 434 if the named directory has been scanned already. If so, it is assumed,
438 that the states for all files has been populated by the previous run. 435 that the states for all files has been populated by the previous run.
439 </p> 436 </p>
437
440 <dl> 438 <dl>
441 439
442 <dt><i>names</i> (dict)</dt> 440 <dt><i>names</i> (dict)</dt>
443 <dd> 441 <dd>
444 dictionary with all filenames to be checked as keys 442 dictionary with all filenames to be checked as keys
466 </dd> 464 </dd>
467 </dl> 465 </dl>
468 <a NAME="Subversion.__vcsAllRegisteredStates_wcng" ID="Subversion.__vcsAllRegisteredStates_wcng"></a> 466 <a NAME="Subversion.__vcsAllRegisteredStates_wcng" ID="Subversion.__vcsAllRegisteredStates_wcng"></a>
469 <h4>Subversion.__vcsAllRegisteredStates_wcng</h4> 467 <h4>Subversion.__vcsAllRegisteredStates_wcng</h4>
470 <b>__vcsAllRegisteredStates_wcng</b>(<i>names, dname</i>) 468 <b>__vcsAllRegisteredStates_wcng</b>(<i>names, dname</i>)
471
472 <p> 469 <p>
473 Private method used to get the registered states of a number of files 470 Private method used to get the registered states of a number of files
474 in the VCS. 471 in the VCS.
475 </p> 472 </p>
476 <p> 473 <p>
480 <p> 477 <p>
481 <b>Note:</b> If a shortcut is to be taken, the code will only check, 478 <b>Note:</b> If a shortcut is to be taken, the code will only check,
482 if the named directory has been scanned already. If so, it is assumed, 479 if the named directory has been scanned already. If so, it is assumed,
483 that the states for all files has been populated by the previous run. 480 that the states for all files has been populated by the previous run.
484 </p> 481 </p>
482
485 <dl> 483 <dl>
486 484
487 <dt><i>names</i> (dict)</dt> 485 <dt><i>names</i> (dict)</dt>
488 <dd> 486 <dd>
489 dictionary with all filenames to be checked as keys 487 dictionary with all filenames to be checked as keys
507 </dd> 505 </dd>
508 </dl> 506 </dl>
509 <a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a> 507 <a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a>
510 <h4>Subversion.__vcsCommit_Step2</h4> 508 <h4>Subversion.__vcsCommit_Step2</h4>
511 <b>__vcsCommit_Step2</b>(<i></i>) 509 <b>__vcsCommit_Step2</b>(<i></i>)
512
513 <p> 510 <p>
514 Private slot performing the second step of the commit action. 511 Private slot performing the second step of the commit action.
515 </p> 512 </p>
513
516 <a NAME="Subversion.__vcsRegisteredState_wc" ID="Subversion.__vcsRegisteredState_wc"></a> 514 <a NAME="Subversion.__vcsRegisteredState_wc" ID="Subversion.__vcsRegisteredState_wc"></a>
517 <h4>Subversion.__vcsRegisteredState_wc</h4> 515 <h4>Subversion.__vcsRegisteredState_wc</h4>
518 <b>__vcsRegisteredState_wc</b>(<i>name</i>) 516 <b>__vcsRegisteredState_wc</b>(<i>name</i>)
519
520 <p> 517 <p>
521 Private method used to get the registered state of a file in the VCS. 518 Private method used to get the registered state of a file in the VCS.
522 </p> 519 </p>
523 <p> 520 <p>
524 This is the variant for subversion installations using the old working 521 This is the variant for subversion installations using the old working
525 copy meta-data format. 522 copy meta-data format.
526 </p> 523 </p>
524
527 <dl> 525 <dl>
528 526
529 <dt><i>name</i> (str)</dt> 527 <dt><i>name</i> (str)</dt>
530 <dd> 528 <dd>
531 filename to check 529 filename to check
544 </dd> 542 </dd>
545 </dl> 543 </dl>
546 <a NAME="Subversion.__vcsRegisteredState_wcng" ID="Subversion.__vcsRegisteredState_wcng"></a> 544 <a NAME="Subversion.__vcsRegisteredState_wcng" ID="Subversion.__vcsRegisteredState_wcng"></a>
547 <h4>Subversion.__vcsRegisteredState_wcng</h4> 545 <h4>Subversion.__vcsRegisteredState_wcng</h4>
548 <b>__vcsRegisteredState_wcng</b>(<i>name</i>) 546 <b>__vcsRegisteredState_wcng</b>(<i>name</i>)
549
550 <p> 547 <p>
551 Private method used to get the registered state of a file in the vcs. 548 Private method used to get the registered state of a file in the vcs.
552 </p> 549 </p>
553 <p> 550 <p>
554 This is the variant for subversion installations using the new 551 This is the variant for subversion installations using the new
555 working copy meta-data format. 552 working copy meta-data format.
556 </p> 553 </p>
554
557 <dl> 555 <dl>
558 556
559 <dt><i>name</i> (str)</dt> 557 <dt><i>name</i> (str)</dt>
560 <dd> 558 <dd>
561 filename to check 559 filename to check
574 </dd> 572 </dd>
575 </dl> 573 </dl>
576 <a NAME="Subversion._createStatusMonitorThread" ID="Subversion._createStatusMonitorThread"></a> 574 <a NAME="Subversion._createStatusMonitorThread" ID="Subversion._createStatusMonitorThread"></a>
577 <h4>Subversion._createStatusMonitorThread</h4> 575 <h4>Subversion._createStatusMonitorThread</h4>
578 <b>_createStatusMonitorThread</b>(<i>interval, project</i>) 576 <b>_createStatusMonitorThread</b>(<i>interval, project</i>)
579
580 <p> 577 <p>
581 Protected method to create an instance of the VCS status monitor 578 Protected method to create an instance of the VCS status monitor
582 thread. 579 thread.
583 </p> 580 </p>
581
584 <dl> 582 <dl>
585 583
586 <dt><i>interval</i> (int)</dt> 584 <dt><i>interval</i> (int)</dt>
587 <dd> 585 <dd>
588 check interval for the monitor thread in seconds 586 check interval for the monitor thread in seconds
605 </dd> 603 </dd>
606 </dl> 604 </dl>
607 <a NAME="Subversion.clearStatusCache" ID="Subversion.clearStatusCache"></a> 605 <a NAME="Subversion.clearStatusCache" ID="Subversion.clearStatusCache"></a>
608 <h4>Subversion.clearStatusCache</h4> 606 <h4>Subversion.clearStatusCache</h4>
609 <b>clearStatusCache</b>(<i></i>) 607 <b>clearStatusCache</b>(<i></i>)
610
611 <p> 608 <p>
612 Public method to clear the status cache. 609 Public method to clear the status cache.
613 </p> 610 </p>
611
614 <a NAME="Subversion.getPlugin" ID="Subversion.getPlugin"></a> 612 <a NAME="Subversion.getPlugin" ID="Subversion.getPlugin"></a>
615 <h4>Subversion.getPlugin</h4> 613 <h4>Subversion.getPlugin</h4>
616 <b>getPlugin</b>(<i></i>) 614 <b>getPlugin</b>(<i></i>)
617
618 <p> 615 <p>
619 Public method to get a reference to the plugin object. 616 Public method to get a reference to the plugin object.
620 </p> 617 </p>
618
621 <dl> 619 <dl>
622 <dt>Return:</dt> 620 <dt>Return:</dt>
623 <dd> 621 <dd>
624 reference to the plugin object 622 reference to the plugin object
625 </dd> 623 </dd>
631 </dd> 629 </dd>
632 </dl> 630 </dl>
633 <a NAME="Subversion.svnAddToChangelist" ID="Subversion.svnAddToChangelist"></a> 631 <a NAME="Subversion.svnAddToChangelist" ID="Subversion.svnAddToChangelist"></a>
634 <h4>Subversion.svnAddToChangelist</h4> 632 <h4>Subversion.svnAddToChangelist</h4>
635 <b>svnAddToChangelist</b>(<i>names</i>) 633 <b>svnAddToChangelist</b>(<i>names</i>)
636
637 <p> 634 <p>
638 Public method to add a file or directory to a changelist. 635 Public method to add a file or directory to a changelist.
639 </p> 636 </p>
640 <p> 637 <p>
641 Note: Directories will be added recursively. 638 Note: Directories will be added recursively.
642 </p> 639 </p>
640
643 <dl> 641 <dl>
644 642
645 <dt><i>names</i> (str or list of str)</dt> 643 <dt><i>names</i> (str or list of str)</dt>
646 <dd> 644 <dd>
647 name or list of names of file or directory to add 645 name or list of names of file or directory to add
648 </dd> 646 </dd>
649 </dl> 647 </dl>
650 <a NAME="Subversion.svnBlame" ID="Subversion.svnBlame"></a> 648 <a NAME="Subversion.svnBlame" ID="Subversion.svnBlame"></a>
651 <h4>Subversion.svnBlame</h4> 649 <h4>Subversion.svnBlame</h4>
652 <b>svnBlame</b>(<i>name</i>) 650 <b>svnBlame</b>(<i>name</i>)
653
654 <p> 651 <p>
655 Public method to show the output of the svn blame command. 652 Public method to show the output of the svn blame command.
656 </p> 653 </p>
654
657 <dl> 655 <dl>
658 656
659 <dt><i>name</i> (str)</dt> 657 <dt><i>name</i> (str)</dt>
660 <dd> 658 <dd>
661 file name to show the blame for 659 file name to show the blame for
662 </dd> 660 </dd>
663 </dl> 661 </dl>
664 <a NAME="Subversion.svnCopy" ID="Subversion.svnCopy"></a> 662 <a NAME="Subversion.svnCopy" ID="Subversion.svnCopy"></a>
665 <h4>Subversion.svnCopy</h4> 663 <h4>Subversion.svnCopy</h4>
666 <b>svnCopy</b>(<i>name, project</i>) 664 <b>svnCopy</b>(<i>name, project</i>)
667
668 <p> 665 <p>
669 Public method used to copy a file/directory. 666 Public method used to copy a file/directory.
670 </p> 667 </p>
668
671 <dl> 669 <dl>
672 670
673 <dt><i>name</i> (str)</dt> 671 <dt><i>name</i> (str)</dt>
674 <dd> 672 <dd>
675 file/directory name to be copied 673 file/directory name to be copied
692 </dd> 690 </dd>
693 </dl> 691 </dl>
694 <a NAME="Subversion.svnDelProp" ID="Subversion.svnDelProp"></a> 692 <a NAME="Subversion.svnDelProp" ID="Subversion.svnDelProp"></a>
695 <h4>Subversion.svnDelProp</h4> 693 <h4>Subversion.svnDelProp</h4>
696 <b>svnDelProp</b>(<i>name, recursive=False</i>) 694 <b>svnDelProp</b>(<i>name, recursive=False</i>)
697
698 <p> 695 <p>
699 Public method used to delete a property of a file/directory. 696 Public method used to delete a property of a file/directory.
700 </p> 697 </p>
698
701 <dl> 699 <dl>
702 700
703 <dt><i>name</i> (str or list of str)</dt> 701 <dt><i>name</i> (str or list of str)</dt>
704 <dd> 702 <dd>
705 file/directory name 703 file/directory name
710 </dd> 708 </dd>
711 </dl> 709 </dl>
712 <a NAME="Subversion.svnExtendedDiff" ID="Subversion.svnExtendedDiff"></a> 710 <a NAME="Subversion.svnExtendedDiff" ID="Subversion.svnExtendedDiff"></a>
713 <h4>Subversion.svnExtendedDiff</h4> 711 <h4>Subversion.svnExtendedDiff</h4>
714 <b>svnExtendedDiff</b>(<i>name</i>) 712 <b>svnExtendedDiff</b>(<i>name</i>)
715
716 <p> 713 <p>
717 Public method used to view the difference of a file/directory to the 714 Public method used to view the difference of a file/directory to the
718 Subversion repository. 715 Subversion repository.
719 </p> 716 </p>
720 <p> 717 <p>
724 operation may be aborted. 721 operation may be aborted.
725 </p> 722 </p>
726 <p> 723 <p>
727 This method gives the chance to enter the revisions to be compared. 724 This method gives the chance to enter the revisions to be compared.
728 </p> 725 </p>
726
729 <dl> 727 <dl>
730 728
731 <dt><i>name</i> (str)</dt> 729 <dt><i>name</i> (str)</dt>
732 <dd> 730 <dd>
733 file/directory name to be diffed 731 file/directory name to be diffed
734 </dd> 732 </dd>
735 </dl> 733 </dl>
736 <a NAME="Subversion.svnGetChangelists" ID="Subversion.svnGetChangelists"></a> 734 <a NAME="Subversion.svnGetChangelists" ID="Subversion.svnGetChangelists"></a>
737 <h4>Subversion.svnGetChangelists</h4> 735 <h4>Subversion.svnGetChangelists</h4>
738 <b>svnGetChangelists</b>(<i></i>) 736 <b>svnGetChangelists</b>(<i></i>)
739
740 <p> 737 <p>
741 Public method to get a list of all defined change lists. 738 Public method to get a list of all defined change lists.
742 </p> 739 </p>
740
743 <dl> 741 <dl>
744 <dt>Return:</dt> 742 <dt>Return:</dt>
745 <dd> 743 <dd>
746 list of defined change list names 744 list of defined change list names
747 </dd> 745 </dd>
753 </dd> 751 </dd>
754 </dl> 752 </dl>
755 <a NAME="Subversion.svnGetReposName" ID="Subversion.svnGetReposName"></a> 753 <a NAME="Subversion.svnGetReposName" ID="Subversion.svnGetReposName"></a>
756 <h4>Subversion.svnGetReposName</h4> 754 <h4>Subversion.svnGetReposName</h4>
757 <b>svnGetReposName</b>(<i>path</i>) 755 <b>svnGetReposName</b>(<i>path</i>)
758
759 <p> 756 <p>
760 Public method used to retrieve the URL of the subversion repository 757 Public method used to retrieve the URL of the subversion repository
761 path. 758 path.
762 </p> 759 </p>
760
763 <dl> 761 <dl>
764 762
765 <dt><i>path</i> (str)</dt> 763 <dt><i>path</i> (str)</dt>
766 <dd> 764 <dd>
767 local path to get the svn repository path for 765 local path to get the svn repository path for
780 </dd> 778 </dd>
781 </dl> 779 </dl>
782 <a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a> 780 <a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a>
783 <h4>Subversion.svnListProps</h4> 781 <h4>Subversion.svnListProps</h4>
784 <b>svnListProps</b>(<i>name, recursive=False</i>) 782 <b>svnListProps</b>(<i>name, recursive=False</i>)
785
786 <p> 783 <p>
787 Public method used to list the properties of a file/directory. 784 Public method used to list the properties of a file/directory.
788 </p> 785 </p>
786
789 <dl> 787 <dl>
790 788
791 <dt><i>name</i> (str or list of str)</dt> 789 <dt><i>name</i> (str or list of str)</dt>
792 <dd> 790 <dd>
793 file/directory name 791 file/directory name
798 </dd> 796 </dd>
799 </dl> 797 </dl>
800 <a NAME="Subversion.svnListTagBranch" ID="Subversion.svnListTagBranch"></a> 798 <a NAME="Subversion.svnListTagBranch" ID="Subversion.svnListTagBranch"></a>
801 <h4>Subversion.svnListTagBranch</h4> 799 <h4>Subversion.svnListTagBranch</h4>
802 <b>svnListTagBranch</b>(<i>path, tags=True</i>) 800 <b>svnListTagBranch</b>(<i>path, tags=True</i>)
803
804 <p> 801 <p>
805 Public method used to list the available tags or branches. 802 Public method used to list the available tags or branches.
806 </p> 803 </p>
804
807 <dl> 805 <dl>
808 806
809 <dt><i>path</i> (str)</dt> 807 <dt><i>path</i> (str)</dt>
810 <dd> 808 <dd>
811 directory name of the project 809 directory name of the project
817 </dd> 815 </dd>
818 </dl> 816 </dl>
819 <a NAME="Subversion.svnLock" ID="Subversion.svnLock"></a> 817 <a NAME="Subversion.svnLock" ID="Subversion.svnLock"></a>
820 <h4>Subversion.svnLock</h4> 818 <h4>Subversion.svnLock</h4>
821 <b>svnLock</b>(<i>name, stealIt=False, parent=None</i>) 819 <b>svnLock</b>(<i>name, stealIt=False, parent=None</i>)
822
823 <p> 820 <p>
824 Public method used to lock a file in the Subversion repository. 821 Public method used to lock a file in the Subversion repository.
825 </p> 822 </p>
823
826 <dl> 824 <dl>
827 825
828 <dt><i>name</i> (str or list of str)</dt> 826 <dt><i>name</i> (str or list of str)</dt>
829 <dd> 827 <dd>
830 file/directory name to be locked 828 file/directory name to be locked
839 </dd> 837 </dd>
840 </dl> 838 </dl>
841 <a NAME="Subversion.svnNormalizeURL" ID="Subversion.svnNormalizeURL"></a> 839 <a NAME="Subversion.svnNormalizeURL" ID="Subversion.svnNormalizeURL"></a>
842 <h4>Subversion.svnNormalizeURL</h4> 840 <h4>Subversion.svnNormalizeURL</h4>
843 <b>svnNormalizeURL</b>(<i>url</i>) 841 <b>svnNormalizeURL</b>(<i>url</i>)
844
845 <p> 842 <p>
846 Public method to normalize a url for subversion. 843 Public method to normalize a url for subversion.
847 </p> 844 </p>
845
848 <dl> 846 <dl>
849 847
850 <dt><i>url</i> (str)</dt> 848 <dt><i>url</i> (str)</dt>
851 <dd> 849 <dd>
852 url string 850 url string
865 </dd> 863 </dd>
866 </dl> 864 </dl>
867 <a NAME="Subversion.svnRelocate" ID="Subversion.svnRelocate"></a> 865 <a NAME="Subversion.svnRelocate" ID="Subversion.svnRelocate"></a>
868 <h4>Subversion.svnRelocate</h4> 866 <h4>Subversion.svnRelocate</h4>
869 <b>svnRelocate</b>(<i>projectPath</i>) 867 <b>svnRelocate</b>(<i>projectPath</i>)
870
871 <p> 868 <p>
872 Public method to relocate the working copy to a new repository URL. 869 Public method to relocate the working copy to a new repository URL.
873 </p> 870 </p>
871
874 <dl> 872 <dl>
875 873
876 <dt><i>projectPath</i> (str)</dt> 874 <dt><i>projectPath</i> (str)</dt>
877 <dd> 875 <dd>
878 path name of the project 876 path name of the project
879 </dd> 877 </dd>
880 </dl> 878 </dl>
881 <a NAME="Subversion.svnRemoveFromChangelist" ID="Subversion.svnRemoveFromChangelist"></a> 879 <a NAME="Subversion.svnRemoveFromChangelist" ID="Subversion.svnRemoveFromChangelist"></a>
882 <h4>Subversion.svnRemoveFromChangelist</h4> 880 <h4>Subversion.svnRemoveFromChangelist</h4>
883 <b>svnRemoveFromChangelist</b>(<i>names</i>) 881 <b>svnRemoveFromChangelist</b>(<i>names</i>)
884
885 <p> 882 <p>
886 Public method to remove a file or directory from its changelist. 883 Public method to remove a file or directory from its changelist.
887 </p> 884 </p>
888 <p> 885 <p>
889 Note: Directories will be removed recursively. 886 Note: Directories will be removed recursively.
890 </p> 887 </p>
888
891 <dl> 889 <dl>
892 890
893 <dt><i>names</i> (str or list of str)</dt> 891 <dt><i>names</i> (str or list of str)</dt>
894 <dd> 892 <dd>
895 name or list of names of file or directory to remove 893 name or list of names of file or directory to remove
896 </dd> 894 </dd>
897 </dl> 895 </dl>
898 <a NAME="Subversion.svnRepoBrowser" ID="Subversion.svnRepoBrowser"></a> 896 <a NAME="Subversion.svnRepoBrowser" ID="Subversion.svnRepoBrowser"></a>
899 <h4>Subversion.svnRepoBrowser</h4> 897 <h4>Subversion.svnRepoBrowser</h4>
900 <b>svnRepoBrowser</b>(<i>projectPath=None</i>) 898 <b>svnRepoBrowser</b>(<i>projectPath=None</i>)
901
902 <p> 899 <p>
903 Public method to open the repository browser. 900 Public method to open the repository browser.
904 </p> 901 </p>
902
905 <dl> 903 <dl>
906 904
907 <dt><i>projectPath</i> (str)</dt> 905 <dt><i>projectPath</i> (str)</dt>
908 <dd> 906 <dd>
909 path name of the project 907 path name of the project
910 </dd> 908 </dd>
911 </dl> 909 </dl>
912 <a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a> 910 <a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a>
913 <h4>Subversion.svnSetProp</h4> 911 <h4>Subversion.svnSetProp</h4>
914 <b>svnSetProp</b>(<i>name, recursive=False</i>) 912 <b>svnSetProp</b>(<i>name, recursive=False</i>)
915
916 <p> 913 <p>
917 Public method used to add a property to a file/directory. 914 Public method used to add a property to a file/directory.
918 </p> 915 </p>
916
919 <dl> 917 <dl>
920 918
921 <dt><i>name</i> (str or list of str)</dt> 919 <dt><i>name</i> (str or list of str)</dt>
922 <dd> 920 <dd>
923 file/directory name 921 file/directory name
928 </dd> 926 </dd>
929 </dl> 927 </dl>
930 <a NAME="Subversion.svnShowChangelists" ID="Subversion.svnShowChangelists"></a> 928 <a NAME="Subversion.svnShowChangelists" ID="Subversion.svnShowChangelists"></a>
931 <h4>Subversion.svnShowChangelists</h4> 929 <h4>Subversion.svnShowChangelists</h4>
932 <b>svnShowChangelists</b>(<i>path</i>) 930 <b>svnShowChangelists</b>(<i>path</i>)
933
934 <p> 931 <p>
935 Public method used to inspect the change lists defined for the project. 932 Public method used to inspect the change lists defined for the project.
936 </p> 933 </p>
934
937 <dl> 935 <dl>
938 936
939 <dt><i>path</i> (str)</dt> 937 <dt><i>path</i> (str)</dt>
940 <dd> 938 <dd>
941 directory name to show change lists for 939 directory name to show change lists for
942 </dd> 940 </dd>
943 </dl> 941 </dl>
944 <a NAME="Subversion.svnUnlock" ID="Subversion.svnUnlock"></a> 942 <a NAME="Subversion.svnUnlock" ID="Subversion.svnUnlock"></a>
945 <h4>Subversion.svnUnlock</h4> 943 <h4>Subversion.svnUnlock</h4>
946 <b>svnUnlock</b>(<i>name, breakIt=False, parent=None</i>) 944 <b>svnUnlock</b>(<i>name, breakIt=False, parent=None</i>)
947
948 <p> 945 <p>
949 Public method used to unlock a file in the Subversion repository. 946 Public method used to unlock a file in the Subversion repository.
950 </p> 947 </p>
948
951 <dl> 949 <dl>
952 950
953 <dt><i>name</i> (str or list of str)</dt> 951 <dt><i>name</i> (str or list of str)</dt>
954 <dd> 952 <dd>
955 file/directory name to be unlocked 953 file/directory name to be unlocked
964 </dd> 962 </dd>
965 </dl> 963 </dl>
966 <a NAME="Subversion.svnUpgrade" ID="Subversion.svnUpgrade"></a> 964 <a NAME="Subversion.svnUpgrade" ID="Subversion.svnUpgrade"></a>
967 <h4>Subversion.svnUpgrade</h4> 965 <h4>Subversion.svnUpgrade</h4>
968 <b>svnUpgrade</b>(<i>path</i>) 966 <b>svnUpgrade</b>(<i>path</i>)
969
970 <p> 967 <p>
971 Public method to upgrade the working copy format. 968 Public method to upgrade the working copy format.
972 </p> 969 </p>
970
973 <dl> 971 <dl>
974 972
975 <dt><i>path</i> (str)</dt> 973 <dt><i>path</i> (str)</dt>
976 <dd> 974 <dd>
977 directory name to show change lists for 975 directory name to show change lists for
978 </dd> 976 </dd>
979 </dl> 977 </dl>
980 <a NAME="Subversion.svnUrlDiff" ID="Subversion.svnUrlDiff"></a> 978 <a NAME="Subversion.svnUrlDiff" ID="Subversion.svnUrlDiff"></a>
981 <h4>Subversion.svnUrlDiff</h4> 979 <h4>Subversion.svnUrlDiff</h4>
982 <b>svnUrlDiff</b>(<i>name</i>) 980 <b>svnUrlDiff</b>(<i>name</i>)
983
984 <p> 981 <p>
985 Public method used to view the difference of a file/directory of two 982 Public method used to view the difference of a file/directory of two
986 repository URLs. 983 repository URLs.
987 </p> 984 </p>
988 <p> 985 <p>
992 operation may be aborted. 989 operation may be aborted.
993 </p> 990 </p>
994 <p> 991 <p>
995 This method gives the chance to enter the revisions to be compared. 992 This method gives the chance to enter the revisions to be compared.
996 </p> 993 </p>
994
997 <dl> 995 <dl>
998 996
999 <dt><i>name</i> (str)</dt> 997 <dt><i>name</i> (str)</dt>
1000 <dd> 998 <dd>
1001 file/directory name to be diffed 999 file/directory name to be diffed
1002 </dd> 1000 </dd>
1003 </dl> 1001 </dl>
1004 <a NAME="Subversion.vcsAdd" ID="Subversion.vcsAdd"></a> 1002 <a NAME="Subversion.vcsAdd" ID="Subversion.vcsAdd"></a>
1005 <h4>Subversion.vcsAdd</h4> 1003 <h4>Subversion.vcsAdd</h4>
1006 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) 1004 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
1007
1008 <p> 1005 <p>
1009 Public method used to add a file/directory to the Subversion 1006 Public method used to add a file/directory to the Subversion
1010 repository. 1007 repository.
1011 </p> 1008 </p>
1009
1012 <dl> 1010 <dl>
1013 1011
1014 <dt><i>name</i> (str)</dt> 1012 <dt><i>name</i> (str)</dt>
1015 <dd> 1013 <dd>
1016 file/directory name to be added 1014 file/directory name to be added
1025 </dd> 1023 </dd>
1026 </dl> 1024 </dl>
1027 <a NAME="Subversion.vcsAddBinary" ID="Subversion.vcsAddBinary"></a> 1025 <a NAME="Subversion.vcsAddBinary" ID="Subversion.vcsAddBinary"></a>
1028 <h4>Subversion.vcsAddBinary</h4> 1026 <h4>Subversion.vcsAddBinary</h4>
1029 <b>vcsAddBinary</b>(<i>name, isDir=False</i>) 1027 <b>vcsAddBinary</b>(<i>name, isDir=False</i>)
1030
1031 <p> 1028 <p>
1032 Public method used to add a file/directory in binary mode to the 1029 Public method used to add a file/directory in binary mode to the
1033 Subversion repository. 1030 Subversion repository.
1034 </p> 1031 </p>
1032
1035 <dl> 1033 <dl>
1036 1034
1037 <dt><i>name</i> (str)</dt> 1035 <dt><i>name</i> (str)</dt>
1038 <dd> 1036 <dd>
1039 file/directory name to be added 1037 file/directory name to be added
1044 </dd> 1042 </dd>
1045 </dl> 1043 </dl>
1046 <a NAME="Subversion.vcsAddCommitMessage" ID="Subversion.vcsAddCommitMessage"></a> 1044 <a NAME="Subversion.vcsAddCommitMessage" ID="Subversion.vcsAddCommitMessage"></a>
1047 <h4>Subversion.vcsAddCommitMessage</h4> 1045 <h4>Subversion.vcsAddCommitMessage</h4>
1048 <b>vcsAddCommitMessage</b>(<i>message</i>) 1046 <b>vcsAddCommitMessage</b>(<i>message</i>)
1049
1050 <p> 1047 <p>
1051 Public method to add a commit message to the list of saved messages. 1048 Public method to add a commit message to the list of saved messages.
1052 </p> 1049 </p>
1050
1053 <dl> 1051 <dl>
1054 1052
1055 <dt><i>message</i> (str)</dt> 1053 <dt><i>message</i> (str)</dt>
1056 <dd> 1054 <dd>
1057 message to be added 1055 message to be added
1058 </dd> 1056 </dd>
1059 </dl> 1057 </dl>
1060 <a NAME="Subversion.vcsAddTree" ID="Subversion.vcsAddTree"></a> 1058 <a NAME="Subversion.vcsAddTree" ID="Subversion.vcsAddTree"></a>
1061 <h4>Subversion.vcsAddTree</h4> 1059 <h4>Subversion.vcsAddTree</h4>
1062 <b>vcsAddTree</b>(<i>path</i>) 1060 <b>vcsAddTree</b>(<i>path</i>)
1063
1064 <p> 1061 <p>
1065 Public method to add a directory tree rooted at path to the Subversion 1062 Public method to add a directory tree rooted at path to the Subversion
1066 repository. 1063 repository.
1067 </p> 1064 </p>
1065
1068 <dl> 1066 <dl>
1069 1067
1070 <dt><i>path</i> (str or list of str)</dt> 1068 <dt><i>path</i> (str or list of str)</dt>
1071 <dd> 1069 <dd>
1072 root directory of the tree to be added 1070 root directory of the tree to be added
1073 </dd> 1071 </dd>
1074 </dl> 1072 </dl>
1075 <a NAME="Subversion.vcsAllRegisteredStates" ID="Subversion.vcsAllRegisteredStates"></a> 1073 <a NAME="Subversion.vcsAllRegisteredStates" ID="Subversion.vcsAllRegisteredStates"></a>
1076 <h4>Subversion.vcsAllRegisteredStates</h4> 1074 <h4>Subversion.vcsAllRegisteredStates</h4>
1077 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) 1075 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>)
1078
1079 <p> 1076 <p>
1080 Public method used to get the registered states of a number of files 1077 Public method used to get the registered states of a number of files
1081 in the VCS. 1078 in the VCS.
1082 </p> 1079 </p>
1083 <p> 1080 <p>
1084 <b>Note:</b> If a shortcut is to be taken, the code will only check, 1081 <b>Note:</b> If a shortcut is to be taken, the code will only check,
1085 if the named directory has been scanned already. If so, it is assumed, 1082 if the named directory has been scanned already. If so, it is assumed,
1086 that the states for all files have been populated by the previous run. 1083 that the states for all files have been populated by the previous run.
1087 </p> 1084 </p>
1085
1088 <dl> 1086 <dl>
1089 1087
1090 <dt><i>names</i> (dict)</dt> 1088 <dt><i>names</i> (dict)</dt>
1091 <dd> 1089 <dd>
1092 dictionary with all filenames to be checked as keys 1090 dictionary with all filenames to be checked as keys
1114 </dd> 1112 </dd>
1115 </dl> 1113 </dl>
1116 <a NAME="Subversion.vcsCheckout" ID="Subversion.vcsCheckout"></a> 1114 <a NAME="Subversion.vcsCheckout" ID="Subversion.vcsCheckout"></a>
1117 <h4>Subversion.vcsCheckout</h4> 1115 <h4>Subversion.vcsCheckout</h4>
1118 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) 1116 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
1119
1120 <p> 1117 <p>
1121 Public method used to check the project out of the Subversion 1118 Public method used to check the project out of the Subversion
1122 repository. 1119 repository.
1123 </p> 1120 </p>
1121
1124 <dl> 1122 <dl>
1125 1123
1126 <dt><i>vcsDataDict</i> (dict)</dt> 1124 <dt><i>vcsDataDict</i> (dict)</dt>
1127 <dd> 1125 <dd>
1128 dictionary of data required for the checkout 1126 dictionary of data required for the checkout
1149 </dd> 1147 </dd>
1150 </dl> 1148 </dl>
1151 <a NAME="Subversion.vcsCleanup" ID="Subversion.vcsCleanup"></a> 1149 <a NAME="Subversion.vcsCleanup" ID="Subversion.vcsCleanup"></a>
1152 <h4>Subversion.vcsCleanup</h4> 1150 <h4>Subversion.vcsCleanup</h4>
1153 <b>vcsCleanup</b>(<i>name</i>) 1151 <b>vcsCleanup</b>(<i>name</i>)
1154
1155 <p> 1152 <p>
1156 Public method used to cleanup the working copy. 1153 Public method used to cleanup the working copy.
1157 </p> 1154 </p>
1155
1158 <dl> 1156 <dl>
1159 1157
1160 <dt><i>name</i> (str)</dt> 1158 <dt><i>name</i> (str)</dt>
1161 <dd> 1159 <dd>
1162 directory name to be cleaned up 1160 directory name to be cleaned up
1163 </dd> 1161 </dd>
1164 </dl> 1162 </dl>
1165 <a NAME="Subversion.vcsClearCommitMessages" ID="Subversion.vcsClearCommitMessages"></a> 1163 <a NAME="Subversion.vcsClearCommitMessages" ID="Subversion.vcsClearCommitMessages"></a>
1166 <h4>Subversion.vcsClearCommitMessages</h4> 1164 <h4>Subversion.vcsClearCommitMessages</h4>
1167 <b>vcsClearCommitMessages</b>(<i></i>) 1165 <b>vcsClearCommitMessages</b>(<i></i>)
1168
1169 <p> 1166 <p>
1170 Public method to clear the list of saved messages. 1167 Public method to clear the list of saved messages.
1171 </p> 1168 </p>
1169
1172 <a NAME="Subversion.vcsCommandLine" ID="Subversion.vcsCommandLine"></a> 1170 <a NAME="Subversion.vcsCommandLine" ID="Subversion.vcsCommandLine"></a>
1173 <h4>Subversion.vcsCommandLine</h4> 1171 <h4>Subversion.vcsCommandLine</h4>
1174 <b>vcsCommandLine</b>(<i>name</i>) 1172 <b>vcsCommandLine</b>(<i>name</i>)
1175
1176 <p> 1173 <p>
1177 Public method used to execute arbitrary subversion commands. 1174 Public method used to execute arbitrary subversion commands.
1178 </p> 1175 </p>
1176
1179 <dl> 1177 <dl>
1180 1178
1181 <dt><i>name</i> (str)</dt> 1179 <dt><i>name</i> (str)</dt>
1182 <dd> 1180 <dd>
1183 directory name of the working directory 1181 directory name of the working directory
1184 </dd> 1182 </dd>
1185 </dl> 1183 </dl>
1186 <a NAME="Subversion.vcsCommit" ID="Subversion.vcsCommit"></a> 1184 <a NAME="Subversion.vcsCommit" ID="Subversion.vcsCommit"></a>
1187 <h4>Subversion.vcsCommit</h4> 1185 <h4>Subversion.vcsCommit</h4>
1188 <b>vcsCommit</b>(<i>name, message, noDialog=False</i>) 1186 <b>vcsCommit</b>(<i>name, message, noDialog=False</i>)
1189
1190 <p> 1187 <p>
1191 Public method used to make the change of a file/directory permanent 1188 Public method used to make the change of a file/directory permanent
1192 in the Subversion repository. 1189 in the Subversion repository.
1193 </p> 1190 </p>
1191
1194 <dl> 1192 <dl>
1195 1193
1196 <dt><i>name</i> (str or list of str)</dt> 1194 <dt><i>name</i> (str or list of str)</dt>
1197 <dd> 1195 <dd>
1198 file/directory name to be committed 1196 file/directory name to be committed
1207 </dd> 1205 </dd>
1208 </dl> 1206 </dl>
1209 <a NAME="Subversion.vcsCommitMessages" ID="Subversion.vcsCommitMessages"></a> 1207 <a NAME="Subversion.vcsCommitMessages" ID="Subversion.vcsCommitMessages"></a>
1210 <h4>Subversion.vcsCommitMessages</h4> 1208 <h4>Subversion.vcsCommitMessages</h4>
1211 <b>vcsCommitMessages</b>(<i></i>) 1209 <b>vcsCommitMessages</b>(<i></i>)
1212
1213 <p> 1210 <p>
1214 Public method to get the list of saved commit messages. 1211 Public method to get the list of saved commit messages.
1215 </p> 1212 </p>
1213
1216 <dl> 1214 <dl>
1217 <dt>Return:</dt> 1215 <dt>Return:</dt>
1218 <dd> 1216 <dd>
1219 list of saved commit messages 1217 list of saved commit messages
1220 </dd> 1218 </dd>
1226 </dd> 1224 </dd>
1227 </dl> 1225 </dl>
1228 <a NAME="Subversion.vcsConvertProject" ID="Subversion.vcsConvertProject"></a> 1226 <a NAME="Subversion.vcsConvertProject" ID="Subversion.vcsConvertProject"></a>
1229 <h4>Subversion.vcsConvertProject</h4> 1227 <h4>Subversion.vcsConvertProject</h4>
1230 <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>) 1228 <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>)
1231
1232 <p> 1229 <p>
1233 Public method to convert an uncontrolled project to a version 1230 Public method to convert an uncontrolled project to a version
1234 controlled project. 1231 controlled project.
1235 </p> 1232 </p>
1233
1236 <dl> 1234 <dl>
1237 1235
1238 <dt><i>vcsDataDict</i> (dict)</dt> 1236 <dt><i>vcsDataDict</i> (dict)</dt>
1239 <dd> 1237 <dd>
1240 dictionary of data required for the conversion 1238 dictionary of data required for the conversion
1249 </dd> 1247 </dd>
1250 </dl> 1248 </dl>
1251 <a NAME="Subversion.vcsDiff" ID="Subversion.vcsDiff"></a> 1249 <a NAME="Subversion.vcsDiff" ID="Subversion.vcsDiff"></a>
1252 <h4>Subversion.vcsDiff</h4> 1250 <h4>Subversion.vcsDiff</h4>
1253 <b>vcsDiff</b>(<i>name</i>) 1251 <b>vcsDiff</b>(<i>name</i>)
1254
1255 <p> 1252 <p>
1256 Public method used to view the difference of a file/directory to the 1253 Public method used to view the difference of a file/directory to the
1257 Subversion repository. 1254 Subversion repository.
1258 </p> 1255 </p>
1259 <p> 1256 <p>
1260 If name is a directory and is the project directory, all project files 1257 If name is a directory and is the project directory, all project files
1261 are saved first. If name is a file (or list of files), which is/are 1258 are saved first. If name is a file (or list of files), which is/are
1262 being edited and has unsaved modification, they can be saved or the 1259 being edited and has unsaved modification, they can be saved or the
1263 operation may be aborted. 1260 operation may be aborted.
1264 </p> 1261 </p>
1262
1265 <dl> 1263 <dl>
1266 1264
1267 <dt><i>name</i> (str)</dt> 1265 <dt><i>name</i> (str)</dt>
1268 <dd> 1266 <dd>
1269 file/directory name to be diffed 1267 file/directory name to be diffed
1270 </dd> 1268 </dd>
1271 </dl> 1269 </dl>
1272 <a NAME="Subversion.vcsExists" ID="Subversion.vcsExists"></a> 1270 <a NAME="Subversion.vcsExists" ID="Subversion.vcsExists"></a>
1273 <h4>Subversion.vcsExists</h4> 1271 <h4>Subversion.vcsExists</h4>
1274 <b>vcsExists</b>(<i></i>) 1272 <b>vcsExists</b>(<i></i>)
1275
1276 <p> 1273 <p>
1277 Public method used to test for the presence of the svn executable. 1274 Public method used to test for the presence of the svn executable.
1278 </p> 1275 </p>
1276
1279 <dl> 1277 <dl>
1280 <dt>Return:</dt> 1278 <dt>Return:</dt>
1281 <dd> 1279 <dd>
1282 flag indicating the existence and an error message 1280 flag indicating the existence and an error message
1283 </dd> 1281 </dd>
1289 </dd> 1287 </dd>
1290 </dl> 1288 </dl>
1291 <a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a> 1289 <a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a>
1292 <h4>Subversion.vcsExport</h4> 1290 <h4>Subversion.vcsExport</h4>
1293 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>) 1291 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
1294
1295 <p> 1292 <p>
1296 Public method used to export a directory from the Subversion 1293 Public method used to export a directory from the Subversion
1297 repository. 1294 repository.
1298 </p> 1295 </p>
1296
1299 <dl> 1297 <dl>
1300 1298
1301 <dt><i>vcsDataDict</i> (dict)</dt> 1299 <dt><i>vcsDataDict</i> (dict)</dt>
1302 <dd> 1300 <dd>
1303 dictionary of data required for the checkout 1301 dictionary of data required for the checkout
1320 </dd> 1318 </dd>
1321 </dl> 1319 </dl>
1322 <a NAME="Subversion.vcsForget" ID="Subversion.vcsForget"></a> 1320 <a NAME="Subversion.vcsForget" ID="Subversion.vcsForget"></a>
1323 <h4>Subversion.vcsForget</h4> 1321 <h4>Subversion.vcsForget</h4>
1324 <b>vcsForget</b>(<i>name</i>) 1322 <b>vcsForget</b>(<i>name</i>)
1325
1326 <p> 1323 <p>
1327 Public method used to remove a file from the repository. 1324 Public method used to remove a file from the repository.
1328 </p> 1325 </p>
1329 <p> 1326 <p>
1330 Note: svn does not support this operation. The method is implemented 1327 Note: svn does not support this operation. The method is implemented
1331 as a NoOp. 1328 as a NoOp.
1332 </p> 1329 </p>
1330
1333 <dl> 1331 <dl>
1334 1332
1335 <dt><i>name</i> (str or list of str)</dt> 1333 <dt><i>name</i> (str or list of str)</dt>
1336 <dd> 1334 <dd>
1337 file/directory name to be removed 1335 file/directory name to be removed
1338 </dd> 1336 </dd>
1339 </dl> 1337 </dl>
1340 <a NAME="Subversion.vcsGetProjectBrowserHelper" ID="Subversion.vcsGetProjectBrowserHelper"></a> 1338 <a NAME="Subversion.vcsGetProjectBrowserHelper" ID="Subversion.vcsGetProjectBrowserHelper"></a>
1341 <h4>Subversion.vcsGetProjectBrowserHelper</h4> 1339 <h4>Subversion.vcsGetProjectBrowserHelper</h4>
1342 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) 1340 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
1343
1344 <p> 1341 <p>
1345 Public method to instanciate a helper object for the different 1342 Public method to instanciate a helper object for the different
1346 project browsers. 1343 project browsers.
1347 </p> 1344 </p>
1345
1348 <dl> 1346 <dl>
1349 1347
1350 <dt><i>browser</i> (ProjectBaseBrowser)</dt> 1348 <dt><i>browser</i> (ProjectBaseBrowser)</dt>
1351 <dd> 1349 <dd>
1352 reference to the project browser object 1350 reference to the project browser object
1374 </dd> 1372 </dd>
1375 </dl> 1373 </dl>
1376 <a NAME="Subversion.vcsGetProjectHelper" ID="Subversion.vcsGetProjectHelper"></a> 1374 <a NAME="Subversion.vcsGetProjectHelper" ID="Subversion.vcsGetProjectHelper"></a>
1377 <h4>Subversion.vcsGetProjectHelper</h4> 1375 <h4>Subversion.vcsGetProjectHelper</h4>
1378 <b>vcsGetProjectHelper</b>(<i>project</i>) 1376 <b>vcsGetProjectHelper</b>(<i>project</i>)
1379
1380 <p> 1377 <p>
1381 Public method to instanciate a helper object for the project. 1378 Public method to instanciate a helper object for the project.
1382 </p> 1379 </p>
1380
1383 <dl> 1381 <dl>
1384 1382
1385 <dt><i>project</i> (Project)</dt> 1383 <dt><i>project</i> (Project)</dt>
1386 <dd> 1384 <dd>
1387 reference to the project object 1385 reference to the project object
1400 </dd> 1398 </dd>
1401 </dl> 1399 </dl>
1402 <a NAME="Subversion.vcsImport" ID="Subversion.vcsImport"></a> 1400 <a NAME="Subversion.vcsImport" ID="Subversion.vcsImport"></a>
1403 <h4>Subversion.vcsImport</h4> 1401 <h4>Subversion.vcsImport</h4>
1404 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>) 1402 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>)
1405
1406 <p> 1403 <p>
1407 Public method used to import the project into the Subversion 1404 Public method used to import the project into the Subversion
1408 repository. 1405 repository.
1409 </p> 1406 </p>
1407
1410 <dl> 1408 <dl>
1411 1409
1412 <dt><i>vcsDataDict</i> (dict)</dt> 1410 <dt><i>vcsDataDict</i> (dict)</dt>
1413 <dd> 1411 <dd>
1414 dictionary of data required for the import 1412 dictionary of data required for the import
1440 </dd> 1438 </dd>
1441 </dl> 1439 </dl>
1442 <a NAME="Subversion.vcsInit" ID="Subversion.vcsInit"></a> 1440 <a NAME="Subversion.vcsInit" ID="Subversion.vcsInit"></a>
1443 <h4>Subversion.vcsInit</h4> 1441 <h4>Subversion.vcsInit</h4>
1444 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) 1442 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
1445
1446 <p> 1443 <p>
1447 Public method used to initialize the subversion repository. 1444 Public method used to initialize the subversion repository.
1448 </p> 1445 </p>
1449 <p> 1446 <p>
1450 The subversion repository has to be initialized from outside eric 1447 The subversion repository has to be initialized from outside eric
1451 because the respective command always works locally. Therefore we 1448 because the respective command always works locally. Therefore we
1452 always return TRUE without doing anything. 1449 always return TRUE without doing anything.
1453 </p> 1450 </p>
1451
1454 <dl> 1452 <dl>
1455 1453
1456 <dt><i>vcsDir</i> (str)</dt> 1454 <dt><i>vcsDir</i> (str)</dt>
1457 <dd> 1455 <dd>
1458 name of the VCS directory 1456 name of the VCS directory
1475 </dd> 1473 </dd>
1476 </dl> 1474 </dl>
1477 <a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a> 1475 <a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a>
1478 <h4>Subversion.vcsInitConfig</h4> 1476 <h4>Subversion.vcsInitConfig</h4>
1479 <b>vcsInitConfig</b>(<i>project</i>) 1477 <b>vcsInitConfig</b>(<i>project</i>)
1480
1481 <p> 1478 <p>
1482 Public method to initialize the VCS configuration. 1479 Public method to initialize the VCS configuration.
1483 </p> 1480 </p>
1484 <p> 1481 <p>
1485 This method ensures, that an ignore file exists. 1482 This method ensures, that an ignore file exists.
1486 </p> 1483 </p>
1484
1487 <dl> 1485 <dl>
1488 1486
1489 <dt><i>project</i> (Project)</dt> 1487 <dt><i>project</i> (Project)</dt>
1490 <dd> 1488 <dd>
1491 reference to the project 1489 reference to the project
1492 </dd> 1490 </dd>
1493 </dl> 1491 </dl>
1494 <a NAME="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a> 1492 <a NAME="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a>
1495 <h4>Subversion.vcsLogBrowser</h4> 1493 <h4>Subversion.vcsLogBrowser</h4>
1496 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) 1494 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>)
1497
1498 <p> 1495 <p>
1499 Public method used to browse the log of a file/directory from the 1496 Public method used to browse the log of a file/directory from the
1500 Subversion repository. 1497 Subversion repository.
1501 </p> 1498 </p>
1499
1502 <dl> 1500 <dl>
1503 1501
1504 <dt><i>name</i> (str)</dt> 1502 <dt><i>name</i> (str)</dt>
1505 <dd> 1503 <dd>
1506 file/directory name to show the log of 1504 file/directory name to show the log of
1511 </dd> 1509 </dd>
1512 </dl> 1510 </dl>
1513 <a NAME="Subversion.vcsMerge" ID="Subversion.vcsMerge"></a> 1511 <a NAME="Subversion.vcsMerge" ID="Subversion.vcsMerge"></a>
1514 <h4>Subversion.vcsMerge</h4> 1512 <h4>Subversion.vcsMerge</h4>
1515 <b>vcsMerge</b>(<i>name</i>) 1513 <b>vcsMerge</b>(<i>name</i>)
1516
1517 <p> 1514 <p>
1518 Public method used to merge a URL/revision into the local project. 1515 Public method used to merge a URL/revision into the local project.
1519 </p> 1516 </p>
1517
1520 <dl> 1518 <dl>
1521 1519
1522 <dt><i>name</i> (str)</dt> 1520 <dt><i>name</i> (str)</dt>
1523 <dd> 1521 <dd>
1524 file/directory name to be merged 1522 file/directory name to be merged
1525 </dd> 1523 </dd>
1526 </dl> 1524 </dl>
1527 <a NAME="Subversion.vcsMove" ID="Subversion.vcsMove"></a> 1525 <a NAME="Subversion.vcsMove" ID="Subversion.vcsMove"></a>
1528 <h4>Subversion.vcsMove</h4> 1526 <h4>Subversion.vcsMove</h4>
1529 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) 1527 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>)
1530
1531 <p> 1528 <p>
1532 Public method used to move a file/directory. 1529 Public method used to move a file/directory.
1533 </p> 1530 </p>
1531
1534 <dl> 1532 <dl>
1535 1533
1536 <dt><i>name</i> (str)</dt> 1534 <dt><i>name</i> (str)</dt>
1537 <dd> 1535 <dd>
1538 file/directory name to be moved 1536 file/directory name to be moved
1563 </dd> 1561 </dd>
1564 </dl> 1562 </dl>
1565 <a NAME="Subversion.vcsName" ID="Subversion.vcsName"></a> 1563 <a NAME="Subversion.vcsName" ID="Subversion.vcsName"></a>
1566 <h4>Subversion.vcsName</h4> 1564 <h4>Subversion.vcsName</h4>
1567 <b>vcsName</b>(<i></i>) 1565 <b>vcsName</b>(<i></i>)
1568
1569 <p> 1566 <p>
1570 Public method returning the name of the vcs. 1567 Public method returning the name of the vcs.
1571 </p> 1568 </p>
1569
1572 <dl> 1570 <dl>
1573 <dt>Return:</dt> 1571 <dt>Return:</dt>
1574 <dd> 1572 <dd>
1575 always 'Subversion' 1573 always 'Subversion'
1576 </dd> 1574 </dd>
1582 </dd> 1580 </dd>
1583 </dl> 1581 </dl>
1584 <a NAME="Subversion.vcsNewProjectOptionsDialog" ID="Subversion.vcsNewProjectOptionsDialog"></a> 1582 <a NAME="Subversion.vcsNewProjectOptionsDialog" ID="Subversion.vcsNewProjectOptionsDialog"></a>
1585 <h4>Subversion.vcsNewProjectOptionsDialog</h4> 1583 <h4>Subversion.vcsNewProjectOptionsDialog</h4>
1586 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) 1584 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>)
1587
1588 <p> 1585 <p>
1589 Public method to get a dialog to enter repository info for getting 1586 Public method to get a dialog to enter repository info for getting
1590 a new project. 1587 a new project.
1591 </p> 1588 </p>
1589
1592 <dl> 1590 <dl>
1593 1591
1594 <dt><i>parent</i> (QWidget)</dt> 1592 <dt><i>parent</i> (QWidget)</dt>
1595 <dd> 1593 <dd>
1596 parent widget 1594 parent widget
1609 </dd> 1607 </dd>
1610 </dl> 1608 </dl>
1611 <a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a> 1609 <a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a>
1612 <h4>Subversion.vcsOptionsDialog</h4> 1610 <h4>Subversion.vcsOptionsDialog</h4>
1613 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) 1611 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>)
1614
1615 <p> 1612 <p>
1616 Public method to get a dialog to enter repository info. 1613 Public method to get a dialog to enter repository info.
1617 </p> 1614 </p>
1615
1618 <dl> 1616 <dl>
1619 1617
1620 <dt><i>project</i> (Project)</dt> 1618 <dt><i>project</i> (Project)</dt>
1621 <dd> 1619 <dd>
1622 reference to the project object 1620 reference to the project object
1647 </dd> 1645 </dd>
1648 </dl> 1646 </dl>
1649 <a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a> 1647 <a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a>
1650 <h4>Subversion.vcsRegisteredState</h4> 1648 <h4>Subversion.vcsRegisteredState</h4>
1651 <b>vcsRegisteredState</b>(<i>name</i>) 1649 <b>vcsRegisteredState</b>(<i>name</i>)
1652
1653 <p> 1650 <p>
1654 Public method used to get the registered state of a file in the vcs. 1651 Public method used to get the registered state of a file in the vcs.
1655 </p> 1652 </p>
1653
1656 <dl> 1654 <dl>
1657 1655
1658 <dt><i>name</i> (str)</dt> 1656 <dt><i>name</i> (str)</dt>
1659 <dd> 1657 <dd>
1660 filename to check 1658 filename to check
1673 </dd> 1671 </dd>
1674 </dl> 1672 </dl>
1675 <a NAME="Subversion.vcsRemove" ID="Subversion.vcsRemove"></a> 1673 <a NAME="Subversion.vcsRemove" ID="Subversion.vcsRemove"></a>
1676 <h4>Subversion.vcsRemove</h4> 1674 <h4>Subversion.vcsRemove</h4>
1677 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) 1675 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
1678
1679 <p> 1676 <p>
1680 Public method used to remove a file/directory from the Subversion 1677 Public method used to remove a file/directory from the Subversion
1681 repository. 1678 repository.
1682 </p> 1679 </p>
1683 <p> 1680 <p>
1684 The default operation is to remove the local copy as well. 1681 The default operation is to remove the local copy as well.
1685 </p> 1682 </p>
1683
1686 <dl> 1684 <dl>
1687 1685
1688 <dt><i>name</i> (str or list of str)</dt> 1686 <dt><i>name</i> (str or list of str)</dt>
1689 <dd> 1687 <dd>
1690 file/directory name to be removed 1688 file/directory name to be removed
1711 </dd> 1709 </dd>
1712 </dl> 1710 </dl>
1713 <a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a> 1711 <a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a>
1714 <h4>Subversion.vcsRepositoryInfos</h4> 1712 <h4>Subversion.vcsRepositoryInfos</h4>
1715 <b>vcsRepositoryInfos</b>(<i>ppath</i>) 1713 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
1716
1717 <p> 1714 <p>
1718 Public method to retrieve information about the repository. 1715 Public method to retrieve information about the repository.
1719 </p> 1716 </p>
1717
1720 <dl> 1718 <dl>
1721 1719
1722 <dt><i>ppath</i> (str)</dt> 1720 <dt><i>ppath</i> (str)</dt>
1723 <dd> 1721 <dd>
1724 local path to get the repository infos 1722 local path to get the repository infos
1737 </dd> 1735 </dd>
1738 </dl> 1736 </dl>
1739 <a NAME="Subversion.vcsResolved" ID="Subversion.vcsResolved"></a> 1737 <a NAME="Subversion.vcsResolved" ID="Subversion.vcsResolved"></a>
1740 <h4>Subversion.vcsResolved</h4> 1738 <h4>Subversion.vcsResolved</h4>
1741 <b>vcsResolved</b>(<i>name</i>) 1739 <b>vcsResolved</b>(<i>name</i>)
1742
1743 <p> 1740 <p>
1744 Public method used to resolve conflicts of a file/directory. 1741 Public method used to resolve conflicts of a file/directory.
1745 </p> 1742 </p>
1743
1746 <dl> 1744 <dl>
1747 1745
1748 <dt><i>name</i> (str)</dt> 1746 <dt><i>name</i> (str)</dt>
1749 <dd> 1747 <dd>
1750 file/directory name to be resolved 1748 file/directory name to be resolved
1751 </dd> 1749 </dd>
1752 </dl> 1750 </dl>
1753 <a NAME="Subversion.vcsRevert" ID="Subversion.vcsRevert"></a> 1751 <a NAME="Subversion.vcsRevert" ID="Subversion.vcsRevert"></a>
1754 <h4>Subversion.vcsRevert</h4> 1752 <h4>Subversion.vcsRevert</h4>
1755 <b>vcsRevert</b>(<i>name</i>) 1753 <b>vcsRevert</b>(<i>name</i>)
1756
1757 <p> 1754 <p>
1758 Public method used to revert changes made to a file/directory. 1755 Public method used to revert changes made to a file/directory.
1759 </p> 1756 </p>
1757
1760 <dl> 1758 <dl>
1761 1759
1762 <dt><i>name</i> (str)</dt> 1760 <dt><i>name</i> (str)</dt>
1763 <dd> 1761 <dd>
1764 file/directory name to be reverted 1762 file/directory name to be reverted
1778 </dd> 1776 </dd>
1779 </dl> 1777 </dl>
1780 <a NAME="Subversion.vcsSbsDiff" ID="Subversion.vcsSbsDiff"></a> 1778 <a NAME="Subversion.vcsSbsDiff" ID="Subversion.vcsSbsDiff"></a>
1781 <h4>Subversion.vcsSbsDiff</h4> 1779 <h4>Subversion.vcsSbsDiff</h4>
1782 <b>vcsSbsDiff</b>(<i>name, extended=False, revisions=None</i>) 1780 <b>vcsSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
1783
1784 <p> 1781 <p>
1785 Public method used to view the difference of a file to the Mercurial 1782 Public method used to view the difference of a file to the Mercurial
1786 repository side-by-side. 1783 repository side-by-side.
1787 </p> 1784 </p>
1785
1788 <dl> 1786 <dl>
1789 1787
1790 <dt><i>name</i> (str)</dt> 1788 <dt><i>name</i> (str)</dt>
1791 <dd> 1789 <dd>
1792 file name to be diffed 1790 file name to be diffed
1808 </dd> 1806 </dd>
1809 </dl> 1807 </dl>
1810 <a NAME="Subversion.vcsShutdown" ID="Subversion.vcsShutdown"></a> 1808 <a NAME="Subversion.vcsShutdown" ID="Subversion.vcsShutdown"></a>
1811 <h4>Subversion.vcsShutdown</h4> 1809 <h4>Subversion.vcsShutdown</h4>
1812 <b>vcsShutdown</b>(<i></i>) 1810 <b>vcsShutdown</b>(<i></i>)
1813
1814 <p> 1811 <p>
1815 Public method used to shutdown the Subversion interface. 1812 Public method used to shutdown the Subversion interface.
1816 </p> 1813 </p>
1814
1817 <a NAME="Subversion.vcsStatus" ID="Subversion.vcsStatus"></a> 1815 <a NAME="Subversion.vcsStatus" ID="Subversion.vcsStatus"></a>
1818 <h4>Subversion.vcsStatus</h4> 1816 <h4>Subversion.vcsStatus</h4>
1819 <b>vcsStatus</b>(<i>name</i>) 1817 <b>vcsStatus</b>(<i>name</i>)
1820
1821 <p> 1818 <p>
1822 Public method used to view the status of files/directories in the 1819 Public method used to view the status of files/directories in the
1823 Subversion repository. 1820 Subversion repository.
1824 </p> 1821 </p>
1822
1825 <dl> 1823 <dl>
1826 1824
1827 <dt><i>name</i> (str or list of str)</dt> 1825 <dt><i>name</i> (str or list of str)</dt>
1828 <dd> 1826 <dd>
1829 file/directory name(s) to show the status of 1827 file/directory name(s) to show the status of
1830 </dd> 1828 </dd>
1831 </dl> 1829 </dl>
1832 <a NAME="Subversion.vcsSwitch" ID="Subversion.vcsSwitch"></a> 1830 <a NAME="Subversion.vcsSwitch" ID="Subversion.vcsSwitch"></a>
1833 <h4>Subversion.vcsSwitch</h4> 1831 <h4>Subversion.vcsSwitch</h4>
1834 <b>vcsSwitch</b>(<i>name</i>) 1832 <b>vcsSwitch</b>(<i>name</i>)
1835
1836 <p> 1833 <p>
1837 Public method used to switch a directory to a different tag/branch. 1834 Public method used to switch a directory to a different tag/branch.
1838 </p> 1835 </p>
1836
1839 <dl> 1837 <dl>
1840 1838
1841 <dt><i>name</i> (str)</dt> 1839 <dt><i>name</i> (str)</dt>
1842 <dd> 1840 <dd>
1843 directory name to be switched 1841 directory name to be switched
1856 </dd> 1854 </dd>
1857 </dl> 1855 </dl>
1858 <a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a> 1856 <a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a>
1859 <h4>Subversion.vcsTag</h4> 1857 <h4>Subversion.vcsTag</h4>
1860 <b>vcsTag</b>(<i>name</i>) 1858 <b>vcsTag</b>(<i>name</i>)
1861
1862 <p> 1859 <p>
1863 Public method used to set the tag of a file/directory in the 1860 Public method used to set the tag of a file/directory in the
1864 Subversion repository. 1861 Subversion repository.
1865 </p> 1862 </p>
1863
1866 <dl> 1864 <dl>
1867 1865
1868 <dt><i>name</i> (str)</dt> 1866 <dt><i>name</i> (str)</dt>
1869 <dd> 1867 <dd>
1870 file/directory name to be tagged 1868 file/directory name to be tagged
1871 </dd> 1869 </dd>
1872 </dl> 1870 </dl>
1873 <a NAME="Subversion.vcsUpdate" ID="Subversion.vcsUpdate"></a> 1871 <a NAME="Subversion.vcsUpdate" ID="Subversion.vcsUpdate"></a>
1874 <h4>Subversion.vcsUpdate</h4> 1872 <h4>Subversion.vcsUpdate</h4>
1875 <b>vcsUpdate</b>(<i>name, noDialog=False</i>) 1873 <b>vcsUpdate</b>(<i>name, noDialog=False</i>)
1876
1877 <p> 1874 <p>
1878 Public method used to update a file/directory with the Subversion 1875 Public method used to update a file/directory with the Subversion
1879 repository. 1876 repository.
1880 </p> 1877 </p>
1878
1881 <dl> 1879 <dl>
1882 1880
1883 <dt><i>name</i> (str or list of str)</dt> 1881 <dt><i>name</i> (str or list of str)</dt>
1884 <dd> 1882 <dd>
1885 file/directory name to be updated 1883 file/directory name to be updated

eric ide

mercurial