Helix SwarmHelix Swarm

P4Integration.html

  • //
  • guest/
  • tony_smith/
  • perforce/
  • API/
  • Ruby/
  • main/
  • doc/
  • P4Integration.html #6
  • View
  • Commits
  • Open Download .zip Download (4 KB) 
  1. <html>
  2. <head>
  3.   <title>P4/Ruby - P4Integration</title>
  4.   <link rel="stylesheet" type="text/css" href="docstyle.css">
  5. </head>
  6. <body>
  7.   <p align="right">
  8.     <a href="index.html">Contents</a>
  9.   </p>
  10.  
  11.   <div class="classhdr">
  12.     <table border=0>
  13.       <tr>
  14. 	<td>
  15. 	  <span class="classtag">Class</span>
  16. 	  <span class="classname">P4Integration</span>
  17. 	  <span class="classparent">&lt; Object</span>
  18. 	</td>
  19. 	<td id="righttext">
  20. 	  <span class="requiretag">require</span>
  21. 	  <span class="modulename">"P4"</span>
  22. 	</td>
  23.       </tr>
  24.     </table>
  25.   </div>
  26.  
  27.   <h3>Description</h3>
  28.  
  29.   Utility class providing easy access to the details of an integration
  30.   record.
  31.  
  32.   <div class="classmethods">
  33.     <h3>Class Methods</h3>
  34.  
  35.     <div class="index">
  36.       <table border="0">
  37. 	<tr>
  38. 	  <td>
  39. 	    <a href="#new">new</a>
  40. 	  </td>
  41. 	</tr>
  42.       </table>
  43.     </div>
  44.  
  45.     <a name="new"></a>
  46.     <div class="method">
  47.       <div class="methodheader">
  48. 	<table width="100%">
  49. 	  <tr>
  50. 	    <td class="meth_name">new</td>
  51. 	    <td>&nbsp;</td>
  52. 	    <td class="proto">
  53. 	      P4Integration.new( <i>how, file, srev, erev</i> ) -&gt; <i>aP4Integration</i>
  54. 	    </td>
  55. 	  </tr>
  56. 	</table>
  57.       </div>
  58.  
  59.       Constructs a new P4Integration object. "how" represents the type of 
  60.       operation e.g. "copy from", "merge into" etc. whilst, "file" is the name 
  61.       of the integrated file and "srev" and "erev" the start and end revision
  62.       numbers for this integration.
  63.  
  64.       <pre>
  65.     integ = P4Integration.new( "copy from", "//depot/main/main.c", 1, 3 )
  66.       </pre>
  67.  
  68.     </div>
  69.   </div>
  70.  
  71.   <div class="instancemethods">
  72.     <h3>Instance Methods</h3>
  73.  
  74.     <div class="index">
  75.       <table border="0">
  76. 	<tr>
  77. 	  <td>
  78. 	    <a href="#how">how</a>
  79. 	    <a href="#erev">erev</a>
  80. 	  </td>
  81. 	  <td>
  82. 	    <a href="#file">file</a>
  83. 	  </td>
  84. 	  <td>
  85. 	    <a href="#srev">srev</a>
  86. 	  </td>
  87. 	</tr>
  88.       </table>
  89.     </div>
  90.  
  91.     <a name="how"></a>
  92.     <div class="method">
  93.       <div class="methodheader">
  94. 	<table width="100%">
  95. 	  <tr>
  96. 	    <td class="meth_name">how</td>
  97. 	    <td>&nbsp;</td>
  98. 	    <td class="proto">
  99. 	    </td>
  100. 	  </tr>
  101. 	</table>
  102.       </div>
  103.  
  104.       Returns the type of the integration record - how the record was 
  105.       created. 
  106.     </div>
  107.   
  108.     <a name="file"></a>
  109.     <div class="method">
  110.       <div class="methodheader">
  111. 	<table width="100%">
  112. 	  <tr>
  113. 	    <td class="meth_name">file</td>
  114. 	    <td>&nbsp;</td>
  115. 	    <td class="proto">
  116. 	      <i>integ</i>.file -&gt; <i>aPath</i>
  117. 	    </td>
  118. 	  </tr>
  119. 	</table>
  120.       </div>
  121.  
  122.       Returns the path to the file being integrated to/from.
  123.     </div>
  124.   
  125.     <a name="srev"></a>
  126.     <div class="method">
  127.       <div class="methodheader">
  128. 	<table width="100%">
  129. 	  <tr>
  130. 	    <td class="meth_name">srev</td>
  131. 	    <td>&nbsp;</td>
  132. 	    <td class="proto">
  133. 	      <i>integ</i>.srev -&gt; <i>aNumber</i>
  134. 	    </td>
  135. 	  </tr>
  136. 	</table>
  137.       </div>
  138.  
  139.       Returns the start revision number used for this integration.
  140.     </div>
  141.   
  142.     <a name="erev"></a>
  143.     <div class="method">
  144.       <div class="methodheader">
  145. 	<table width="100%">
  146. 	  <tr>
  147. 	    <td class="meth_name">erev</td>
  148. 	    <td>&nbsp;</td>
  149. 	    <td class="proto">
  150. 	      <i>integ</i>.erev -&gt; <i>aNumber</i>
  151. 	    </td>
  152. 	  </tr>
  153. 	</table>
  154.       </div>
  155.  
  156.       Returns the end revision number used for this integration.
  157.     </div>
  158.   </div>
  159.  
  160.   <div class="seealso">
  161.     <h3>See Also</h3>
  162.  
  163.     <a href="P4.html">P4</a>
  164.     <a href="P4Exception.html">P4Exception</a>
  165.     <a href="P4DepotFile.html">P4DepotFile</a>
  166.     <a href="P4Revision.html">P4Revision</a>
  167.     <a href="P4Spec.html">P4::Spec</a>
  168.   </div>
  169.  
  170. </body>
  171. </html>
  172.   
  173.  
  174.  
# Change User Description Committed
#6 4680 Tony Smith Make P4Ruby return new P4::Spec objects instead of plain old
hashes when parse_forms mode... is in use. A P4::Spec object is derived
from Hash so should be backwards compatible with previous code.

P4::Spec provides limited fieldname validation on forms and
accessor methods for quick and easy access to the fields in the
form. The accessor methods are all prefixed with '_' to avoid
colliding with methods from the Hash parent class. This is a little
ugly, but deriving from hash is a big win, so it's worth it.

This change also fixes a minor bug found along the way. Spec parsing
and formatting wouldn't work with labels, branches, depots and groups
unless you'd previously run a P4::fetch_label( <label> ),
P4::fetch_branch( <branch> ) etc. etc. This is because the spec
parsing code internally runs one of these commands in order to grab
the specdef from the server but it wasn't providing a spec name. i.e.
it was using 'p4 client -o' and assuming that this would work for
other types of spec too. It does, but not for all spec types. So,
now the spec parsing code will use a bogus name for the spec types
that require it. «		 20 years ago
#5 4653 Tony Smith More documentation tweaks.
Just makes the pages look more
like the reference pages in the... 'Pickaxe book' «		 20 years ago
#4 4652 Tony Smith Doc update for P4Ruby.
Rework the html and the CSS to make the
docs a little easier on t...he eye and easier to use too. «		 20 years ago
#3 4255 Tony Smith P4Ruby doc reformatting.
Now uses CSS instead of 1x1 image and too
many tables. Could no... doubt be improved upon, but it's a start. «		 21 years ago
#2 2426 Tony Smith Doc beautifying for P4Ruby. 22 years ago
#1 1324 Tony Smith P4/Ruby documentation update.
Changed doc layout and added
in docs for newly added method...s and classes. «		 23 years ago