Sat, 07 Sep 2019 17:35:43 +0200
Closed branch after it was merged into 'default'.
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <!DOCTYPE html> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>eric6.VCS.__init__</title> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <meta charset="UTF-8"> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | <style> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | body { |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | background: #EDECE6; |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | margin: 0em 1em 10em 1em; |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | color: black; |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | h1 { color: white; background: #85774A; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | h2 { color: white; background: #85774A; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | h3 { color: white; background: #9D936E; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | h4 { color: white; background: #9D936E; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | a { color: #BA6D36; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | </style> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | </head> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | <body><a NAME="top" ID="top"></a> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | <h1>eric6.VCS.__init__</h1> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | <p> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | Module implementing the general part of the interface to version control |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | systems. |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | </p><p> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | The general part of the VCS interface defines classes to implement common |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | dialogs. These are a dialog to enter command options, a dialog to display |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | some repository information and an abstract base class. The individual |
6314
2c575553f943
Update source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4081
diff
changeset
|
30 | interfaces have to be subclasses of this base class. |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | </p> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | <h3>Global Attributes</h3> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <table> |
4081
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
34 | <tr><td>VcsBasicHelperSingleton</td></tr> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | </table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | <h3>Classes</h3> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | <table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | <tr><td>None</td></tr> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | </table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | <h3>Functions</h3> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | <table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | <tr> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | <td><a href="#factory">factory</a></td> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | <td>Modul factory function to generate the right vcs object.</td> |
4081
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
45 | </tr><tr> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
46 | <td><a href="#getBasicHelper">getBasicHelper</a></td> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
47 | <td>Module function to get a reference to the basic project helper singleton.</td> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | </tr> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | </table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | <hr /><hr /> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | <a NAME="factory" ID="factory"></a> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
52 | <h2>factory</h2> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | <b>factory</b>(<i>vcs</i>) |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | <p> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55 | Modul factory function to generate the right vcs object. |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56 | </p><dl> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | <dt><i>vcs</i></dt> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | <dd> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | name of the VCS system to be used (string) |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | </dd> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | </dl><dl> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | <dt>Returns:</dt> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | <dd> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | the instantiated VCS object |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | </dd> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | </dl> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | <div align="right"><a href="#top">Up</a></div> |
4081
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
68 | <hr /><hr /> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
69 | <a NAME="getBasicHelper" ID="getBasicHelper"></a> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
70 | <h2>getBasicHelper</h2> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
71 | <b>getBasicHelper</b>(<i>project</i>) |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
72 | <p> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
73 | Module function to get a reference to the basic project helper singleton. |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
74 | </p><dl> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
75 | <dt><i>project</i></dt> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
76 | <dd> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
77 | reference to the project object (Project) |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
78 | </dd> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
79 | </dl><dl> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
80 | <dt>Returns:</dt> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
81 | <dd> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
82 | reference to the basic VCS project helper singleton |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
83 | (VcsProjectHelper) |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
84 | </dd> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
85 | </dl> |
9bf3aa6c65e0
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
86 | <div align="right"><a href="#top">Up</a></div> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
87 | <hr /> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
88 | </body></html> |