|
1 <?xml version="1.0" encoding="ascii"?> |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "DTD/xhtml1-transitional.dtd"> |
|
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
5 <head> |
|
6 <title>ccm.extra</title> |
|
7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
|
8 <script type="text/javascript" src="epydoc.js"></script> |
|
9 </head> |
|
10 |
|
11 <body bgcolor="white" text="black" link="blue" vlink="#204080" |
|
12 alink="#204080"> |
|
13 <!-- ==================== NAVIGATION BAR ==================== --> |
|
14 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
15 bgcolor="#a0c0ff" cellspacing="0"> |
|
16 <tr valign="middle"> |
|
17 |
|
18 <!-- Tree link --> |
|
19 <th> <a |
|
20 href="module-tree.html">Trees</a> </th> |
|
21 |
|
22 <!-- Index link --> |
|
23 <th> <a |
|
24 href="identifier-index.html">Indices</a> </th> |
|
25 |
|
26 <!-- Help link --> |
|
27 <th> <a |
|
28 href="help.html">Help</a> </th> |
|
29 |
|
30 <th class="navbar" width="100%"></th> |
|
31 </tr> |
|
32 </table> |
|
33 <table width="100%" cellpadding="0" cellspacing="0"> |
|
34 <tr valign="top"> |
|
35 <td width="100%"> |
|
36 <span class="breadcrumbs"> |
|
37 <a href="ccm-module.html">Package ccm</a> :: |
|
38 Module extra |
|
39 </span> |
|
40 </td> |
|
41 <td> |
|
42 <table cellpadding="0" cellspacing="0"> |
|
43 <!-- hide/show private --> |
|
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
45 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
46 <tr><td align="right"><span class="options" |
|
47 >[<a href="frames.html" target="_top">frames</a |
|
48 >] | <a href="ccm.extra-module.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== MODULE DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Module extra</h1><span class="codelink"><a href="ccm.extra-pysrc.html">source code</a></span><br /><br /> |
|
56 Library that contains custom Synergy functionnlities: e.g |
|
57 * Snapshotter that can snapshot unfrozen baselines |
|
58 * Threaded snapshotter.<br /><br /> |
|
59 |
|
60 <!-- ==================== CLASSES ==================== --> |
|
61 <a name="section-Classes"></a> |
|
62 <table class="summary" border="1" cellpadding="3" |
|
63 cellspacing="0" width="100%" bgcolor="white"> |
|
64 <tr bgcolor="#70b0f0" class="table-header"> |
|
65 <td colspan="2" class="table-header"> |
|
66 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
67 <tr valign="top"> |
|
68 <td align="left"><span class="table-header">Classes</span></td> |
|
69 <td align="right" valign="top" |
|
70 ><span class="options">[<a href="#section-Classes" |
|
71 class="privatelink" onclick="toggle_private();" |
|
72 >hide private</a>]</span></td> |
|
73 </tr> |
|
74 </table> |
|
75 </td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td width="15%" align="right" valign="top" class="summary"> |
|
79 <span class="summary-type"> </span> |
|
80 </td><td class="summary"> |
|
81 <a href="ccm.extra.CCMExtraException-class.html" class="summary-name">CCMExtraException</a><br /> |
|
82 Exception raised by the methods of this module. |
|
83 </td> |
|
84 </tr> |
|
85 <tr class="private"> |
|
86 <td width="15%" align="right" valign="top" class="summary"> |
|
87 <span class="summary-type"> </span> |
|
88 </td><td class="summary"> |
|
89 <a href="ccm.extra.__FileSnapshot-class.html" class="summary-name">__FileSnapshot</a> |
|
90 </td> |
|
91 </tr> |
|
92 <tr class="private"> |
|
93 <td width="15%" align="right" valign="top" class="summary"> |
|
94 <span class="summary-type"> </span> |
|
95 </td><td class="summary"> |
|
96 <a href="ccm.extra.__ProjectSnapshot-class.html" class="summary-name">__ProjectSnapshot</a> |
|
97 </td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td width="15%" align="right" valign="top" class="summary"> |
|
101 <span class="summary-type"> </span> |
|
102 </td><td class="summary"> |
|
103 <a href="ccm.extra.SessionProvider-class.html" class="summary-name">SessionProvider</a> |
|
104 </td> |
|
105 </tr> |
|
106 <tr> |
|
107 <td width="15%" align="right" valign="top" class="summary"> |
|
108 <span class="summary-type"> </span> |
|
109 </td><td class="summary"> |
|
110 <a href="ccm.extra.CachedSessionProvider-class.html" class="summary-name">CachedSessionProvider</a><br /> |
|
111 <session database="foobar" ccmaddr="xxxx"/> |
|
112 <session database="foobarx" ccmaddr="xxxx"/> |
|
113 </td> |
|
114 </tr> |
|
115 <tr> |
|
116 <td width="15%" align="right" valign="top" class="summary"> |
|
117 <span class="summary-type"> </span> |
|
118 </td><td class="summary"> |
|
119 <a href="ccm.extra.CachedProxySession-class.html" class="summary-name">CachedProxySession</a><br /> |
|
120 Proxy session which will cleanup the session and free it from the provider |
|
121 </td> |
|
122 </tr> |
|
123 </table> |
|
124 <!-- ==================== FUNCTIONS ==================== --> |
|
125 <a name="section-Functions"></a> |
|
126 <table class="summary" border="1" cellpadding="3" |
|
127 cellspacing="0" width="100%" bgcolor="white"> |
|
128 <tr bgcolor="#70b0f0" class="table-header"> |
|
129 <td colspan="2" class="table-header"> |
|
130 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
131 <tr valign="top"> |
|
132 <td align="left"><span class="table-header">Functions</span></td> |
|
133 <td align="right" valign="top" |
|
134 ><span class="options">[<a href="#section-Functions" |
|
135 class="privatelink" onclick="toggle_private();" |
|
136 >hide private</a>]</span></td> |
|
137 </tr> |
|
138 </table> |
|
139 </td> |
|
140 </tr> |
|
141 <tr> |
|
142 <td width="15%" align="right" valign="top" class="summary"> |
|
143 <span class="summary-type"> </span> |
|
144 </td><td class="summary"> |
|
145 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
146 <tr> |
|
147 <td><span class="summary-sig"><a name="Snapshot"></a><span class="summary-sig-name">Snapshot</span>(<span class="summary-sig-arg">project</span>, |
|
148 <span class="summary-sig-arg">targetdir</span>, |
|
149 <span class="summary-sig-arg">dir</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
150 This function can snapshot anything from Synergy, even prep/working projects</td> |
|
151 <td align="right" valign="top"> |
|
152 <span class="codelink"><a href="ccm.extra-pysrc.html#Snapshot">source code</a></span> |
|
153 |
|
154 </td> |
|
155 </tr> |
|
156 </table> |
|
157 |
|
158 </td> |
|
159 </tr> |
|
160 <tr class="private"> |
|
161 <td width="15%" align="right" valign="top" class="summary"> |
|
162 <span class="summary-type"> </span> |
|
163 </td><td class="summary"> |
|
164 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
165 <tr> |
|
166 <td><span class="summary-sig"><a name="__FastSnapshot"></a><span class="summary-sig-name">__FastSnapshot</span>(<span class="summary-sig-arg">pool</span>, |
|
167 <span class="summary-sig-arg">project</span>, |
|
168 <span class="summary-sig-arg">targetdir</span>, |
|
169 <span class="summary-sig-arg">callback</span>, |
|
170 <span class="summary-sig-arg">exc_hld</span>, |
|
171 <span class="summary-sig-arg">dir</span>=<span class="summary-sig-default">None</span>)</span></td> |
|
172 <td align="right" valign="top"> |
|
173 <span class="codelink"><a href="ccm.extra-pysrc.html#__FastSnapshot">source code</a></span> |
|
174 |
|
175 </td> |
|
176 </tr> |
|
177 </table> |
|
178 |
|
179 </td> |
|
180 </tr> |
|
181 <tr> |
|
182 <td width="15%" align="right" valign="top" class="summary"> |
|
183 <span class="summary-type"> </span> |
|
184 </td><td class="summary"> |
|
185 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
186 <tr> |
|
187 <td><span class="summary-sig"><a name="FastSnapshot"></a><span class="summary-sig-name">FastSnapshot</span>(<span class="summary-sig-arg">project</span>, |
|
188 <span class="summary-sig-arg">targetdir</span>, |
|
189 <span class="summary-sig-arg">threads</span>=<span class="summary-sig-default">4</span>)</span><br /> |
|
190 Create snapshot running by running sbsnapshot concurently.</td> |
|
191 <td align="right" valign="top"> |
|
192 <span class="codelink"><a href="ccm.extra-pysrc.html#FastSnapshot">source code</a></span> |
|
193 |
|
194 </td> |
|
195 </tr> |
|
196 </table> |
|
197 |
|
198 </td> |
|
199 </tr> |
|
200 <tr> |
|
201 <td width="15%" align="right" valign="top" class="summary"> |
|
202 <span class="summary-type"> </span> |
|
203 </td><td class="summary"> |
|
204 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
205 <tr> |
|
206 <td><span class="summary-sig"><a name="FastMaintainWorkArea"></a><span class="summary-sig-name">FastMaintainWorkArea</span>(<span class="summary-sig-arg">project</span>, |
|
207 <span class="summary-sig-arg">path</span>, |
|
208 <span class="summary-sig-arg">pst</span>=<span class="summary-sig-default">None</span>, |
|
209 <span class="summary-sig-arg">threads</span>=<span class="summary-sig-default">4</span>, |
|
210 <span class="summary-sig-arg">wat</span>=<span class="summary-sig-default">False</span>)</span><br /> |
|
211 Maintain the workarea of a project in parallel.</td> |
|
212 <td align="right" valign="top"> |
|
213 <span class="codelink"><a href="ccm.extra-pysrc.html#FastMaintainWorkArea">source code</a></span> |
|
214 |
|
215 </td> |
|
216 </tr> |
|
217 </table> |
|
218 |
|
219 </td> |
|
220 </tr> |
|
221 <tr> |
|
222 <td width="15%" align="right" valign="top" class="summary"> |
|
223 <span class="summary-type"> </span> |
|
224 </td><td class="summary"> |
|
225 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
226 <tr> |
|
227 <td><span class="summary-sig"><a name="get_toplevel_project"></a><span class="summary-sig-name">get_toplevel_project</span>(<span class="summary-sig-arg">session</span>, |
|
228 <span class="summary-sig-arg">path</span>)</span></td> |
|
229 <td align="right" valign="top"> |
|
230 <span class="codelink"><a href="ccm.extra-pysrc.html#get_toplevel_project">source code</a></span> |
|
231 |
|
232 </td> |
|
233 </tr> |
|
234 </table> |
|
235 |
|
236 </td> |
|
237 </tr> |
|
238 </table> |
|
239 <!-- ==================== VARIABLES ==================== --> |
|
240 <a name="section-Variables"></a> |
|
241 <table class="summary" border="1" cellpadding="3" |
|
242 cellspacing="0" width="100%" bgcolor="white"> |
|
243 <tr bgcolor="#70b0f0" class="table-header"> |
|
244 <td colspan="2" class="table-header"> |
|
245 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
246 <tr valign="top"> |
|
247 <td align="left"><span class="table-header">Variables</span></td> |
|
248 <td align="right" valign="top" |
|
249 ><span class="options">[<a href="#section-Variables" |
|
250 class="privatelink" onclick="toggle_private();" |
|
251 >hide private</a>]</span></td> |
|
252 </tr> |
|
253 </table> |
|
254 </td> |
|
255 </tr> |
|
256 <tr class="private"> |
|
257 <td width="15%" align="right" valign="top" class="summary"> |
|
258 <span class="summary-type"> </span> |
|
259 </td><td class="summary"> |
|
260 <a name="_logger"></a><span class="summary-name">_logger</span> = <code title="logging.getLogger('ccm.extra')">logging.getLogger('ccm.extra')</code> |
|
261 </td> |
|
262 </tr> |
|
263 </table> |
|
264 <!-- ==================== NAVIGATION BAR ==================== --> |
|
265 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
266 bgcolor="#a0c0ff" cellspacing="0"> |
|
267 <tr valign="middle"> |
|
268 |
|
269 <!-- Tree link --> |
|
270 <th> <a |
|
271 href="module-tree.html">Trees</a> </th> |
|
272 |
|
273 <!-- Index link --> |
|
274 <th> <a |
|
275 href="identifier-index.html">Indices</a> </th> |
|
276 |
|
277 <!-- Help link --> |
|
278 <th> <a |
|
279 href="help.html">Help</a> </th> |
|
280 |
|
281 <th class="navbar" width="100%"></th> |
|
282 </tr> |
|
283 </table> |
|
284 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
285 <tr> |
|
286 <td align="left" class="footer"> |
|
287 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009 |
|
288 </td> |
|
289 <td align="right" class="footer"> |
|
290 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
291 </td> |
|
292 </tr> |
|
293 </table> |
|
294 |
|
295 <script type="text/javascript"> |
|
296 <!-- |
|
297 // Private objects are initially displayed (because if |
|
298 // javascript is turned off then we want them to be |
|
299 // visible); but by default, we want to hide them. So hide |
|
300 // them unless we have a cookie that says to show them. |
|
301 checkCookie() |
|
302 // --> |
|
303 </script> |
|
304 |
|
305 </body> |
|
306 </html> |