Loading...
Helix SwarmHelix Swarm
Loading...

Dest.html

  • //
  • guest/
  • perforce_software/
  • revml/
  • product/
  • release/
  • 0.90/
  • html/
  • VCP/
  • Dest.html #1
  • View
  • Commits
  • Open Download .zip Download (7 KB) 
  1. <html><head><title>VCP::Dest - A base class for VCP destinations</title></head><body><h1><a name="NAME">NAME
  2.  
  3. </a></h1><p>VCP::Dest - A base class for VCP destinations
  4.  
  5. <p><hr><h1><a name="SYNOPSIS">SYNOPSIS
  6.  
  7. </a></h1><p><hr><h1><a name="DESCRIPTION">DESCRIPTION
  8.  
  9. </a></h1><p><hr><h1><a name="SUBCLASSING">SUBCLASSING
  10.  
  11. </a></h1><p>This class uses the fields pragma, so you'll need to use base and 
  12. possibly fields in any subclasses.
  13.  
  14. <h2><a name="SUBCLASS_API">SUBCLASS API
  15.  
  16. </a></h2><p>These methods are intended to support subclasses.
  17.  
  18. <dl><pre>
  19. </pre><dt><a name="digest_"><strong><p>digest
  20.  
  21. </strong></a><pre>    $self-&gt;digest( &quot;/tmp/readers&quot; ) ;
  22.  
  23. </pre><dd>Returns the Base64 MD5 digest of the named file.  Used to compare a base
  24. rev (which is the revision *before* the first one we want to transfer) of
  25. a file from the source repo to the existing head rev of a dest repo.
  26.  
  27. <p>The Base64 version is returned because that's what RevML uses and we might
  28. want to cross-check with a .revml file when debugging.
  29.  
  30. <dt><a name="compare_base_revs_"><strong><p>compare_base_revs
  31.  
  32. </strong></a><pre>   $self-&gt;compare_base_revs( $rev, $work_path ) ;
  33.  
  34. </pre><dd>Checks out the indicated revision from the destination repository and
  35. compares it (using digest()) to the file from the source repository
  36. (as indicated by $work_path). Dies with an error message if the
  37. base revisions do not match.
  38.  
  39. <p>Calls $self-&gt;checkout_file( $rev ), which the subclass must implement.
  40.  
  41. <dt><a name="header_"><strong><p>header
  42.  
  43. </strong></a><dd>Gets/sets the $header data structure passed to handle_header().
  44.  
  45. <dt><a name="rev_map_"><strong><p>rev_map
  46.  
  47. </strong></a><dd>Returns a reference to the RevMapDB for this backend and repository.
  48. Creates an empty one if need be.
  49.  
  50. <dt><a name="head_revs_"><strong><p>head_revs
  51.  
  52. </strong></a><dd>Returns a reference to the HeadRevsDB for this backend and repository.
  53. Creates an empty one if need be.
  54.  
  55. <dt><a name="main_branch_id_"><strong><p>main_branch_id
  56.  
  57. </strong></a><dd>Returns a reference to the MainBranchIdDB for this backend and repository.
  58. Creates an empty one if need be.
  59.  
  60. <dt><a name="files_"><strong><p>files
  61.  
  62. </strong></a><dd>Returns a reference to the FilesDB for this backend and repository.
  63. Creates an empty one if need be.
  64.  
  65. </dl><h2><a name="SUBCLASS_OVERLOADS">SUBCLASS OVERLOADS
  66.  
  67. </a></h2><p>These methods are overloaded by subclasses.
  68.  
  69. <dl><dt><a name="backfill_"><strong><p>backfill
  70.  
  71. </strong></a><pre>   $dest-&gt;backfill( $rev ) ;
  72.  
  73. </pre><dd>Checks the file indicated by VCP::Rev $rev out of the target repository
  74. if this destination supports backfilling.  Currently, only the revml and
  75. the reporting &amp; debugging destinations do not support backfilling.
  76.  
  77. <p>The $rev-&gt;workpath must be set to the filename the backfill was put
  78. in.
  79.  
  80. <p>This is used when doing an incremental update, where the first revision of
  81. a file in the update is encoded as a delta from the prior version.  A digest
  82. of the prior version is sent along before the first version delta to
  83. verify it's presence in the database.
  84.  
  85. <p>So, the source calls backfill(), which returns TRUE on success, FALSE if the
  86. destination doesn't support backfilling, and dies if there's an error in
  87. procuring the right revision.
  88.  
  89. <p>If FALSE is returned, then the revisions will be sent through with no
  90. working path, but will have a delta record.
  91.  
  92. <p>MUST BE OVERRIDDEN.
  93.  
  94. <dt><a name="sort_filter_"><strong><p>sort_filter
  95.  
  96. </strong></a><pre>    sub sort_filter {
  97.        my $self = shift;
  98.        my @sort_keys = @_;
  99.        return () if @sort_keys &amp;&amp; $sort_keys[0] eq &quot;change_id&quot;;
  100.        require VCP::Filter::changesets;
  101.        return ( VCP::Filter::changesets-&gt;new(), );
  102.     }
  103.  
  104. </pre><dd>This is passed a sort specification string and returns any filters
  105. needed to presort data for this destination.  It may return the
  106. empty list (the default), or one or more instantiated filters.
  107.  
  108. <dt><a name="require_change_id_sort_"><strong><p>require_change_id_sort
  109.  
  110. </strong></a><dd>Destinations that care about the sort order usually want to use the
  111. changesets filter, so they can overload the sort filter like so:
  112.  
  113. <pre>   sub sort_filters { shift-&gt;require_change_id_sort( @_ ) }
  114.  
  115. </pre><dt><a name="handle_footer_"><strong><p>handle_footer
  116.  
  117. </strong></a><pre>   $dest-&gt;handle_footer( $footer ) ;
  118.  
  119. </pre><dd>Does any cleanup necessary.  Not required.  Don't call this from the override.
  120.  
  121. <dt><a name="handle_header_"><strong><p>handle_header
  122.  
  123. </strong></a><pre>   $dest-&gt;handle_header( $header ) ;
  124.  
  125. </pre><dd>Stows $header in $self-&gt;header.  This should only rarely be overridden,
  126. since the first call to handle_rev() should output any header info.
  127.  
  128. <dt><a name="rev_count_"><strong><p>rev_count
  129.  
  130. </strong></a><pre>   $dest-&gt;rev_count( $number_of_revs_forthcoming );
  131.  
  132. </pre><dd>Sent by the last aggregating plugin in the filter chain just before
  133. the first revision is sent to inform us of the number of revs to expect.
  134.  
  135. <dt><a name="skip_rev_"><strong><p>skip_rev
  136.  
  137. </strong></a><dd>Sent by filters that discard revisions in line.
  138.  
  139. <dt><a name="handle_rev_"><strong><p>handle_rev
  140.  
  141. </strong></a><pre>   $dest-&gt;handle_rev( $rev ) ;
  142.  
  143. </pre><dd>Outputs the item referred to by VCP::Rev $rev.  If this is the first call,
  144. then $self-&gt;none_seen will be TRUE and any preamble should be emitted.
  145.  
  146. <p>MUST BE OVERRIDDEN.  Don't call this from the override.
  147.  
  148. <dt><a name="last_rev_in_filebranch_"><strong><p>last_rev_in_filebranch
  149.  
  150. </strong></a><pre>   my $rev_id = $dest-&gt;last_rev_in_filebranch(
  151.       $source_repo_id,
  152.       $source_filebranch_id
  153.    );
  154.  
  155. </pre><dd>Returns the last revision for the file and branch indicated by
  156. $source_filebranch_id.  This is used to support --continue.
  157.  
  158. <p>Returns undef if not found.
  159.  
  160. </dl><pre>
  161. </pre><p><hr><h1><a name="NOTES">NOTES
  162.  
  163. </a></h1><p>Several fields are jury rigged for &quot;base revisions&quot;: these are fake
  164. revisions used to start off incremental, non-bootstrap transfers with
  165. the MD5 digest of the version that must be the last version in the
  166. target repository.  Since these are &quot;faked&quot;, they don't contain
  167. comments or timestamps, so the comment and timestamp fields are treated as
  168. &quot;&quot; and 0 by the sort routines.
  169.  
  170. <p><hr><h1><a name="COPYRIGHT">COPYRIGHT
  171.  
  172. </a></h1><p>Copyright 2000, Perforce Software, Inc.  All Rights Reserved.
  173.  
  174. <p>This module and the VCP package are licensed according to the terms given in
  175. the file LICENSE accompanying this distribution, a copy of which is included in
  176. <a href="vcp.html">vcp</a>.
  177.  
  178. <p><hr><h1><a name="AUTHOR">AUTHOR
  179.  
  180. </a></h1><p>Barrie Slaymaker &lt;barries@slaysys.com&gt;
  181.  
  182. <p><hr><i><font size="-1">Last updated: Thu Jul 15 01:02:39 2004</font></i></body></html>
# Change User Description Committed
#1 4344 alan_teague Revised productization files updating to latest perl modules and
normalizing scripts to w...ork on both linux and bsd platforms. «		 21 years ago