doc/api/python/validateoverlay-module.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     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>validateoverlay</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>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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         Module&nbsp;validateoverlay
       
    38       </span>
       
    39     </td>
       
    40     <td>
       
    41       <table cellpadding="0" cellspacing="0">
       
    42         <!-- hide/show private -->
       
    43         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    44     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    45         <tr><td align="right"><span class="options"
       
    46             >[<a href="frames.html" target="_top">frames</a
       
    47             >]&nbsp;|&nbsp;<a href="validateoverlay-module.html"
       
    48             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    49       </table>
       
    50     </td>
       
    51   </tr>
       
    52 </table>
       
    53 <!-- ==================== MODULE DESCRIPTION ==================== -->
       
    54 <h1 class="epydoc">Module validateoverlay</h1><span class="codelink"><a href="validateoverlay-pysrc.html">source&nbsp;code</a></span><br /><br />
       
    55 <!-- ==================== CLASSES ==================== -->
       
    56 <a name="section-Classes"></a>
       
    57 <table class="summary" border="1" cellpadding="3"
       
    58        cellspacing="0" width="100%" bgcolor="white">
       
    59 <tr bgcolor="#70b0f0" class="table-header">
       
    60   <td colspan="2" class="table-header">
       
    61     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    62       <tr valign="top">
       
    63         <td align="left"><span class="table-header">Classes</span></td>
       
    64         <td align="right" valign="top"
       
    65          ><span class="options">[<a href="#section-Classes"
       
    66          class="privatelink" onclick="toggle_private();"
       
    67          >hide private</a>]</span></td>
       
    68       </tr>
       
    69     </table>
       
    70   </td>
       
    71 </tr>
       
    72 <tr>
       
    73     <td width="15%" align="right" valign="top" class="summary">
       
    74       <span class="summary-type">&nbsp;</span>
       
    75     </td><td class="summary">
       
    76         <a href="validateoverlay.ValidateOverlayInfo-class.html" class="summary-name">ValidateOverlayInfo</a>
       
    77     </td>
       
    78   </tr>
       
    79 </table>
       
    80 <!-- ==================== FUNCTIONS ==================== -->
       
    81 <a name="section-Functions"></a>
       
    82 <table class="summary" border="1" cellpadding="3"
       
    83        cellspacing="0" width="100%" bgcolor="white">
       
    84 <tr bgcolor="#70b0f0" class="table-header">
       
    85   <td colspan="2" class="table-header">
       
    86     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    87       <tr valign="top">
       
    88         <td align="left"><span class="table-header">Functions</span></td>
       
    89         <td align="right" valign="top"
       
    90          ><span class="options">[<a href="#section-Functions"
       
    91          class="privatelink" onclick="toggle_private();"
       
    92          >hide private</a>]</span></td>
       
    93       </tr>
       
    94     </table>
       
    95   </td>
       
    96 </tr>
       
    97 <tr class="private">
       
    98     <td width="15%" align="right" valign="top" class="summary">
       
    99       <span class="summary-type">&nbsp;</span>
       
   100     </td><td class="summary">
       
   101       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   102         <tr>
       
   103           <td><span class="summary-sig"><a name="__findChild"></a><span class="summary-sig-name">__findChild</span>(<span class="summary-sig-arg">p</span>,
       
   104         <span class="summary-sig-arg">d</span>,
       
   105         <span class="summary-sig-arg">name</span>)</span></td>
       
   106           <td align="right" valign="top">
       
   107             <span class="codelink"><a href="validateoverlay-pysrc.html#__findChild">source&nbsp;code</a></span>
       
   108             
       
   109           </td>
       
   110         </tr>
       
   111       </table>
       
   112       
       
   113     </td>
       
   114   </tr>
       
   115 <tr class="private">
       
   116     <td width="15%" align="right" valign="top" class="summary">
       
   117       <span class="summary-type">&nbsp;</span>
       
   118     </td><td class="summary">
       
   119       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   120         <tr>
       
   121           <td><span class="summary-sig"><a name="__getDir"></a><span class="summary-sig-name">__getDir</span>(<span class="summary-sig-arg">p</span>,
       
   122         <span class="summary-sig-arg">o</span>)</span></td>
       
   123           <td align="right" valign="top">
       
   124             <span class="codelink"><a href="validateoverlay-pysrc.html#__getDir">source&nbsp;code</a></span>
       
   125             
       
   126           </td>
       
   127         </tr>
       
   128       </table>
       
   129       
       
   130     </td>
       
   131   </tr>
       
   132 <tr>
       
   133     <td width="15%" align="right" valign="top" class="summary">
       
   134       <span class="summary-type">&nbsp;</span>
       
   135     </td><td class="summary">
       
   136       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   137         <tr>
       
   138           <td><span class="summary-sig"><a name="ValidateOverlay"></a><span class="summary-sig-name">ValidateOverlay</span>(<span class="summary-sig-arg">vproject</span>,
       
   139         <span class="summary-sig-arg">vdir</span>,
       
   140         <span class="summary-sig-arg">oproject</span>,
       
   141         <span class="summary-sig-arg">odir</span>,
       
   142         <span class="summary-sig-arg">extraobject</span>=<span class="summary-sig-default">None</span>)</span><br />
       
   143       This function scan an the virtual build area and the overlay to validate
       
   144 if the overlay content is still up to date compare to the delivery.</td>
       
   145           <td align="right" valign="top">
       
   146             <span class="codelink"><a href="validateoverlay-pysrc.html#ValidateOverlay">source&nbsp;code</a></span>
       
   147             
       
   148           </td>
       
   149         </tr>
       
   150       </table>
       
   151       
       
   152     </td>
       
   153   </tr>
       
   154 <tr>
       
   155     <td width="15%" align="right" valign="top" class="summary">
       
   156       <span class="summary-type">&nbsp;</span>
       
   157     </td><td class="summary">
       
   158       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   159         <tr>
       
   160           <td><span class="summary-sig"><a name="getObjectPath"></a><span class="summary-sig-name">getObjectPath</span>(<span class="summary-sig-arg">project</span>,
       
   161         <span class="summary-sig-arg">spath</span>,
       
   162         <span class="summary-sig-arg">dir</span>=<span class="summary-sig-default">None</span>)</span></td>
       
   163           <td align="right" valign="top">
       
   164             <span class="codelink"><a href="validateoverlay-pysrc.html#getObjectPath">source&nbsp;code</a></span>
       
   165             
       
   166           </td>
       
   167         </tr>
       
   168       </table>
       
   169       
       
   170     </td>
       
   171   </tr>
       
   172 <tr>
       
   173     <td width="15%" align="right" valign="top" class="summary">
       
   174       <span class="summary-type">&nbsp;</span>
       
   175     </td><td class="summary">
       
   176       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   177         <tr>
       
   178           <td><span class="summary-sig"><a name="showBranchInfo"></a><span class="summary-sig-name">showBranchInfo</span>(<span class="summary-sig-arg">logger</span>,
       
   179         <span class="summary-sig-arg">object</span>)</span></td>
       
   180           <td align="right" valign="top">
       
   181             <span class="codelink"><a href="validateoverlay-pysrc.html#showBranchInfo">source&nbsp;code</a></span>
       
   182             
       
   183           </td>
       
   184         </tr>
       
   185       </table>
       
   186       
       
   187     </td>
       
   188   </tr>
       
   189 <tr>
       
   190     <td width="15%" align="right" valign="top" class="summary">
       
   191       <span class="summary-type">&nbsp;</span>
       
   192     </td><td class="summary">
       
   193       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   194         <tr>
       
   195           <td><span class="summary-sig"><a name="showValidity"></a><span class="summary-sig-name">showValidity</span>(<span class="summary-sig-arg">logger</span>,
       
   196         <span class="summary-sig-arg">obj</span>)</span></td>
       
   197           <td align="right" valign="top">
       
   198             <span class="codelink"><a href="validateoverlay-pysrc.html#showValidity">source&nbsp;code</a></span>
       
   199             
       
   200           </td>
       
   201         </tr>
       
   202       </table>
       
   203       
       
   204     </td>
       
   205   </tr>
       
   206 <tr>
       
   207     <td width="15%" align="right" valign="top" class="summary">
       
   208       <span class="summary-type">&nbsp;</span>
       
   209     </td><td class="summary">
       
   210       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   211         <tr>
       
   212           <td><span class="summary-sig"><a name="showValidateOverlayInfo"></a><span class="summary-sig-name">showValidateOverlayInfo</span>(<span class="summary-sig-arg">logger</span>,
       
   213         <span class="summary-sig-arg">data</span>,
       
   214         <span class="summary-sig-arg">comments</span>=<span class="summary-sig-default">False</span>)</span></td>
       
   215           <td align="right" valign="top">
       
   216             <span class="codelink"><a href="validateoverlay-pysrc.html#showValidateOverlayInfo">source&nbsp;code</a></span>
       
   217             
       
   218           </td>
       
   219         </tr>
       
   220       </table>
       
   221       
       
   222     </td>
       
   223   </tr>
       
   224 <tr>
       
   225     <td width="15%" align="right" valign="top" class="summary">
       
   226       <span class="summary-type">&nbsp;</span>
       
   227     </td><td class="summary">
       
   228       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   229         <tr>
       
   230           <td><span class="summary-sig"><a name="mergeObjects"></a><span class="summary-sig-name">mergeObjects</span>(<span class="summary-sig-arg">logger</span>,
       
   231         <span class="summary-sig-arg">data</span>,
       
   232         <span class="summary-sig-arg">task</span>)</span></td>
       
   233           <td align="right" valign="top">
       
   234             <span class="codelink"><a href="validateoverlay-pysrc.html#mergeObjects">source&nbsp;code</a></span>
       
   235             
       
   236           </td>
       
   237         </tr>
       
   238       </table>
       
   239       
       
   240     </td>
       
   241   </tr>
       
   242 <tr>
       
   243     <td width="15%" align="right" valign="top" class="summary">
       
   244       <span class="summary-type">&nbsp;</span>
       
   245     </td><td class="summary">
       
   246       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   247         <tr>
       
   248           <td><span class="summary-sig"><a name="validate"></a><span class="summary-sig-name">validate</span>(<span class="summary-sig-arg">session</span>,
       
   249         <span class="summary-sig-arg">inputfile</span>,
       
   250         <span class="summary-sig-arg">overlaydir</span>,
       
   251         <span class="summary-sig-arg">showBranchInfo</span>,
       
   252         <span class="summary-sig-arg">createtask</span>=<span class="summary-sig-default">False</span>,
       
   253         <span class="summary-sig-arg">releasetag</span>=<span class="summary-sig-default">None</span>,
       
   254         <span class="summary-sig-arg">extra_objects</span>=<span class="summary-sig-default">None</span>,
       
   255         <span class="summary-sig-arg">logname</span>=<span class="summary-sig-default">&quot;validate_overlay&quot;</span>)</span><br />
       
   256       Validate an overlay uisng data from the inputfile to generate the virtual build area.</td>
       
   257           <td align="right" valign="top">
       
   258             <span class="codelink"><a href="validateoverlay-pysrc.html#validate">source&nbsp;code</a></span>
       
   259             
       
   260           </td>
       
   261         </tr>
       
   262       </table>
       
   263       
       
   264     </td>
       
   265   </tr>
       
   266 <tr>
       
   267     <td width="15%" align="right" valign="top" class="summary">
       
   268       <span class="summary-type">&nbsp;</span>
       
   269     </td><td class="summary">
       
   270       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   271         <tr>
       
   272           <td><span class="summary-sig"><a name="main"></a><span class="summary-sig-name">main</span>()</span></td>
       
   273           <td align="right" valign="top">
       
   274             <span class="codelink"><a href="validateoverlay-pysrc.html#main">source&nbsp;code</a></span>
       
   275             
       
   276           </td>
       
   277         </tr>
       
   278       </table>
       
   279       
       
   280     </td>
       
   281   </tr>
       
   282 <tr>
       
   283     <td width="15%" align="right" valign="top" class="summary">
       
   284       <span class="summary-type">&nbsp;</span>
       
   285     </td><td class="summary">
       
   286       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   287         <tr>
       
   288           <td><span class="summary-sig"><a name="showVirtualContent"></a><span class="summary-sig-name">showVirtualContent</span>(<span class="summary-sig-arg">project</span>,
       
   289         <span class="summary-sig-arg">path</span>,
       
   290         <span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">''</span>)</span></td>
       
   291           <td align="right" valign="top">
       
   292             <span class="codelink"><a href="validateoverlay-pysrc.html#showVirtualContent">source&nbsp;code</a></span>
       
   293             
       
   294           </td>
       
   295         </tr>
       
   296       </table>
       
   297       
       
   298     </td>
       
   299   </tr>
       
   300 <tr>
       
   301     <td width="15%" align="right" valign="top" class="summary">
       
   302       <span class="summary-type">&nbsp;</span>
       
   303     </td><td class="summary">
       
   304       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   305         <tr>
       
   306           <td><span class="summary-sig"><a name="get_additional_delivery_objects"></a><span class="summary-sig-name">get_additional_delivery_objects</span>(<span class="summary-sig-arg">session</span>,
       
   307         <span class="summary-sig-arg">deliveryinput</span>)</span></td>
       
   308           <td align="right" valign="top">
       
   309             <span class="codelink"><a href="validateoverlay-pysrc.html#get_additional_delivery_objects">source&nbsp;code</a></span>
       
   310             
       
   311           </td>
       
   312         </tr>
       
   313       </table>
       
   314       
       
   315     </td>
       
   316   </tr>
       
   317 </table>
       
   318 <!-- ==================== NAVIGATION BAR ==================== -->
       
   319 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   320        bgcolor="#a0c0ff" cellspacing="0">
       
   321   <tr valign="middle">
       
   322 
       
   323   <!-- Tree link -->
       
   324       <th>&nbsp;&nbsp;&nbsp;<a
       
   325         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   326 
       
   327   <!-- Index link -->
       
   328       <th>&nbsp;&nbsp;&nbsp;<a
       
   329         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   330 
       
   331   <!-- Help link -->
       
   332       <th>&nbsp;&nbsp;&nbsp;<a
       
   333         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   334 
       
   335       <th class="navbar" width="100%"></th>
       
   336   </tr>
       
   337 </table>
       
   338 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   339   <tr>
       
   340     <td align="left" class="footer">
       
   341     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009
       
   342     </td>
       
   343     <td align="right" class="footer">
       
   344       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   345     </td>
       
   346   </tr>
       
   347 </table>
       
   348 
       
   349 <script type="text/javascript">
       
   350   <!--
       
   351   // Private objects are initially displayed (because if
       
   352   // javascript is turned off then we want them to be
       
   353   // visible); but by default, we want to hide them.  So hide
       
   354   // them unless we have a cookie that says to show them.
       
   355   checkCookie()
       
   356   // -->
       
   357 </script>
       
   358   
       
   359 </body>
       
   360 </html>