Helix SwarmHelix Swarm
Loading...

P4DepotFile.html

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