xref: /dragonfly/contrib/cvs-1.12/contrib/README (revision 0bb9290e)
1This "contrib" directory is a place holder for code/scripts sent to me
2by contributors around the world.  This README file will be kept
3up-to-date from release to release.  BUT, we must point out that these
4contributions are really, REALLY UNSUPPORTED.  In fact, we probably
5don't even know what some of them really do.  We certainly do not
6guarantee to have tried them, or ported them to work with this CVS
7distribution.  If you have questions, your best bet is to contact the
8original author, but you should not necessarily expect a reply, since
9the author may not be available at the address given.
10
11USE AT YOUR OWN RISK -- and all that stuff.
12
13"Unsupported" also means that no one has volunteered to accept and check
14in changes to this directory.  So submissions for new scripts to add
15here are unlikely to be accepted.  Suggested changes to the existing
16scripts here conceivably might, but that isn't clear either, unless of
17course they come from the original author of the script.
18
19If you have some software that works with CVS that you wish to offer it
20is suggested that you make it available by FTP or HTTP and then announce
21it on the info-cvs mailing list.
22
23An attempt at a table of Contents for this directory:
24
25	README		This file.
26
27 	clmerge		A perl script to handle merge conflicts in GNU
28			style ChangeLog files .
29			Contributed by Tom Tromey <tromey@busco.lanl.gov>.
30
31	cln_hist	A perl script to compress your
32			$CVSROOT/CVSROOT/history file, as it can grow quite
33			large after extended use.
34			Contributed by David G. Grubbs <dgg@ksr.com>
35
36	commit_prep	A perl script, to be combined with log_accum.pl, to
37	log_accum	provide for a way to combine the individual log
38			messages of a multi-directory "commit" into a
39			single log message, and mail the result somewhere.
40			Can also do other checks for $Id and that you are
41			committing the correct revision of the file.
42			Read the comments carefully.
43			Contributed by David Hampton <hampton@cisco.com>.
44
45	cvs2vendor	A shell script to move changes from a repository
46			that was started without a vendor branch to one
47			that has a vendor branch.
48			Contributed by Greg A. Woods <woods@planix.com>.
49
50	cvs_acls	A perl script that implements Access Control Lists
51	cvs_acls.html	by using the "commitinfo" hook provided with the
52			"cvs commit" command.
53			Contributed by David G. Grubbs <dgg@ksr.com>.
54			Enhanced by Peter Connolly <Peter.Connolly@cnet.com>.
55
56	cvshelp.man	An introductory manual page written by Lowell Skoog
57			<fluke!lowell@uunet.uu.net>.  It is most likely
58			out-of-date relative to CVS 1.3, but still may be
59			useful.
60
61	debug_check_log	A shell script to help analyze sanity check failures.
62			Contributed by Derek R. Price <derek@ximbiot.com>.
63
64	descend		A shell script that can be used to recursively
65	descend.man	descend through a directory.  In CVS 1.2, this was
66			very useful, since many of the commands were not
67			recursive.  In CVS 1.3 (and later), however, most of
68			the commands are recursive.  However, this may still
69			come in handy.
70			Contributed by Lowell Skoog <fluke!lowell@uunet.uu.net>
71
72	dirfns		A shar file which contains some code that might
73			help your system support opendir/readdir/closedir,
74			if it does not already.
75			Copied from the C-News distribution.
76
77	intro.doc	A user's view of what you need to know to get
78			started with CVS.
79			Contributed by <Steven.Pemberton@cwi.nl>.
80
81	log		A perl script suitable for including in your
82			$CVSROOT/CVSROOT/loginfo file for logging commit
83			changes.  Includes the RCS revision of the change
84			as part of the log.
85			Contributed by Kevin Samborn <samborn@sunrise.com>.
86
87	log_accum	See commit_prep.
88
89	mfpipe		Another perl script for logging.  Allows you to
90			pipe the log message to a file and/or send mail
91			to some alias.
92			Contributed by John Clyne <clyne@niwot.scd.ucar.edu>.
93
94	pvcs2rcs	A perl script to convert a PVCS tree to an RCS tree.
95
96	rcs-5.7-commitid.patch
97			Patch to RCS 5.7 sources of 1995-06-16 to support
98			the newphrase 'commitid' used by CVS and CVSNT.
99
100	rcs-5.7-sameuserlocks.patch
101			Patch to RCS 5.7 sources from 2003-10-24
102			submitted to both help-rcs@gnu.org and Redhat.
103			Included in many Redhat GNU/Linux distribution
104			RPM files. A new -S switch to the co command
105			will disallow the user to check out the same
106			file twice.
107
108	rcs-5.7-security.patch
109			Patch to RCS 5.7 sources from 2001-01-05
110			included in many GNU/Linux distributions as applied
111			by Preston Brown <pbrown@redhat.com>
112			tmpfile security patch from Olaf Kirch <okir@lst.de>.
113
114	rcs-to-cvs	Script to import sources that may have been under
115			RCS control already.
116			Contributed by Per Cederqvist <ceder@lysator.liu.se>.
117
118	rcs2log		A shell script to create a ChangeLog-format file
119			given only a set of RCS files.
120			Contributed by Paul Eggert <eggert@twinsun.com>.
121
122	rcs2sccs	A shell script to convert simple RCS files into
123			SCCS files, originally gleaned off the network
124			somewhere (originally by "kenc") and modified by
125			Jerry Jelinek <jerry@rmtc.Central.Sun.COM> and
126			Brian Berliner <berliner@sun.com> to increase
127			robustness and add support for one-level of branches.
128
129	rcslock		A perl script that can be added to your commitinfo
130			file that tries to determine if your RCS file is
131			currently locked by someone else, as might be the
132			case for a binary file.
133			Contributed by John Rouillard <rouilj@cs.umb.edu>.
134
135	sandbox_status
136	sandbox_status.man
137			Identifies files added, changed, or removed in a
138			checked out CVS tree; also notices unknown files.
139			Contributed by Lowell Skoog <fluke!lowell@uunet.uu.net>
140
141	sccs2rcs	A C-shell script that can convert (some) SCCS files
142			into RCS files, retaining the info contained in the
143			SCCS file (like dates, author, and log message).
144			Contributed by Ken Cox <kenstir@viewlogic.com>.
145
146	verify_repo	A perl script to check an entire repository for
147			corruption.
148			Contributed by Donald Sharp <sharpd@cisco.com>.
149