Loading...
Helix SwarmHelix Swarm
Loading...

P4Revision.html

  • //
  • guest/
  • tony_smith/
  • perforce/
  • API/
  • Ruby/
  • main/
  • doc/
  • P4Revision.html #6
  • View
  • Commits
  • Open Download .zip Download (7 KB) 
  1. <html>
  2. <head>
  3.   <title>P4/Ruby - P4Revision</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">P4Revision</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.   <div class="classhdr">
  27.   </div>
  28.  
  29.   <h3>Description</h3>
  30.  
  31.   Utility class providing easy access to the revisions of a file in a
  32.   Perforce depot. P4Revision objects can store basic information about
  33.   revisions and a list of the integrations for that revision
  34.  
  35.   <div class="classmethods">
  36.     <h3>Class Methods</h3>
  37.  
  38.  
  39.     <div class="index">
  40.       <table border="0">
  41. 	<tr>
  42. 	  <td>
  43. 	    <a href="#new">new</a>
  44. 	  </td>
  45. 	</tr>
  46.       </table>
  47.     </div>
  48.  
  49.  
  50.     <a name="new"></a>
  51.     <div class="method">
  52.       <div class="methodheader">
  53. 	<table width="100%">
  54. 	  <tr>
  55. 	    <td class="meth_name">new</td>
  56. 	    <td>&nbsp;</td>
  57. 	    <td class="proto">
  58. 	      P4Revision.new( <i>aString</i> ) -&gt; <i>aP4Revision</i>
  59. 	    </td>
  60. 	  </tr>
  61. 	</table>
  62.       </div>
  63.  
  64.       Constructs a new P4Revision object for the named depot file.
  65.     </div>
  66.   </div>
  67.  
  68.   <div class="instancemethods">
  69.  
  70.     <h3>Instance Methods</h3>
  71.  
  72.     <div class="index">
  73.       <table border="0">
  74. 	<tr>
  75. 	  <td>
  76. 	    <a href="#action">action</a>
  77. 	    <a href="#change">change</a>
  78. 	    <a href="#client">client</a>
  79. 	    <a href="#depot_file">depot_file</a>
  80. 	  </td>
  81. 	  <td>
  82. 	    <a href="#desc">desc</a>
  83. 	    <a href="#each_integration">each_integration</a>
  84. 	    <a href="#integration">integration</a>
  85. 	    <a href="#integrations">integrations</a>
  86. 	  </td>
  87. 	  <td>
  88. 	    <a href="#revno">revno</a>
  89. 	    <a href="#time">time</a>
  90. 	    <a href="#type">type</a>
  91. 	    <a href="#user">user</a>
  92. 	  </td>
  93. 	</tr>
  94.       </table>
  95.     </div>
  96.  
  97.  
  98.     <a name="action"></a>
  99.     <div class="method">
  100.       <div class="methodheader">
  101. 	<table width="100%">
  102. 	  <tr>
  103. 	    <td class="meth_name">action</td>
  104. 	    <td>&nbsp;</td>
  105. 	    <td class="proto">
  106. 	      <i>rev</i>.action -&gt; <i>aString</i>
  107. 	    </td>
  108. 	  </tr>
  109. 	</table>
  110.       </div>
  111.  
  112.       Returns the name of the action which gave rise to this revision of the 
  113.       file.
  114.     </div>
  115.  
  116.     <a name="change"></a>
  117.     <div class="method">
  118.       <div class="methodheader">
  119. 	<table width="100%">
  120. 	  <tr>
  121. 	    <td class="meth_name">change</td>
  122. 	    <td>&nbsp;</td>
  123. 	    <td class="proto">
  124. 	      <i>rev</i>.change -&gt; <i>aNumber</i>
  125. 	    </td>
  126. 	  </tr>
  127. 	</table>
  128.       </div>
  129.  
  130.       Returns the change number that gave rise to this revision of the file.
  131.     </div>
  132.  
  133.     <a name="client"></a>
  134.     <div class="method">
  135.       <div class="methodheader">
  136. 	<table width="100%">
  137. 	  <tr>
  138. 	    <td class="meth_name">client</td>
  139. 	    <td>&nbsp;</td>
  140. 	    <td class="proto">
  141. 	      <i>rev</i>.client -&gt; <i>aString</i>
  142. 	    </td>
  143. 	  </tr>
  144. 	</table>
  145.       </div>
  146.  
  147.       Returns the name of the client from which this revision was submitted.
  148.     </div>
  149.  
  150.     <a name="depot_file"></a>
  151.     <div class="method">
  152.       <div class="methodheader">
  153. 	<table width="100%">
  154. 	  <tr>
  155. 	    <td class="meth_name">depot_file</td>
  156. 	    <td>&nbsp;</td>
  157. 	    <td class="proto">
  158. 	      <i>rev</i>.depot_file -&gt; <i>aString</i>
  159. 	    </td>
  160. 	  </tr>
  161. 	</table>
  162.       </div>
  163.  
  164.       Returns the name of the depot file this object refers to.
  165.     </div>
  166.  
  167.     <a name="desc"></a>
  168.     <div class="method">
  169.       <div class="methodheader">
  170. 	<table width="100%">
  171. 	  <tr>
  172. 	    <td class="meth_name">desc</td>
  173. 	    <td>&nbsp;</td>
  174. 	    <td class="proto">
  175. 	      <i>rev</i>.desc -&gt; <i>aString</i>
  176. 	  </td>
  177. 	    </td>
  178. 	  </tr>
  179. 	</table>
  180.       </div>
  181.  
  182.       Returns the description of the change which created this revision. Note
  183.     </div>
  184.  
  185.     <a name="each_integration"></a>
  186.     <div class="method">
  187.       <div class="methodheader">
  188. 	<table width="100%">
  189. 	  <tr>
  190. 	    <td class="meth_name">each_integration</td>
  191. 	    <td>&nbsp;</td>
  192. 	    <td class="proto">
  193. 	      <i>rev</i>.each_integration { |<i>integ</i>| block } -&gt; <i>integArray</i>
  194. 	    </td>
  195. 	  </tr>
  196. 	</table>
  197.       </div>
  198.  
  199.       Iterates over each the integration records for this revision of the depot 
  200.       file.
  201.     </div>
  202.  
  203.     <a name="integration"></a>
  204.     <div class="method">
  205.       <div class="methodheader">
  206. 	<table width="100%">
  207. 	  <tr>
  208. 	    <td class="meth_name">integration</td>
  209. 	    <td>&nbsp;</td>
  210. 	    <td class="proto">
  211. 	      <i>rev</i>.integration( how, file, srev, erev ) -&gt; <i>aP4Integration</i>
  212. 	    </td>
  213. 	  </tr>
  214. 	</table>
  215.       </div>
  216.  
  217.       Adds a new integration record to the revision returning the integration
  218.       record.
  219.     </div>
  220.  
  221.     <a name="integrations"></a>
  222.     <div class="method">
  223.       <div class="methodheader">
  224. 	<table width="100%">
  225. 	  <tr>
  226. 	    <td class="meth_name">integrations</td>
  227. 	    <td>&nbsp;</td>
  228. 	    <td class="proto">
  229. 	      <i>rev</i>.integrations -&gt; <i>integArray</i>
  230. 	    </td>
  231. 	  </tr>
  232. 	</table>
  233.       </div>
  234.  
  235.       Returns the list of integrations for this revision
  236.     </div>
  237.  
  238.     <a name="revno"></a>
  239.     <div class="method">
  240.       <div class="methodheader">
  241. 	<table width="100%">
  242. 	  <tr>
  243. 	    <td class="meth_name">revno</td>
  244. 	    <td>&nbsp;</td>
  245. 	    <td class="proto">
  246. 	      <i>rev</i>.revno -&gt; <i>aNumber</i>
  247. 	    </td>
  248. 	  </tr>
  249. 	</table>
  250.       </div>
  251.  
  252.       Returns the number of this revision of the file
  253.     </div>
  254.  
  255.     <a name="time"></a>
  256.     <div class="method">
  257.       <div class="methodheader">
  258. 	<table width="100%">
  259. 	  <tr>
  260. 	    <td class="meth_name">time</td>
  261. 	    <td>&nbsp;</td>
  262. 	    <td class="proto">
  263. 	      <i>rev</i>.time -&gt; <i>aTime</i>
  264. 	    </td>
  265. 	  </tr>
  266. 	</table>
  267.       </div>
  268.  
  269.       Returns the date/time that this revision was created.
  270.     </div>
  271.  
  272.     <a name="type"></a>
  273.     <div class="method">
  274.       <div class="methodheader">
  275. 	<table width="100%">
  276. 	  <tr>
  277. 	    <td class="meth_name">type</td>
  278. 	    <td>&nbsp;</td>
  279. 	    <td class="proto">
  280. 	      <i>rev</i>.type -&gt; <i>aString</i>
  281. 	    </td>
  282. 	  </tr>
  283. 	</table>
  284.       </div>
  285.  
  286.       Returns this revisions Perforce type
  287.     </div>
  288.  
  289.     <a name="user"></a>
  290.     <div class="method">
  291.       <div class="methodheader">
  292. 	<table width="100%">
  293. 	  <tr>
  294. 	    <td class="meth_name">user</td>
  295. 	    <td>&nbsp;</td>
  296. 	    <td class="proto">
  297. 	      <i>rev</i>.user -&gt; <i>aString</i>
  298. 	    </td>
  299. 	  </tr>
  300. 	</table>
  301.       </div>
  302.  
  303.       Returns the name of the user who created this revision.
  304.     </div>
  305.   </div>
  306.  
  307.   <div class="seealso">
  308.     <h3>See Also</h3>
  309.  
  310.     <a href="P4.html">P4</a>
  311.     <a href="P4Exception.html">P4Exception</a>
  312.     <a href="P4DepotFile.html">P4DepotFile</a>
  313.     <a href="P4Integration.html">P4Integration</a>
  314.     <a href="P4Spec.html">P4::Spec</a>
  315.   </div>
  316.  
  317. </body>
  318. </html>
  319.   
  320.  
  321.  
# 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 2392 Tony Smith Add missing documentation file 22 years ago