Helix SwarmHelix Swarm

cvs.html

  • //
  • guest/
  • dimitry_andric/
  • revml/
  • main/
  • docs/
  • html/
  • VCP/
  • Source/
  • cvs.html #1
  • View
  • Commits
  • Open Download .zip Download (9 KB) 
  1. <html><head><title>VCP::Source::cvs - A CVS repository source</title></head><body><h1><a name="NAME">NAME
  2.  
  3. </a></h1><p>VCP::Source::cvs - A CVS repository source
  4.  
  5. <p><hr><h1><a name="SYNOPSIS">SYNOPSIS
  6.  
  7. </a></h1><pre>   vcp cvs:module/... -d &quot;&gt;=2000-11-18 5:26:30&quot; &lt;dest&gt;
  8.                                   # All file revs newer than a date/time
  9.  
  10. </pre><pre>   vcp cvs:module/... -r foo      # all files in module and below labelled foo
  11.    vcp cvs:module/... -r foo:     # All revs of files labelled foo and newer,
  12.                                   # including files not tagged with foo.
  13.    vcp cvs:module/... -r 1.1:1.10 # revs 1.1..1.10
  14.    vcp cvs:module/... -r 1.1:     # revs 1.1 and up on main trunk
  15.  
  16. </pre><pre>   ## NOTE: Unlike cvs, vcp requires spaces after option letters.
  17.  
  18. </pre><p><hr><h1><a name="DESCRIPTION">DESCRIPTION
  19.  
  20. </a></h1><p>Source driver enabling <a href="../../vcp.html">vcp</a> to extract versions form a cvs
  21. repository.
  22.  
  23. <p>The source specification for CVS looks like:
  24.  
  25. <pre>    cvs:cvsroot/filespec [&lt;options&gt;]
  26.  
  27. </pre><p>where the <code>cvsroot</code> is passed to <code>cvs</code> with the <code>-d</code> option if
  28. provided (<code>cvsroot</code> is optional if the environment variable <code>CVSROOT</code>
  29. is set) and the filespec and &lt;options&gt; determine what revisions
  30. to extract.
  31.  
  32. <p><code>filespec</code> may contain trailing wildcards, like <code>/a/b/...</code> to extract
  33. an entire directory tree.
  34.  
  35. <p>If the CVSROOT / -d option looks like a local filesystem (if it doesn't
  36. start with &quot;:&quot; and if it points to an existing directory or file), this
  37. module will read the RCS files directly from the hard drive unless
  38. --use-cvs is passed.  This is more accurate (due to poor design of
  39. the cvs log command) and much, much faster.
  40.  
  41. <p><hr><h1><a name="OPTIONS">OPTIONS
  42.  
  43. </a></h1><dl><dt><a name="_b_bootstrap_"><strong><p>-b, --bootstrap
  44.  
  45. </strong></a><pre>   -b ...
  46.    --bootstrap=...
  47.    -b file1[,file2[, etc.]]
  48.    --bootstrap=file1[,file2[, etc. ]]
  49.  
  50. </pre><dd>(the <code>...</code> there is three periods, a
  51. <a>Regexp::Shellish</a> wildcard borrowed from <code>p4</code>
  52. path syntax).
  53.  
  54. <p>Forces bootstrap mode for an entire export (<code>-b ...</code>) or for certain
  55. files.  Filenames may contain wildcards, see <a>Regexp::Shellish</a> for
  56. details on what wildcards are accepted.
  57.  
  58. <p>Controls how the first revision of a file is exported.  A bootstrap
  59. export contains the entire contents of the first revision in the
  60. revision range.  This should only be necessary when exporting for the
  61. first time.
  62.  
  63. <p>An incremental export contains a digest of the revision preceding the
  64. first revision in the revision range, followed by a delta record between
  65. that revision and the first revision in the range.  This allows the
  66. destination import function to make sure that the incremental export
  67. begins where the last export left off.
  68.  
  69. <p>The default is decided on a per-file basis: if the first revision in the
  70. range is revision #.1, the full contents are exported.  Otherwise an
  71. incremental export is done for that file.
  72.  
  73. <p>This option is necessary when exporting only more recent revisions from
  74. a repository.
  75.  
  76. <dt><a name="_cd_"><strong><p>--cd
  77.  
  78. </strong></a><dd>Used to set the CVS working directory.  VCP::Source::cvs will cd to this
  79. directory before calling cvs, and won't initialize a CVS workspace of
  80. it's own (normally, VCP::Source::cvs does a &quot;cvs checkout&quot; in a
  81. temporary directory).
  82.  
  83. <p>This is an advanced option that allows you to use a CVS workspace you
  84. establish instead of letting vcp create one in a temporary directory
  85. somewhere.  This is useful if you want to read from a CVS branch or if
  86. you want to delete some files or subdirectories in the workspace.
  87.  
  88. <p>If this option is a relative directory, then it is treated as relative
  89. to the current directory.
  90.  
  91. <dt><a name="_kb_k_b_"><strong><p>-kb, -k b
  92.  
  93. </strong></a><dd>Pass the -kb option to cvs, forces a binary checkout.  This is
  94. useful when you want a text file to be checked out with Unix linends,
  95. or if you know that some files in the repository are not flagged as
  96. binary files and should be.
  97.  
  98. <dt><a name="_rev_root_"><strong><p>--rev-root
  99.  
  100. </strong></a><dd><b>Experimental</b>.
  101.  
  102. <p>Falsifies the root of the source tree being extracted; files will
  103. appear to have been extracted from some place else in the hierarchy.
  104. This can be useful when exporting RevML, the RevML file can be made
  105. to insert the files in to a different place in the eventual destination
  106. repository than they existed in the source repository.
  107.  
  108. <p>The default <code>rev-root</code> is the file spec up to the first path segment
  109. (directory name) containing a wildcard, so
  110.  
  111. <pre>   cvs:/a/b/c...
  112.  
  113. </pre><p>would have a rev-root of <code>/a/b</code>.
  114.  
  115. <p>In direct repository-to-repository transfers, this option should not be
  116. necessary, the destination filespec overrides it.
  117.  
  118. <dt><a name="_r_"><strong><p>-r
  119.  
  120. </strong></a><pre>   -r v_0_001:v_0_002
  121.    -r v_0_002:
  122.  
  123. </pre><dd>Passed to <code>cvs log</code> as a <code>-r</code> revision specification. This corresponds
  124. to the <code>-r</code> option for the rlog command, not either of the <code>-r</code>
  125. options for the cvs command. Yes, it's confusing, but 'cvs log' calls
  126. 'rlog' and passes the options through.
  127.  
  128. <p>IMPORTANT: When using tags to specify CVS file revisions, it would ordinarily
  129. be the case that a number of unwanted revisions would be selected.  This is
  130. because the behavior of the cvs log command dumps the entire log history for
  131. any files that do not contain the tag. VCP captures the histories of such files
  132. and ignores all revisions that are older or newer than any files that match the
  133. tags.
  134.  
  135. <p>Be cautious using HEAD as the end of a revision range, this seems to cause the
  136. delete actions for files deleted in the last revision to not be noticed. Not
  137. sure why.
  138.  
  139. <dt><a name="_use_cvs_"><strong><p>--use-cvs
  140.  
  141. </strong></a><dd>Do not try to read local repositories directly; use the cvs command
  142. line interface.  This is much slower than reading the files directly
  143. but is useful to see if there is a bug in the RCS file parser or
  144. possible when dealing with corrupt RCS files that cvs will read.
  145.  
  146. <p>If you find that this option makes something work, then there is a
  147. discrepancy between the code that reads the RCS files directly (in the
  148. absence of this option) and cvs itself.  Please let me know
  149. (barrie@slaysys.com).  Thanks.
  150.  
  151. <dt><a name="_d"><strong><p><code>-d</code>
  152.  
  153. </strong></a><pre>   -d &quot;2000-11-18 5:26:30&lt;=&quot;
  154.  
  155. </pre><dd>Passed to 'cvs log' as a <code>-d</code> date specification. 
  156.  
  157. <p>WARNING: if this string doesn't contain a '&gt;' or '&lt;', you're probably doing
  158. something wrong, since you're not specifying a range.  vcp may warn about this
  159. in the future.
  160.  
  161. </dl><h2><a name="Files_that_aren_t_tagged">Files that aren't tagged
  162.  
  163. </a></h2><p>CVS has one peculiarity that this driver works around.
  164.  
  165. <p>If a file does not contain the tag(s) used to select the source files,
  166. <code>cvs log</code> outputs the entire life history of that file.  We don't want
  167. to capture the entire history of such files, so <a href="cvs.html">VCP::Source::cvs</a> goes
  168. ignores any revisions before and after the oldest and newest tagged file
  169. in the range.
  170.  
  171. <p><hr><h1><a name="LIMITATIONS">LIMITATIONS
  172.  
  173. </a></h1><pre>   &quot;What we have here is a failure to communicate!&quot;
  174.        - The warden in Cool Hand Luke
  175.  
  176. </pre><p>CVS does not try to protect itself from people checking in things that look
  177. like snippets of CVS log file: they come out exactly like they went in,
  178. confusing the log file parser.  So, if a repository contains messages in the
  179. log file that look like the output from some other &quot;cvs log&quot; command, things
  180. will likely go awry.
  181.  
  182. <p>CVS stores the -k keyword expansion setting per file, not per revision,
  183. so vcp will mark all revisions of a file with the current setting of
  184. the -k flag for a file.
  185.  
  186. <p>At least one cvs repository out there has multiple revisions of a single file
  187. with the same rev number.  The second and later revisions with the same rev
  188. number are ignored with a warning like &quot;Can't add same revision twice:...&quot;.
  189.  
  190. <p><hr><h1><a name="SEE_ALSO">SEE ALSO
  191.  
  192. </a></h1><p><a href="../Dest/cvs.html">VCP::Dest::cvs</a>, <a href="../../vcp.html">vcp</a>, <a href="../Process.html">VCP::Process</a>.
  193.  
  194. <p><hr><h1><a name="AUTHOR">AUTHOR
  195.  
  196. </a></h1><p>Barrie Slaymaker &lt;barries@slaysys.com&gt;
  197.  
  198. <p><hr><h1><a name="COPYRIGHT">COPYRIGHT
  199.  
  200. </a></h1><p>Copyright (c) 2000, 2001, 2002 Perforce Software, Inc.
  201. All rights reserved.
  202.  
  203. <p>See <a href="../License.html">VCP::License</a> (<code>vcp help license</code>) for the terms of use.
  204.  
  205. <p><hr><i><font size="-1">Last updated: Fri Nov  8 13:07:23 2002</font></i></body></html>
# Change User Description Committed
#1 6118 Dimitry Andric Integ from //public/revml to //guest/dimitry_andric/revml/main. 17 years ago
//guest/perforce_software/revml/docs/html/VCP/Source/cvs.html
#2 2307 Barrie Slaymaker get VCP::Filter::map working, update docs 22 years ago
#1 1993 Barrie Slaymaker Check in HTML documentation 23 years ago