CVS Kit

		Copyright (c) 1993-1994 Brian Berliner
	   Copyright (c) 1992 Brian Berliner and Jeff Polk
	       Copyright (c) 1989-1992, Brian Berliner
			 All Rights Reserved

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 1, or (at your option)
    any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

-------------------------------------------------------------------------------

Welcome to CVS!

If you have problems or think you have found a bug in CVS, see the
section BUGS in the CVS manual (also known as Version Management with
CVS by Per Cederqvist et al, or cvs.texinfo--see below for details).

If you are thinking of submitting changes to CVS, see the
file HACKING.

Please consult the INSTALL file for information on tested
configurations.  If you have a comment about an already tested
configuration, or have tried CVS on a new configuration, please let us
know as described in INSTALL.  Free software only works if we all help
out.

Finally, we cannot guarantee that this release will not completely wipe out
all of your work from your system.  We do some simple testing before each
release, but you are completely on your own.  We recommend testing this
release on a source repository that is not critical to your work.  THIS
SOFTWARE IS SUPPLIED COMPLETELY "AS IS".  NO WARRANTY....

Thanks for your support!

	-The CVS Team

-------------------------------------------------------------------------------

What Is CVS?

CVS is a version control system, which allows you to keep old versions
of files (usually source code), keep a log of who, when, and why
changes occurred, etc., like RCS or SCCS.  It handles multiple
developers, multiple directories, triggers to enable/log/control
various operations, and can work over a wide area network.  The
following tasks are not included; they can be done in conjunction with
CVS but will tend to require some script-writing and software other
than CVS: bug-tracking, build management (that is, make and make-like
tools), and automated testing.

And a whole lot more.  See the manual for more information.

-------------------------------------------------------------------------------

Notes to people upgrading from a previous release of CVS:

See the NEWS file for a description of features new in this version.

See the Compatibility section of the manual for information on
compatibility between CVS versions.  The quick summary is that as long
as you not using the optional watch features, there are no
compatibility problems with CVS 1.5 or later.

-------------------------------------------------------------------------------

Installation:

Please read the INSTALL file for installation instructions.  Brief summary:

	$ ./configure
	$ make
	(run the regression tests if desired)
	$ make install
	(create a repository if you don't already have one)

The documentation is in the doc subdirectory.  cvs.texinfo is the main
manual; cvs.info* and cvs.ps are the info and postscript versions,
respectively, generated from cvs.texinfo.  The postscript version is
for US letter size paper; we do this not because we consider this size
"better" than A4, but because we believe that the US letter version
will print better on A4 paper than the other way around. If you want a
version formatted for A4, add the line @afourpaper near the start of
cvs.texinfo and re-generate cvs.ps using TeX.

-------------------------------------------------------------------------------

* How do I get up-to-date information and information about other
versions of CVS?

On the web, http://www.loria.fr/~molli/cvs-index.html.

See also
	http://www.cvshome.org

The mailing list for CVS is info-cvs@gnu.org.  Send
subscription and removal requests for that list to
info-cvs-request@gnu.org.

The newsgroup for CVS (and other configuration management systems) is
comp.software.config-mgmt.  There is not yet a CVS-specific newsgroup,
but perhaps if comp.software.config-mgmt gets enough CVS discussion,
then it will be possible to create one.

-------------------------------------------------------------------------------

Credits:

The conflict-resolution algorithms and much of the administrative file
definitions of CVS were based on the original package written by Dick Grune
at Vrije Universiteit in Amsterdam <dick@cs.vu.nl>, and posted to
comp.sources.unix in the volume 6 release sometime in 1986.  This original
version was a collection of shell scripts.  I am thankful that Dick made
his work available.

Brian Berliner from Prisma, Inc. (now at Sun Microsystems, Inc.)
<berliner@sun.com> converted the original CVS shell scripts into reasonably
fast C and added many, many features to support software release control
functions.  See the manual page in the "man" directory.  A copy of the
USENIX article presented at the Winter 1990 USENIX Conference, Washington
D.C., is included in the "doc" directory.

Jeff Polk from BSDI <polk@bsdi.com> converted the CVS 1.2
sources into much more readable and maintainable C code.  He also added a
whole lot of functionality and modularity to the code in the process.
See the bottom of the NEWS file (from about 1992).

david d `zoo' zuhn <zoo@armadillo.com> contributed the working base code
for CVS 1.4 Alpha.  His work carries on from work done by K. Richard Pixley
and others at Cygnus Support.  The CVS 1.4 upgrade is due in large part to
Zoo's efforts.

David G. Grubbs <dgg@odi.com> contributed the CVS "history" and "release"
commands.  As well as the ever-so-useful "-n" option of CVS which tells CVS
to show what it would do, without actually doing it.  He also contributed
support for the .cvsignore file.

The Free Software Foundation (GNU) contributed most of the portability
framework that CVS now uses.  This can be found in the "configure" script,
the Makefile's, and basically most of the "lib" directory.

K. Richard Pixley, Cygnus Support <rich@cygnus.com> contributed many bug
fixes/enhancement as well as completing early reviews of the CVS 1.3 manual
pages.

Roland Pesch, then of Cygnus Support <roland@wrs.com> contributed
brand new cvs(1) and cvs(5) manual pages.  Thanks to him for saving us
from poor use of our language!

Paul Sander, HaL Computer Systems, Inc. <paul@hal.com> wrote and
contributed the code in lib/sighandle.c.  I added support for POSIX, BSD,
and non-POSIX/non-BSD systems.

Jim Kingdon and others at Cygnus Support <info@cygnus.com> wrote the
remote repository access code.

There have been many, many contributions not listed here.  Consult the
ChangeLog files in each directory for a more complete idea.

In addition to the above contributors, the following Beta testers
deserve special mention for their support.  This is only a partial
list; if you have helped in this way and would like to be listed, let
bug-cvs know (as described in the Cederqvist manual).

	Mark D. Baushke <mdb@cisco.com>
	Per Cederqvist <ceder@signum.se>
	J.T. Conklin <jtc@cygnus.com>
	Vince DeMarco <vdemarco@fdcsrvr.cs.mci.com>
	Paul Eggert <eggert@twinsun.com>
	Lal George <george@research.att.com>
	Dean E. Hardi <Dean.E.Hardi@ccmail.jpl.nasa.gov>
	Mike Heath <mike@pencom.com>
	Jim Kingdon <kingdon@cygnus.com>
	Bernd Leibing <bernd.leibing@rz.uni-ulm.de>
	Benedict Lofstedt <benedict@tusc.com.au>
	Dave Love <d.love@dl.ac.uk>
	Robert Lupton the Good <rhl@astro.princeton.edu>
	Tom McAliney <tom@hilco.com>
	Eberhard Mattes <mattes@azu.informatik.uni-stuttgart.de>
	Jim Meyering <meyering@comco.com>
	Thomas Mohr <mohr@lts.sel.alcatel.de>
	Thomas Nilsson <thoni@softlab.se>
	Raye Raskin <raye.raskin@lia.com>
	Harlan Stenn <harlan@landmark.com>
	Gunnar Tornblom <gunnar.tornblom@senet.abb.se>
	Greg A. Woods <woods@planix.com>

Many contributors have added code to the "contrib" directory.  See the
README file there for a list of what is available.  There is also a
contributed GNU Emacs CVS-mode in tools/pcl-cvs.

                             CVS port to VMS

DISCLAIMER: This port must be considered experimental.  Although
previous versions have been in use at one large site since about
October, 1995, and the port is believed to be quite usable, various
VMS-specific quirks are known and the port cannot be considered as
mature as the ports to, say, Windows NT or unix.  As always, future
progress of this port will depend on volunteer and customer interest.

This port is of the CVS client only.  Or in other words, the port
implements the full set of CVS commands, but cannot access
repositories located on the local machine.  The repository must live
on another machine (a Unix box) which runs a complete port of CVS.

Most (all?) work to date has been done on OpenVMS/AXP 6.2.  Other VMS
variants might work too.

Provided that both your client and your server are recent (for
example, CVS 1.9.27 or later), you shouldn't need GNU patch or any
other executables other than CVS.EXE.

Please send bug reports to bug-cvs@gnu.org.

As of CVS 1.5.something, this port passed most of the tests in
[.src]sanity.sh.  I say "most" because some tests to not apply to the
CVS client.  The tests were run by hand because the VMS POSIX shell
was incapable of running the script.  The tests that sanity.sh
provides are not conclusive but at least provides some assurance that
the client is usable.

To compile, you will need DEC C (CC), DEC UCX, and of course DCL
installed on your machine.  Just type "@build" in the top level
directory.  This will build the sources in each subdirectory, and link
the executable [.src]cvs.exe

Copy the executable to an appropriate directory, and define the symbol "CVS"
in a .COM file which everyone running CVS will need to run.  Here's an example
of what needs to be done.

$ CVS :== $YOUR_DEVICE:[YOUR.DIRECTORY.CVS]CVS.EXE

Accessing a remote repository can happen in several ways.

1. pserver
2. rsh - privileged (default)
3. rsh - unprivileged (on VMS side)

Here's how to do each of the above:

-------------------------------------------------------------------------------
1.  pserver.  This is the preferred way.  It works just as it is
documented in the CVS manual (see the README file in the CVS
distribution for more information on the manual).

-------------------------------------------------------------------------------
2. Using CVS internal rsh support (privileged)

VMS's RSH is unusable for CVS's purposes (that is, the one in UCX.
Don't know about Multinet).  However, there is code within CVS to
emulate RSH for purposes of contacting a CVS server "in the usual way"
via rshd.  Unfortunately, this requires the VMS CVS client to be
installed with OPER privilege, by your system administrator.

RSH uses privileged ports and trusted software/hosts to determine
which user on the client side is trying to connect.  Part of this
security is due to the fact that on VMS or UNIX, a non privileged
process is not permitted to bind a socket to a privileged port.

If rshd receives a connection on a non-privileged port, the connection is
immediately aborted.  Only connections arriving from a privileged port will
be authenticated and served.  The CVS client will therefore need privileges
under VMS to produce such a connection.

*** Please note that no careful examination has been done of the security
    implications of installing CVS with the OPER privilege.  If some hole
    exists, then by doing so, you will enable users who are already on
    your system to gain unauthorized privileges ***

-------------------------------------------------------------------------------
3. Using CVS internal rsh support (non-privileged)

There is a workaround, but this is one case where I think the cure is worse
than the disease.  If you patch an rshd to not care that the RSH originating
port is "non-privileged", the CVS VMS client will allow you to define the
logical CVS_RCMD_PORT to the port number where this patched rshd will be
listening.  I leave the talk of patching rshd to the gentle reader and his/her
friendly system administrator.

If I put an entry in my /etc/services file:

cvs_rcmd            4381/tcp        cvs_rcmd

And add a line to /etc/inetd.conf, then restart inetd via "kill -1"

cvs_rcmd  stream  tcp  nowait root /usr/sbin/tcpd  /usr/local/sbin/cvs_rcmd

On the VMS side, you will have to do this:

$ define CVS_RCMD_PORT 4381

Then run CVS in the "usual way".

Note that the patched rshd will need to be invoked via inetd as root, so it can
authenticate and _become_ the intended user, the same as the regular rshd.

***Please note that you will be installing a security hole by doing this.***

Please also note that this security hole is no larger than allowing a
Macintosh, PC (OS/2, NT, etc.) to have it's hostname in any .rhosts file,
as any user can create a privileged socket without authentication, under these
environments.  In fact, existing ports of CVS to these environment use this
to their advantage.

-------------------------------------------------------------------------------
Wildcard expansion is not yet implemented (i.e. CVS COMMIT *.c won't
work.)  I think that expand_wild should be calling lib$findfile
(util.c in gzip is said to provide an example), but noone has gotten
around to implementing this.

Log messages must be entered on the command line using -m or -F.  You
can use -e or define the logical EDITOR to cause CVS to try other
editors (TPU.EXE or any other editor which wants DCL command parsing
will not work) if you want to test what's available on your system.  I
haven't tested this, but if you install vi or emacs, chances are it
will probably work.  Just make sure the .EXE files are in a directory
listed in VAXC$PATH (is this a typo for DCL$PATH?  Also, will a
logical name work?).  If someone gets around to implementing it, we
should probably be using the callable editors (e.g. TPU$TPU), although
of course we also need interface(s) which are not locked into any
particular editors.

----------------------------------------

Notes regarding compiling on VAX/VMS 6.2 (not Alpha) (These are items
which hopefully will have cleaner solutions in the future, but here is
how to get around them for now):

* Need to compile lib/getdate.c with vaxc instead of decc to avoid a
compiler bugcheck.  Therefore one must add SYS$LIBRARY:VAXCRTL/LIBRARY
to the link.

* In src/ignore.c, change lstat to stat.  In vms/filesubr.c, change
"#ifdef S_ISLNK" to "#if 0".

* Ignore the warnings in vms/vmsmunch.c; the system include file
declares something as an int when it should be void *.  Not *our*
fault!

* Remove the #define's of mode_t in vms/vms.h and pid_t in vms/pwd.h.
Add "#include <sys/types.h>" in vms/pwd.h.

Credits:

Initial VMS port by Benjamin J. Lee <benjamin@cyclic.com>, Cyclic
Software, October 1, 1995 (Update March 1, 1996).