Helix SwarmHelix Swarm

vss.html

  • //
  • guest/
  • dimitry_andric/
  • revml/
  • branch/
  • 5088/
  • docs/
  • html/
  • VCP/
  • Source/
  • vss.html #1
  • View
  • Commits
  • Open Download .zip Download (7 KB) 
  1. <html><head><title>VCP::Source::vss - A VSS repository source</title></head><body><h1><a name="NAME">NAME
  2.  
  3. </a></h1><p>VCP::Source::vss - A VSS repository source
  4.  
  5. <p><hr><h1><a name="SYNOPSIS">SYNOPSIS
  6.  
  7. </a></h1><pre>   vcp vss:project/...
  8.  
  9. </pre><p><hr><h1><a name="DESCRIPTION">DESCRIPTION
  10.  
  11. </a></h1><p>Source driver enabling <a href="../../vcp.html">vcp</a> to extract versions form a vss
  12. repository.
  13.  
  14. <p>The source specification for VSS looks like:
  15.  
  16. <pre>    vss:filespec [&lt;options&gt;]
  17.  
  18. </pre><p><code>filespec</code> may contain trailing wildcards, like <code>/a/b/...</code> to extract
  19. an entire directory tree (this is the normal case).
  20.  
  21. <p>NOTE: This does not support incremental exports, see LIMITATIONS.
  22.  
  23. <p><hr><h1><a name="OPTIONS">OPTIONS
  24.  
  25. </a></h1><dl><dt><a name="_b_bootstrap_"><strong><p>-b, --bootstrap
  26.  
  27. </strong></a><pre>   -b ...
  28.    --bootstrap=...
  29.    -b file1[,file2[, etc.]]
  30.    --bootstrap=file1[,file2[, etc. ]]
  31.  
  32. </pre><dd>(the <code>...</code> there is three periods, a
  33. <a>Regexp::Shellish</a> wildcard borrowed from <code>p4</code>
  34. path syntax).
  35.  
  36. <p>Forces bootstrap mode for an entire export (<code>-b ...</code>) or for certain
  37. files.  Filenames may contain wildcards, see <a>Regexp::Shellish</a> for
  38. details on what wildcards are accepted.
  39.  
  40. <p>Controls how the first revision of a file is exported.  A bootstrap
  41. export contains the entire contents of the first revision in the
  42. revision range.  This should only be necessary when exporting for the
  43. first time.
  44.  
  45. <p>An incremental export contains a digest of the revision preceding the
  46. first revision in the revision range, followed by a delta record between
  47. that revision and the first revision in the range.  This allows the
  48. destination import function to make sure that the incremental export
  49. begins where the last export left off.
  50.  
  51. <p>The default is decided on a per-file basis: if the first revision in the
  52. range is revision #.1, the full contents are exported.  Otherwise an
  53. incremental export is done for that file.
  54.  
  55. <p>This option is necessary when exporting only more recent revisions from
  56. a repository.
  57.  
  58. <dt><a name="_cd_"><strong><p>--cd
  59.  
  60. </strong></a><dd>Used to set the VSS working directory.  VCP::Source::vss will cd to this
  61. directory before calling vss, and won't initialize a VSS workspace of
  62. it's own (normally, VCP::Source::vss does a &quot;vss checkout&quot; in a
  63. temporary directory).
  64.  
  65. <p>This is an advanced option that allows you to use a VSS workspace you
  66. establish instead of letting vcp create one in a temporary directory
  67. somewhere.  This is useful if you want to read from a VSS branch or if
  68. you want to delete some files or subdirectories in the workspace.
  69.  
  70. <p>If this option is a relative directory, then it is treated as relative
  71. to the current directory.
  72.  
  73. <dt><a name="_rev_root_"><strong><p>--rev-root
  74.  
  75. </strong></a><dd><b>Experimental</b>.
  76.  
  77. <p>Falsifies the root of the source tree being extracted; files will
  78. appear to have been extracted from some place else in the hierarchy.
  79. This can be useful when exporting RevML, the RevML file can be made
  80. to insert the files in to a different place in the eventual destination
  81. repository than they existed in the source repository.
  82.  
  83. <p>The default <code>rev-root</code> is the file spec up to the first path segment
  84. (directory name) containing a wildcard, so
  85.  
  86. <pre>   vss:/a/b/c...
  87.  
  88. </pre><p>would have a rev-root of <code>/a/b</code>.
  89.  
  90. <p>In direct repository-to-repository transfers, this option should not be
  91. necessary, the destination filespec overrides it.
  92.  
  93. </dl><h2><a name="Files_that_aren_t_tagged">Files that aren't tagged
  94.  
  95. </a></h2><p>VSS has one peculiarity that this driver works around.
  96.  
  97. <p>If a file does not contain the tag(s) used to select the source files,
  98. <code>vss log</code> outputs the entire life history of that file.  We don't want
  99. to capture the entire history of such files, so <a href="vss.html">VCP::Source::vss</a> goes
  100. ignores any revisions before and after the oldest and newest tagged file
  101. in the range.
  102.  
  103. <p><hr><h1><a name="LIMITATIONS">LIMITATIONS
  104.  
  105. </a></h1><pre>   &quot;What we have here is a failure to communicate!&quot;
  106.        - The warden in Cool Hand Luke
  107.  
  108. </pre><p>VSS does not try to protect itself from people checking in things that
  109. look like snippets of VSS log file: they come out exactly like they
  110. went in, confusing the log file parser.
  111.  
  112. <p>So, if a repository contains messages in the log file that look like the 
  113. output from some other &quot;vss log&quot; command, things will likely go awry.
  114.  
  115. <p>At least one vss repository out there has multiple revisions of a single file
  116. with the same rev number.  The second and later revisions with the same rev
  117. number are ignored with a warning like &quot;Can't add same revision twice:...&quot;.
  118.  
  119. <p><hr><h1><a name="VSS_NOTES">VSS NOTES
  120.  
  121. </a></h1><p>We lose comments attached to labels: labels are added to the last
  122. &quot;real&quot; (ie non-label-only) revision and the comments are ignored.
  123. This can be changed, contact me.
  124.  
  125. <p>We assume a file has always been text or binary, don't think this is
  126. stored per-version in VSS.
  127.  
  128. <p>Looks for deleted files: recovers them if found just long enough to
  129. cope with them, then deletes them again.
  130.  
  131. <p>VSS does not track renames by version, so a previous name for a file is lost.
  132.  
  133. <p>VSS lets you add a new file after deleting an old one.  This module
  134. renames the current file, restores the old one, issues its revisions,
  135. then deletes the old on and renames the current file back.  In this
  136. case, the <code>rev_id</code>s from the current file start at the highest
  137. <code>rev_id</code> for the deleted file and continue up.
  138.  
  139. <p>NOTE: when recovering a deleted file and using it, the current version
  140. takes a &quot;least opportunity to screw up the source repository&quot; approach:
  141. it renames the not-deleted version (if any), restores the deleted one,
  142. does the History or Get, and then deletes it and renames the not-deleted
  143. version back.
  144.  
  145. <p>This is so that if something (the OS, the hardware, AC mains, or even
  146. VCP code) crashes, the source repository is left as close to the
  147. original state as is possible.  This does mean that this module can
  148. issue many more commands than minimally necessary; perhaps there should
  149. be a --speed-over-safety option.
  150.  
  151. <p>No incremental export is supported.  VSS' -V~Lfoo option, which says
  152. &quot;all versions since this label&quot; does not actually cause the <code>ss.exe
  153. History</code> command to emit the indicated checkin.  We'll need to make the
  154. history command much smarter to implement that.
  155.  
  156. <p><hr><h1><a name="SEE_ALSO">SEE ALSO
  157.  
  158. </a></h1><p><a href="../Dest/vss.html">VCP::Dest::vss</a>, <a href="../../vcp.html">vcp</a>, <a href="../Process.html">VCP::Process</a>.
  159.  
  160. <p><hr><h1><a name="AUTHOR">AUTHOR
  161.  
  162. </a></h1><p>Barrie Slaymaker &lt;barries@slaysys.com&gt;
  163.  
  164. <p><hr><h1><a name="COPYRIGHT">COPYRIGHT
  165.  
  166. </a></h1><p>Copyright (c) 2000, 2001, 2002 Perforce Software, Inc.
  167. All rights reserved.
  168.  
  169. <p>See <a href="../License.html">VCP::License</a> (<code>vcp help license</code>) for the terms of use.
  170.  
  171. <p><hr><i><font size="-1">Last updated: Fri Nov  8 13:07:23 2002</font></i></body></html>
# Change User Description Committed
#1 6119 Dimitry Andric Create branch from //public/revml, changelist 5088, since I originally started making chan...ges to this version. « 17 years ago
//guest/perforce_software/revml/docs/html/VCP/Source/vss.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