Helix SwarmHelix Swarm

stream.html

  • //
  • guest/
  • nrkruk/
  • p4eclipse/
  • 2015-1/
  • doc/
  • topics/
  • stream.html #1
  • View
  • Commits
  • Open Download .zip Download (8 KB) 
  1. <!DOCTYPE html public "-//w3c//dtd html 3.2 final//en">
  2. <html>
  3. <head>
  4.   <title>Using Streams</title>
  5.   <meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
  6.   <link rel="stylesheet" type="text/css" href="perforcehelp.css">
  7. </head>
  8.  
  9. <body>
  10. <h1>Work with Streams</h1>
  11.  
  12. <p>Streams provide an alternate approach to maintaining codelines.
  13. <p>Starting with release <strong>2012.1</strong>, P4Eclipse 
  14. provides the following support for streams:</p>
  15. <ul>
  16.   <li>Creating a Stream Spec</li>
  17.   <li>Populating a Stream</li>
  18.   <li>Viewing Stream Hierarchy</li>
  19.   <li>Creating a Stream Client</li>
  20.   <li>Copying and Merging Changes between Streams</li>
  21. </ul>
  22.  
  23. <p>If your organization uses streams, you will see streams depots in the
  24. <strong>P4 Connections</strong> view. Streams depots are marked with the <img
  25. src="../images/stream_depot_icon.png" alt="Stream Depot" width="" height="">
  26. icon. A hierarchical view of the streams and their relationships to each other
  27. is displayed in the <b>P4 Streams</b> view, along with each stream's name,
  28. root, parent, owner, type, and description. If P4V (the Perforce Visual Client
  29. executable) is available, you can also obtain the P4V Streams Graph by clicking
  30. the <strong>Streams Graph</strong> icon <img src="../images/stream_graph.png"
  31. alt="Streams graph icon"/> in the <strong>P4 Streams</strong> view. </p>
  32.  
  33. <table border="0">
  34.   <tr>
  35.     <td><img alt="streams view in perforce perspective"
  36. src="../images/perforce_perspective_stream.png"></td>
  37.     <td><img alt="streams view in perforce perspective"
  38. src="../images/perforce_perspective_stream.png"></td>
  39.   </tr>
  40. </table>
  41.  
  42. <p></p>
  43.  
  44. <h2>Create a Stream Spec</h2>
  45.  
  46. <p>From the <strong>P4 Streams</strong> view (or the 
  47. <strong>Create New Stream from...</strong> context
  48. menu item), click the <strong>Create a New Stream</strong>
  49. button <img src="../images/addbranch.png"/>.  The <strong>New
  50. Stream</strong> wizard will pop up.  To create a new Stream spec,
  51. follow the wizard's prompts and click <strong>Finish</strong>.
  52. Click <strong>Refresh</strong> button<img src="../images/refresh.png"/> on
  53. the view toolbar to refresh the view and display the new stream.</p>
  54.  
  55. <h2>Populate a Stream</h2>
  56.  
  57. <p>A stream spec defines a path in the stream depot. If the path does not
  58. exist, you need to populate the stream with content.</p>
  59. <p>To populate a stream:</p>
  60. <p>You can check the <strong>Branch files from parent on stream creation</strong> button in the <strong>New Stream</strong> wizard.</p>
  61. <p>Alternatively, you can:</p>
  62. <ul>
  63.   <li>Create a new connection in the <strong>P4 Connections</strong>
  64.     view and set your Perforce workspace's <strong>Stream</strong>  
  65.     value to the stream you want to populate.</li>
  66.   <li>In the <strong>P4 Stream</strong> view, select the stream and 
  67.     choose <strong>Merge to Stream</strong>.</li>
  68.   <li>Select the parent stream as the source, select <strong>Merge</strong>, 
  69.     Resolve any files (accepting the source), and then submit the 
  70.     changelist.</li> 
  71. </ul>
  72. <p>If you are familiar with P4V, you can also:</p>
  73. <ul>
  74.   <li>Invoke the P4V graph view 
  75.    <img src="../images/stream_graph.png" alt="Streams graph icon"/> 
  76.    to populate the stream from the <strong>P4 Streams</strong> view. </li>
  77.   <li><strong>Note:</strong> in order to enable context menu functionality in 
  78.     the stream graph, you will need to select the P4V Preference named
  79.     <strong>Use the same workspace, and switch it between streams.</strong>
  80.     (You can set this preference in the Streams page of P4V Preferences.)</li>
  81.   <li>Use the context menu in the P4V Graph View as you would otherwise
  82.     use it from within P4V.</li>
  83. </ul>
  84.  
  85. <h2>Delete a Stream</h2>
  86.  
  87. <p>You can delete a stream if it has not children. To delete: select a 
  88. stream from <strong>P4 Streams</strong> view and choose <strong>Delete 
  89. Stream</strong> from context menu.</p>
  90.  
  91. <h2>View Stream hierarchy</h2>
  92. The <strong>P4 Streams</strong> view can show streams either as a tree 
  93. <img src="../images/tree_layout.png"/>
  94. or list <img src="../images/flat_layout.png"/>.  If you have P4V 
  95. configured in the preferences page, the P4V Stream Graph view can 
  96. also be invoked from the <strong>P4 Streams</strong> 
  97. view toolbar <img src="../images/stream_graph.png" alt="Streams graph view">.
  98.  
  99. <h2>Create a Stream Client</h2>
  100. <p>To work with a stream depot, a stream client is needed. To create a stream
  101. client, select a connection from the <strong>P4 Connections</strong> view, 
  102. select <strong>Edit Perforce Workspace...</strong> from the context 
  103. menu, set the <strong>Stream</strong> field (and optionally, specify the 
  104. <strong>AtChange</strong> field), and save the spec.</p>
  105.  
  106. <p><img src="../images/stream_client.png" alt="Streams client dialog"></p>
  107.  
  108. <h3>Work in a Stream</h3>
  109. <p>Alternatively, you can select the context menu <strong>Work in this Stream...</strong> 
  110. of the <strong>P4 Streams</strong> View, P4Eclipse will prompt you to either
  111. update the current Perforce client to associate with selected stream, or create
  112. a new client to associate with the selected stream, based on the preference. 
  113. The default behavior is to update the current client to associate with the 
  114. selected stream.</p>
  115. <p>Once you select the stream client, P4Eclipse will automatically switch the 
  116. Perforce workspace and synchronize the existing projects to the latest revision.</p>
  117.  
  118. <h2>Copy and Merge Changes between Streams</h2>
  119. <hr>
  120.  
  121. <p>Consider the following set of streams:</p>
  122.  
  123. <p><img src="../images/stream_graph.jpg" alt="Streams graph view"></p>
  124.  
  125. <p>After fixing a bug or implementing a new feature in a 
  126. development stream, you may want to copy up your changes 
  127. to the main stream. Or you may want to merge down the 
  128. changes from the main stream to the development stream.</p>
  129. <p>Prior to the 2012.3 release, you needed to manually switch to target streams.
  130. Since the 2012.3 release, the support for automatically
  131. switching between streams was added and working with multiple streams is much easier.
  132. </p>
  133.  
  134. <h3>Auto-switch streams</h3>
  135. <p>When you invoke the <b>Copy to Stream...</b> and <b>Merge to Stream...</b> actions, 
  136. P4Eclipse will automatically switch to the target stream if necessary.</p>
  137.  
  138. <h4>To copy changes from the development stream to the main stream:</h4>
  139.  
  140. <ul>
  141.   <li>Open P4 Streams view, and select the main stream, context-click
  142.   <b>Copy to Stream...</b>, if you are currently in dev stream, P4Eclipse
  143.   will automatically switch to the main stream, and synchronize the resources.</li>
  144.   <li>You can then follow the prompts from the <strong>Copy to Stream</strong> wizard, 
  145.     and click <strong>Copy</strong> to finish. </li>
  146.   <li>Resolve the pending changelist and submit the change.</li>
  147. </ul>
  148.  
  149. <h4>To merge changes from the main stream to the development stream:</h4>
  150.  
  151. <ul>
  152.   <li>Open P4 Streams view, and select the dev stream, context-click
  153.   <b>Merge to Stream...</b>, if you are currently in main stream, P4Eclipse
  154.   will automatically switch to the dev stream, and synchronize the resources.</li>
  155.   <li>You can then follow the prompts from the <strong>Merge to Stream</strong> wizard, 
  156.     and click <strong>Merge</strong> to finish. </li>
  157.   <li>Resolve the pending changelist and submit the change.</li>
  158. </ul>
  159.  
  160. <h2>Work with Task Stream</h2>
  161. <p>Task stream provide a light way to branch streams. Usually you work with task stream for
  162. a minor bug fix or a small feature development.</p>
  163.  
  164. <p>P4 Eclipse provide following support for task stream, and most of them are available from the <strong>P4 Streams</strong> view:</p>
  165.  
  166. <ul>
  167. 	<li>Create a task stream</li>
  168. 	<li>Populate a task stream
  169. 		<ul>
  170. 			<li>From parent stream</li>
  171. 			<li>From a depot</li>
  172. 		</ul>
  173. 	</li>
  174. 	<li>Work in a task stream</li>
  175. 	<li>Delete a task stream</li>
  176. 	<li>Unload/reload a task stream</li>
  177. 	<li>Re-parent a task stream</li>
  178. </ul>
  179.  
  180. <h3>Task Stream Workflow</h3>
  181. <p>The following workflow is suggested but not required:</p>
  182. <ul>
  183. 	<li>Create a task stream relate to a task (feature or bug)</li>
  184. 	<li>Checkout files in task stream</li>
  185. 	<li>Modify the files in the task stream</li>
  186. 	<li>Submit files to task stream</li>
  187. 	<li>Copy changes up to parent</li>
  188. 	<li>Unload or delete task stream</li>
  189. </ul>
  190. <hr>
  191.  
  192. <p><img src="../images/perforcelogo.png"
  193. alt="Copyright Perforce Software 2003-2012. All Rights Reserved."> </p>
  194. </body>
  195. </html>
# Change User Description Committed
#1 16816 nrkruk "Forking branch 2015-1 of perforce-software-p4eclipse to nrkruk-p4eclipse." 9 years ago
//guest/perforce_software/p4eclipse/2015-1/doc/topics/stream.html
#1 16761 Matt Attaway Post 2015.1 source code for P4Eclipse 9 years ago