Helix SwarmHelix Swarm
Loading...

SampleApps.html

  • //
  • guest/
  • erik_purins/
  • P4.Net/
  • main/
  • doc/
  • SampleApps.html #1
  • View
  • Commits
  • Open Download .zip Download (6 KB) 
  1. <html dir="LTR">
  2. <head>
  3.     <meta http-equiv="Content-Type" content="text/html; charset=Windows-1252" />
  4.     <meta name="vs_targetSchema" content="http://schemas.microsoft.com/intellisense/ie5" />
  5.     <title>P4.Net Sample Applications</title>
  6.     <xml>
  7.     </xml>
  8.     <link rel="stylesheet" type="text/css" href="MSDN.css" />
  9. </head>
  10. <body id="bodyID" class="dtBODY">
  11.     <div id="nsbanner">
  12.         <div id="bannerrow1">
  13.             <table class="bannerparthead" cellspacing="0" id="Table1">
  14.                 <tr id="hdr">
  15.                     <td class="runninghead">
  16.                         Perforce API for the .Net CLR</td>
  17.                     <td class="product">
  18.                         <img alt="P4.Net" src="p4net.GIF" /></td>
  19.                 </tr>
  20.             </table>
  21.         </div>
  22.         <div id="TitleRow">
  23.             <h1 class="dtH1">
  24.                 Sample Applications</h1>
  25.         </div>
  26.     </div>
  27.     <div id="nstext">
  28.     <h4 class="dtH4">About the samples</h4>
  29.         <p>All of the sample applications are written in Visual Studio 2005.  If you don't have VS2005, you can
  30.         still build them with MSBuild and the .Net 2.0 SDK.</p>
  31.         <p>
  32.         <h4 class="dtH4">
  33.             Job Labeler</h4>
  34.         <p>
  35.             Job labeler is a Windows service that polls the Peforce server for new job fixes,
  36.             and creates a label representing the files fixed by a job.</p>
  37.         <p>
  38.             <b>Motivation:</b> Many shops use jobs to organize a collection of changes. For example,
  39.             if you have Perforce integrated with a defect tracking system, you will have a job
  40.             representing a defect, and there may be several changes fixed by that job. A frequent
  41.             question that comes up is, "What files were modified to fix this defect?" Since
  42.             the JobLabeler sample application creates a label representing the files fixed by
  43.             a job, this question is readily answered with "p4 files @={joblabel}".
  44.         </p>
  45.         <p>
  46.             <b>Techniques:</b> Even if you don't use jobs in this manner (or jobs at all), there are
  47.             a number of techniques that may be used in your applications.
  48.         <list>
  49.             <li>Using P4.Net from a Windows service</li>
  50.             <li>Polling the Perforce server for change.</li>
  51.             <li>Reading/Writing counters to maintain state.</li>
  52.             <li>Using parsed and unparsed output of several commands.</li>
  53.             <li>Fetching/Setting p4 settings from an app.config file.</li>
  54.         </list>
  55.         </p>
  56.         <p>
  57.             JobLabeler requires some administrative setup to run.  See the readme file for details.<p>
  58.  
  59.     <div id="Div1">
  60.         <h4 class="dtH4">
  61.             Recordset Viewer</h4>
  62.         <p>
  63.             Recordset Viewer is a Windows GUI application that helps the user visualize
  64.             the Recordset output from the commands they run.</p>
  65.         <p>
  66.             <b>Motivation:</b> When you're using P4.Net (or other P4 APIs), it can be difficult to sort
  67.             through the vast information returned from Perforce.  The RecordsetViewer graphically displays
  68.             all the key/value pairs, as well as messages, warnings, and errors.
  69.         </p>
  70.         <p>
  71.             <b>Techniques:</b> A few techniques are demonstrated:
  72.         <list>
  73.             <li>Validating a variety of Perforce connection settings.</li>
  74.             <li>A connection dialog.</li>
  75.             <li>This is the only sample in VB.Net.</li>
  76.             <li>Iterating P4RecordSet objects.</li>
  77.         </list>
  78.         </p>
  79.  
  80.  
  81.     <div id="Div2">
  82.         <h4 class="dtH4">
  83.             MSBuild Custom Tasks</h4>
  84.         <p>
  85.             P4MSBuildTasks is a .Net assembly providing custom tasks for MSBuild.</p>
  86.         <p>
  87.             <b>Motivation:</b> Integrating MSBuild with Perforce is something a lot of shops will want to do.
  88.             I imagine there will be a number of people that use these tasks, and don't even care about the 
  89.             internals of P4.Net.
  90.         </p>
  91.         <p>
  92.             <b>Usage:</b> P4MSBuildTasks works quite a bit differently than the traditional source control integration
  93.             tasks (for MSBuild, NAnt, or Ant).  The traditional approach is to have individual tasks to perform a specific
  94.             action.  For example, you might have tasks like P4Sync, P4Edit, P4Label, etc.
  95.             <p>In P4MSBuildTasks, there's one main task that executes any Perforce command.  So how's that any  better
  96.             than just executing p4.exe directly?  The key is the rich output.  The P4RunCommand task outputs an itemgroup
  97.             representing each P4Record output.  All the key/value pairs are represented as Item metadata.  As an example,
  98.             the output from p4 files would be an itemgroup similar to the following:</p>
  99.             <pre class="code" language="xml" escaped="true">
  100. &lt;ItemGroup&gt;
  101.   &lt;P4Output Include="P4Output-files-00000000"&gt;
  102.     &lt;change&gt;5427&lt;/change&gt;
  103.     &lt;rev&gt;1&lt;/rev&gt;
  104.     &lt;type&gt;text&lt;/type&gt;
  105.     &lt;depotFile&gt;//depot/file1.txt&lt;/depotFile&gt;
  106.     &lt;action&gt;add&lt;/action&gt;
  107.     &lt;time&gt;1146612676&lt;/time&gt;
  108.   &lt;/P4Output&gt;
  109.   &lt;P4Output Include="P4Output-files-00000001"&gt;
  110.     &lt;change&gt;5798&lt;/change&gt;
  111.     &lt;rev&gt;2&lt;/rev&gt;
  112.     &lt;type&gt;text&lt;/type&gt;
  113.     &lt;depotFile&gt;//depot/file2.txt&lt;/depotFile&gt;
  114.     &lt;action&gt;edit&lt;/action&gt;
  115.     &lt;time&gt;1166501810&lt;/time&gt;
  116.   &lt;/P4Output&gt;
  117. &lt;/ItemGroup&gt;</pre>
  118.             <p>Using batching and transformations, you can use this output later in the script.
  119.             For example, you can print a line 'file#revision' for each record output by batching:</p>
  120. <pre class="code" escaped="true">
  121. &lt;Message Text="%(P4Output.depotFile)#%(P4Output.rev)" /&gt;</pre>
  122.             <p>You can also use transformations to feed output of one Perforce command into the input of another.  
  123.             Check out the sample "WorkingOffline.proj".  It is well-commented, and provides a number of techniques you can use.</p>
  124.         </p>
  125.       
  126.       <hr />
  127.       <div id="footer">
  128.         <p>
  129.           <a href="Copyright.html">Copyright  2006 Shawn Hladky</a>
  130.         </p>
  131.         <p>
  132.         </p>
  133.       </div>
  134.     </div>
  135. </body>
  136. </html>
# Change User Description Committed
#1 7341 Erik Purins p4.net
---
pull p4.net#head 		16 years ago
//guest/shawn_hladky/P4.Net/main/doc/SampleApps.html
#1 5830 Shawn Hladky P4.Net: reorg to support release branches 18 years ago
//guest/shawn_hladky/P4.Net/doc/SampleApps.html
#4 5824 Shawn Hladky P4.Net: Last bits of documentation for 0.9 18 years ago
#3 5815 Shawn Hladky P4.Net: more documentation
will build strong-named assemblies now. 		18 years ago
#2 5812 Shawn Hladky P4.Net: More documentation. 18 years ago
#1 5798 Shawn Hladky P4.Net...  still not ready for beta
Added license to all files
Added several doc fi...les
Misc bugs «		 18 years ago