Helix SwarmHelix Swarm

README

  • //
  • guest/
  • timothee_besset/
  • README #1
  • View
  • Commits
  • Open Download .zip Download (4 KB) 
  1. README for vcp - Version CoPy
  2.  
  3. vcp (and the Perl module VCP.pm) is a system for copying resources
  4. under version control between repositories. cvs, p4 and RevML files
  5. are currently supported.
  6.  
  7. vcp can re-root directory hierarchies diring the transfer, and,
  8. using source specifications, or by filtering RevML files, subsets of
  9. files and revisions may be copied.
  10.  
  11. Both whole-repository and incremental updates are supported.
  12.  
  13.  
  14. STATUS
  15.  
  16. This code is in late alpha state.  It current supports CVS,
  17. Perforce's p4, and RevML sources and destinations.  It currently
  18. runs only on Unix-like platforms, including cygwin, due to reliance
  19. on select().  It will be ported to run on Windows platforms soon, or
  20. you can try it on a cygwin port of perl (which I have heard
  21. simulates select() rather well).
  22.  
  23. vcp is known to copy simple repositories back and forth between all
  24. sources and destinations included (CVS, p4, and RevML as I'm typing
  25. this).  It has not been deeply tested, though a moderately thorough
  26. test suite for basic operation is included.  Expect bugs, and please
  27. report them to revml@perforce.com .  Many thanks!
  28.  
  29. vcp currently only transfers straight-line revisions, pretty much on
  30. the main branch in CVS, or on any branch in p4.
  31.  
  32.  
  33. COPYRIGHT & LICENSE
  34.  
  35. Development of this utility is partially funded by Perforce.  All software so
  36. funded is Copyright 2000, Perforce Software, Inc, and licensed according to the
  37. file LICENSE distributed with this package.
  38.  
  39. Contributed portions not assigned to Perforce are Copyright to their
  40. respective creators.  Such contributed code is clearly marked and
  41. in the source code.
  42.  
  43. INSTALLATION
  44.  
  45. See the INSTALL file for details, but a normal install should be done
  46. by doing a
  47.  
  48.    $ perl -MCPAN -eshell
  49.    cpan> install VCP
  50.  
  51. .  This convinces CPAN to do all the dirty work of fetching and
  52. installing required modules for you.
  53.  
  54.  
  55. REQUIREMENTS
  56.  
  57. If you want to use the p4 I/O features, v99.2 or later is required (vcp uses
  58. the filelog -m option).  Not sure about cvs.
  59.  
  60.  
  61. THINGS TO READ
  62.  
  63. The vcp program carries it's own documentation in it.  The main program
  64. documentation can be read by doing a
  65.  
  66.    vcp help
  67.  
  68. or
  69.  
  70.    perldoc path/to/vcp
  71.  
  72. .  If you are going source spelunking, a reasonable reading list might
  73. be:
  74.  
  75.    bin/vcp
  76.    VCP
  77.    VCP::Plugin
  78.    VCP::Source
  79.    VCP::Dest
  80.    VCP::Rev
  81.    VCP::Revs
  82.    VCP::Source::*
  83.    VCP::Dest::*
  84.    revml.dtd
  85.    RevML::Doctype
  86.  
  87. You may browse the source in Perforce's online source repository
  88. starting at
  89.  
  90.    http://public.perforce.com/public/index.html
  91.  
  92. I'll update this file with better links when I get the project checked
  93. in.
  94.  
  95.  
  96. SUPPORT
  97.  
  98. 1. Please read the documentation.  It's not as good as it will be, but
  99. it'll keep you from distracting the author(s) with trivial questions
  100. when they should be working on debugging and features.
  101.  
  102. 2. Where the documentation is lacking, get us to clarify it.
  103.  
  104. 3. Send all queries, gripes, and kudos to revml@perforce.com .  Please
  105. feel free to join the list by sending a message to
  106.  
  107.    revml-subscribe@perforce.com
  108.  
  109. or by typing & clicking away at
  110.  
  111.    http://maillist.perforce.com/mailman/listinfo/revml
  112.  
  113.  
  114. CONTRIBUTING
  115.  
  116. Lots of work can be done at all levels.  We'd love to have you help!
  117.  
  118. Some areas we need help in are:
  119.  
  120. 1) Bug fixes, extensions
  121.  
  122. There are bugs to squash and minor features to add.  You'll know them
  123. when you trip over them :-).  Feel free to brainstorm on-list.
  124.  
  125. The recommended way to submit a patch is to use
  126.  
  127.    diff -Naur old_root/ new_root/
  128.    
  129. and send the patch to the list in the body of the message or as a
  130. plain text (ie non-uuencoded) attachment. PLEASE don't cut and paste
  131. patches in your GUI, that screws up whitespace and sometimes worse.
  132.  
  133. Please try to patch the most recent version in the repository, but
  134. don't feel that you have to.
  135.  
  136. 2) Drivers, drivers, drivers
  137.  
  138. We really need drivers for lots of other RCSs.  Most notable are SourceSafe,
  139. SCCS, and bitkeeper.  No drivers that are fairly functional will be
  140. turned down, though you should ask on-list if anyone's working on one
  141. so you can combine efforts if possible and avoid duplicated/wasted
  142. effort.
  143.  
  144. 3) Major features
  145.  
  146. The most major feature on the TODO list is branching.  It's still on the
  147. TODO list because it's hard to map between the various branching
  148. metaphors, or other metaphors (like bitkeeper's LODs) out there.
  149.  
  150. 4) Other uses for RevML
  151.  
  152. RevML is not just for vcp.  It's a farily generic doctype that should be
  153. useful for other things.  Feel free to find other uses for it.
  154.  
  155. Many thanks,
  156.  
  157. Barrie Slaymaker
# Change User Description Committed
#1 4040 timothee_besset guest branch 21 years ago
//guest/perforce_software/revml/README
#6 628 Barrie Slaymaker Cleaned up POD in bin/vcp, added BSD-style license. 24 years ago
#5 615 Barrie Slaymaker Detect p4d <= 99.2 and skip tests.
 Fix a use strict problem.
Both reported by... Nick Ing-Simmons. «		 24 years ago
#4 613 Barrie Slaymaker Tweak README and documentation. 24 years ago
#3 608 Barrie Slaymaker Lots of changes to get vcp to install better, now up to 0.066.
Many thanks to Matthew Att...away for testing & suggestions. «		 24 years ago
#2 468 Barrie Slaymaker - VCP::Dest::p4 now does change number aggregation based on the
  comment field chan...ging or whenever a new revision of a file with
  unsubmitted changes shows up on the input stream.  Since revisions of
  files are normally sorted in time order, this should work in a number
  of cases.  I'm sure we'll need to generalize it, perhaps with a time
  thresholding function.
- t/90cvs.t now tests cvs->p4 replication.
- VCP::Dest::p4 now doesn't try to `p4 submit` when no changes are
  pending.
- VCP::Rev now prevents the same label from being applied twice to
  a revision.  This was occuring because the "r_1"-style label that
  gets added to a target revision by VCP::Dest::p4 could duplicate
  a label "r_1" that happened to already be on a revision.
- Added t/00rev.t, the beginnings of a test suite for VCP::Rev.
- Tweaked bin/gentrevml to comment revisions with their change number
  instead of using a unique comment for every revision for non-p4
  t/test-*-in-0.revml files.  This was necessary to test cvs->p4
  functionality. «		 24 years ago
#1 467 Barrie Slaymaker Version 0.01, initial checkin in perforce public depot. 24 years ago