Helix SwarmHelix Swarm

P4MergeData.html

  • //
  • guest/
  • tony_smith/
  • perforce/
  • API/
  • Ruby/
  • main/
  • doc/
  • P4MergeData.html #1
  • View
  • Commits
  • Open Download .zip Download (6 KB) 
  1. <html>
  2. <head>
  3.   <title>P4/Ruby</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">P4::MergeData</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.   Class containing the context for an individual merge during execution
  30.   of a 'p4 resolve'.
  31.  
  32.   <div class="classmethods">
  33.     <h3>Class Methods</h3>
  34.     <div class="index">
  35.       <table border="0">
  36. 	<tr>
  37. 	  <td>
  38. 	    None 
  39. 	  </td>
  40. 	</tr>
  41.       </table>
  42.     </div>
  43.   </div>
  44.  
  45.  
  46.   <div class="instancemethods">
  47.     <h3>Instance Methods</h3>
  48.     <div class="index">
  49.       <table border="0">
  50. 	<tr>
  51. 	  <td>
  52. 	    <a href="#your_name">your_name</a>
  53. 	    <a href="#their_name">their_name</a>
  54. 	    <a href="#base_name">base_name</a>
  55. 	  </td>
  56. 	  <td>
  57. 	    <a href="#your_path">your_path</a>
  58. 	    <a href="#their_path">their_path</a>
  59. 	    <a href="#base_path">base_path</a>
  60. 	  </td>
  61. 	  <td>
  62. 	    <a href="#result_path">result_path</a>
  63. 	    <a href="#merge_hint">merge_hint</a>
  64. 	    <a href="#run_merge">run_merge</a>
  65. 	  </td>
  66. 	</tr>
  67.       </table>
  68.     </div>
  69.   </div>
  70.  
  71.   <a name="your_name"></a>
  72.   <div class="method">
  73.     <div class="methodheader">
  74.       <table>
  75. 	<tr>
  76. 	  <td class="meth_name">your_name</td>
  77. 	  <td class="proto">
  78. 	    <i>md</i>.your_name() -&gt; <i>aString</i>
  79. 	  </td>
  80. 	</tr>
  81.       </table>
  82.     </div>
  83.  
  84.     Returns the name of 'your' file in the merge. This is typically
  85.     a path to a file in the workspace.
  86.  
  87.     <pre>
  88. 	p4.run_resolve() do
  89. 	    |md|
  90. 	    yours = md.your_name
  91. 	    md.merge_hint
  92. 	end
  93.     </pre>
  94.   </div>
  95.  
  96.   <a name="their_name"></a>
  97.   <div class="method">
  98.     <div class="methodheader">
  99.       <table>
  100. 	<tr>
  101. 	  <td class="meth_name">their_name</td>
  102. 	  <td class="proto">
  103. 	    <i>md</i>.their_name() -&gt; <i>aString</i>
  104. 	  </td>
  105. 	</tr>
  106.       </table>
  107.     </div>
  108.  
  109.     Returns the name of 'their' file in the merge. This is typically
  110.     a path to a file in the depot.
  111.  
  112.     <pre>
  113. 	p4.run_resolve() do
  114. 	    |md|
  115. 	    theirs = md.their_name
  116. 	    md.merge_hint
  117. 	end
  118.     </pre>
  119.   </div>
  120.  
  121.   <a name="base_name"></a>
  122.   <div class="method">
  123.     <div class="methodheader">
  124.       <table>
  125. 	<tr>
  126. 	  <td class="meth_name">base_name</td>
  127. 	  <td class="proto">
  128. 	    <i>md</i>.base_name() -&gt; <i>aString</i>
  129. 	  </td>
  130. 	</tr>
  131.       </table>
  132.     </div>
  133.  
  134.     Returns the name of the 'base' file in the merge. This is typically
  135.     a path to a file in the depot.
  136.  
  137.     <pre>
  138. 	p4.run_resolve() do
  139. 	    |md|
  140. 	    base = md.base_name
  141. 	    md.merge_hint
  142. 	end
  143.     </pre>
  144.   </div>
  145.  
  146.   <a name="your_path"></a>
  147.   <div class="method">
  148.     <div class="methodheader">
  149.       <table>
  150. 	<tr>
  151. 	  <td class="meth_name">your_path</td>
  152. 	  <td class="proto">
  153. 	    <i>md</i>.your_path() -&gt; <i>aString</i>
  154. 	  </td>
  155. 	</tr>
  156.       </table>
  157.     </div>
  158.  
  159.     Returns the path of 'your' file in the merge. This is typically
  160.     a path to a file in the workspace.
  161.  
  162.     <pre>
  163. 	p4.run_resolve() do
  164. 	    |md|
  165. 	    your_path = md.your_path
  166. 	    md.merge_hint
  167. 	end
  168.     </pre>
  169.   </div>
  170.  
  171.   <a name="their_path"></a>
  172.   <div class="method">
  173.     <div class="methodheader">
  174.       <table>
  175. 	<tr>
  176. 	  <td class="meth_name">their_path</td>
  177. 	  <td class="proto">
  178. 	    <i>md</i>.their_path() -&gt; <i>aString</i>
  179. 	  </td>
  180. 	</tr>
  181.       </table>
  182.     </div>
  183.  
  184.     Returns the path of 'their' file in the merge. This is typically
  185.     a path to a temporary file on your local machine in which the contents
  186.     of <a href="#their_name">their_name()</a> have been loaded.
  187.  
  188.     <pre>
  189. 	p4.run_resolve() do
  190. 	    |md|
  191. 	    their_name = md.their_name
  192. 	    their_file = File.open( md.their_path )
  193. 	    md.merge_hint
  194. 	end
  195.     </pre>
  196.   </div>
  197.  
  198.   <a name="base_path"></a>
  199.   <div class="method">
  200.     <div class="methodheader">
  201.       <table>
  202. 	<tr>
  203. 	  <td class="meth_name">base_path</td>
  204. 	  <td class="proto">
  205. 	    <i>md</i>.base_path() -&gt; <i>aString</i>
  206. 	  </td>
  207. 	</tr>
  208.       </table>
  209.     </div>
  210.  
  211.     Returns the path of the base file in the merge. This is typically
  212.     a path to a temporary file on your local machine in which the contents
  213.     of <a href="#base_name">base_name()</a> have been loaded.
  214.  
  215.     <pre>
  216. 	p4.run_resolve() do
  217. 	    |md|
  218. 	    base_name = md.base_name
  219. 	    base_file = File.open( md.base_path )
  220. 	    md.merge_hint
  221. 	end
  222.     </pre>
  223.   </div>
  224.  
  225.   <a name="result_path"></a>
  226.   <div class="method">
  227.     <div class="methodheader">
  228.       <table>
  229. 	<tr>
  230. 	  <td class="meth_name">result_path</td>
  231. 	  <td class="proto">
  232. 	    <i>md</i>.result_path() -&gt; <i>aString</i>
  233. 	  </td>
  234. 	</tr>
  235.       </table>
  236.     </div>
  237.  
  238.     Returns the path to the merge result. This is typically a path to a 
  239.     temporary file on your local machine in which the contents
  240.     of the automatic merge performed by the server have been loaded.
  241.  
  242.     <pre>
  243. 	p4.run_resolve() do
  244. 	    |md|
  245. 	    result_file = File.open( md.result_path )
  246. 	    md.merge_hint
  247. 	end
  248.     </pre>
  249.   </div>
  250.  
  251.   <a name="merge_hint"></a>
  252.   <div class="method">
  253.     <div class="methodheader">
  254.       <table>
  255. 	<tr>
  256. 	  <td class="meth_name">merge_hint</td>
  257. 	  <td class="proto">
  258. 	    <i>md</i>.merge_hint() -&gt; <i>aString</i>
  259. 	  </td>
  260. 	</tr>
  261.       </table>
  262.     </div>
  263.  
  264.     Returns the hint from the server as to how it thinks you
  265.     might best resolve this merge.
  266.  
  267.     <pre>
  268. 	p4.run_resolve() do
  269. 	    |md|
  270. 	    md.merge_hint
  271. 	end
  272.     </pre>
  273.   </div>
  274.  
  275.   <a name="run_merge"></a>
  276.   <div class="method">
  277.     <div class="methodheader">
  278.       <table>
  279. 	<tr>
  280. 	  <td class="meth_name">run_merge</td>
  281. 	  <td class="proto">
  282. 	    <i>md</i>.run_merge() -&gt; <i>aBoolean</i>
  283. 	  </td>
  284. 	</tr>
  285.       </table>
  286.     </div>
  287.  
  288.     If the environment variable P4MERGE is defined, run_merge() 
  289.     invokes the specified program and returns a boolean based on 
  290.     the return value of that program.
  291.  
  292.     <pre>
  293. 	p4.run_resolve() do
  294. 	    |md|
  295. 	    if ( ENV.has_key?( "P4MERGE" ) &amp;&amp; md.run_merge() )
  296. 		"am"
  297. 	    else
  298. 		"s"
  299. 	    end
  300. 	end
  301.     </pre>
  302.   </div>
  303.  
  304.   <h3>See Also</h3>
  305.  
  306.   <div class="seealso">
  307.     <a href="P4.html">P4</a>
  308.   </div>
  309.  
  310. </body>
  311. </html>
  312.   
  313.  
  314.  
# Change User Description Committed
#1 5791 Tony Smith Add experimental support for passing a block to P4#run_resolve.
The
block is passed a P...4::MergeData object encapsulating the context of
each merge performed. The block should evaluate to a string indicating
the desired result of the merge: 'ay', 'at', 'am', 's', etc. The
P4::MergeData object contains information about the files involved
in the merge and can invoke an external merge tool.

This is still experimental at this stage so the interface may
change as it evolves. «		 18 years ago