README
1README for vcp - Version CoPy
2
3vcp (and the Perl module VCP.pm) is a system for copying resources under
4version control between repositories. CVS, p4 and VSS repositories are
5currently supported.
6
7vcp can filter, rearrange repositories, and alter metadata during a
8transfer. These capabilities are used to handle conversion details like
9different branching models and legal character sets between various
10repositories.
11
12
13VCP Status
14----------
15
16This code is in late beta state. It current supports CVS, Perforce's
17p4, VSS and miscellaneous developer-only sources and destinations. It
18currently runs on Unix-like and Windows-like platforms.
19
20vcp is known to moderately complex repositories back and forth between
21all sources and destinations like CVS, p4, and VSS and there is a
22third-party Subversion destination driver available (we'd integrate and
23support that, but there needs to be a source driver for balance).
24Please direct all questions and issues to revml@perforce.com if
25possible, or to barries@perforce.com if privacy is required. Many
26thanks!
27
28VCP does handle branch creation, though not repeated integrations
29between files (a Perforce p4 feature).
30
31
32VSS Issues
33----------
34
35We do expect various issues with VSS source and destination repositories
36due to the, um, freedom that VSS allows its users. There are ways to
37"paint yourself in to a corner" in VSS using recommended best practices
38like sharing and pinning.
39
40VSS also has also accumulated a large base of anecdotal evidence (see
41google) having to do with corruption and we've found that much
42corruption isn't noticed until VCP is used to try to read every revision
43in a repository. For best results, run the VSS repair utilities until
44no errors are reported, upgrade to the most recent VSS and re-run the
45repair utilities for the new version (just to be sure).
46
47
48
49COPYRIGHT & LICENSE
50
51Development of this utility is partially funded by Perforce. All
52software so funded is Copyright 2004, Perforce Software, Inc, and
53licensed according to the file LICENSE distributed with this package.
54
55Contributed portions not assigned to Perforce are Copyright to their
56respective creators. Such contributed code is clearly marked and
57in the source code.
58
59
60INSTALLATION
61
62For end users, the easiest approach is to use one of the prebuilt
63releases such as "vcp.exe", "vcp-rh8", "vcp-solaris", etc.
64
65Developers should see the INSTALL file for more information.
66
67
68REQUIREMENTS
69
70If you want to use the p4 I/O features, v99.2 or later is required (vcp uses
71the filelog -m option). Not sure about cvs or VSS versions.
72
73
74THINGS TO READ
75
76The vcp program carries it's own documentation in it. The main program
77documentation can be read by doing a
78
79 vcp help
80
81or
82
83 perldoc path/to/vcp
84
85. If you are going source spelunking, a reasonable reading list might
86be:
87
88 bin/vcp
89 VCP
90 VCP::Plugin
91 VCP::Source
92 VCP::Dest
93 VCP::Rev
94 VCP::Revs
95 VCP::Source::*
96 VCP::Dest::*
97 revml.dtd
98 RevML::Doctype
99
100You may browse the source in Perforce's online source repository
101starting at
102
103 http://public.perforce.com/public/index.html
104
105I'll update this file with better links when I get the project checked
106in.
107
108
109SUPPORT
110
1111. Please read the documentation. It's not as good as it will be, but
112it'll keep you from distracting the author(s) with trivial questions
113when they should be working on debugging and features.
114
1152. Where the documentation is lacking, get us to clarify it.
116
1173. Send all queries, gripes, and kudos to revml@perforce.com . Please
118feel free to join the list by sending a message to
119
120 revml-subscribe@perforce.com
121
122or by typing & clicking away at
123
124 http://maillist.perforce.com/mailman/listinfo/revml
125
126
127CONTRIBUTING
128
129Lots of work can be done at all levels. We'd love to have you help!
130
131Some areas we need help in are:
132
1331) Bug fixes, extensions
134
135There are bugs to squash and minor features to add. You'll know them
136when you trip over them :-). Feel free to brainstorm on-list.
137
138The recommended way to submit a patch is to use
139
140 diff -Naur old_root/ new_root/
141
142and send the patch to the list in the body of the message or as a
143plain text (ie non-uuencoded) attachment. PLEASE don't cut and paste
144patches in your GUI, that screws up whitespace and sometimes worse.
145
146Please try to patch the most recent version in the repository, but
147don't feel that you have to.
148
1492) Drivers, drivers, drivers
150
151We really need drivers for lots of other RCSs. Most notable are SourceSafe,
152SCCS, and bitkeeper. No drivers that are fairly functional will be
153turned down, though you should ask on-list if anyone's working on one
154so you can combine efforts if possible and avoid duplicated/wasted
155effort.
156
1573) Major features
158
159The most major feature on the TODO list is branching. It's still on the
160TODO list because it's hard to map between the various branching
161metaphors, or other metaphors (like bitkeeper's LODs) out there.
162
1634) Other uses for RevML
164
165RevML is not just for vcp. It's a farily generic doctype that should be
166useful for other things. Feel free to find other uses for it.
167
168Many thanks,
169
170Barrie Slaymaker
171