README
1 CVS Kit
2
3 Copyright (C) 1986-2005 Free Software Foundation, Inc.
4
5 Portions Copyright (C) 1998-2005 Derek Price,
6 & Ximbiot <http://ximbiot.com>.
7 Portions Copyright (C) 1993-1994 Brian Berliner.
8 Portions Copyright (C) 1992 Brian Berliner and Jeff Polk.
9 Portions Copyright (C) 1989-1992 Brian Berliner.
10 All Rights Reserved
11
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 1, or (at your option)
15 any later version.
16
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
21
22-------------------------------------------------------------------------------
23
24Welcome to CVS!
25
26If you have problems or think you have found a bug in CVS, see the
27section BUGS in the CVS manual (also known as Version Management with
28CVS by Per Cederqvist et al, or cvs.texinfo--see below for details).
29
30If you are thinking of submitting changes to CVS, see the
31file HACKING.
32
33Please consult the INSTALL-CVS file for information on tested
34configurations. If you have a comment about an already tested
35configuration, or have tried CVS on a new configuration, please let us
36know as described in INSTALL-CVS. Free software only works if we all help
37out.
38
39Finally, we cannot guarantee that this release will not completely wipe out
40all of your work from your system. We do some simple testing before each
41release, but you are completely on your own. We recommend testing this
42release on a source repository that is not critical to your work. THIS
43SOFTWARE IS SUPPLIED COMPLETELY "AS IS". NO WARRANTY....
44
45Thanks for your support!
46
47 -The CVS Team
48
49-------------------------------------------------------------------------------
50
51What Is CVS?
52
53CVS is a version control system, which allows you to keep old versions
54of files (usually source code), keep a log of who, when, and why
55changes occurred, etc., like RCS or SCCS. It handles multiple
56developers, multiple directories, triggers to enable/log/control
57various operations, and can work over a wide area network. The
58following tasks are not included; they can be done in conjunction with
59CVS but will tend to require some script-writing and software other
60than CVS: bug-tracking, build management (that is, make and make-like
61tools), and automated testing.
62
63And a whole lot more. See the manual for more information.
64
65-------------------------------------------------------------------------------
66
67Notes to people upgrading from a previous release of CVS:
68
69See the NEWS file for a description of features new in this version.
70
71See the Compatibility section of the manual for information on
72compatibility between CVS versions. The quick summary is that as long
73as you not using the optional watch features, there are no
74compatibility problems with CVS 1.5 or later.
75
76-------------------------------------------------------------------------------
77
78Installation:
79
80Please read the INSTALL-CVS file for installation instructions. The brief
81summary is:
82
83 $ ./configure
84 $ make
85 (run the regression tests, if desired, via `make check')
86 $ make install
87 (create a repository if you don't already have one)
88
89The documentation is in the doc subdirectory. cvs.texinfo is the main
90manual; cvs.info* and cvs.ps are the info and postscript versions,
91respectively, generated from cvs.texinfo. The postscript version is
92for US letter size paper; we do this not because we consider this size
93"better" than A4, but because we believe that the US letter version
94will print better on A4 paper than the other way around. If you want a
95version formatted for A4, add the line @afourpaper near the start of
96cvs.texinfo and re-generate cvs.ps using TeX.
97
98-------------------------------------------------------------------------------
99
100* How do I get up-to-date information and information about other
101versions of CVS?
102
103See also
104 http://cvs.nongnu.org
105 http://www.cvsnt.org
106
107Anyone can add themselves to the following mailing lists:
108
109 bug-cvs: This is the list which users are requested to send bug reports
110 to. General CVS development and design discussions also tend to take
111 place on this list.
112 info-cvs: This list is intended for user questions, including general
113 help requests.
114 cvs-announce: CVS release announcements and other major
115 announcements about the project are sent to this list.
116 cvs-announce-binaries: Announcements are made to this list
117 when binaries for various platforms are built and initially
118 posted for download.
119
120To subscribe to any of these lists, send mail to <list>-request@nongnu.org
121or visit http://savannah.nongnu.org/mail/?group=cvs and follow the instructions
122for the list you wish to subscribe to.
123
124The newsgroup for CVS (and other configuration management systems) is
125comp.software.config-mgmt. The gnu.cvs.help newsgroup is a 2-way mirror
126of the info-cvs@nongnu.org mailing list and gnu.cvs.bug is similarly a 2-way
127mirror of bug-cvs@nongnu.org.
128
129-------------------------------------------------------------------------------
130
131Credits: See the AUTHORS file.
132
README.VMS
1 CVS port to VMS
2
3DISCLAIMER: This port must be considered experimental. Although
4previous versions have been in use at one large site since about
5October, 1995, and the port is believed to be quite usable, various
6VMS-specific quirks are known and the port cannot be considered as
7mature as the ports to, say, Windows NT or unix. As always, future
8progress of this port will depend on volunteer and customer interest.
9
10This port is of the CVS client only. Or in other words, the port
11implements the full set of CVS commands, but cannot access
12repositories located on the local machine. The repository must live
13on another machine (a Unix box) which runs a complete port of CVS.
14
15Most (all?) work to date has been done on OpenVMS/AXP 6.2. Other VMS
16variants might work too.
17
18Provided that both your client and your server are recent (for
19example, CVS 1.9.27 or later), you shouldn't need GNU patch or any
20other executables other than CVS.EXE.
21
22Please send bug reports to bug-cvs@nongnu.org.
23
24As of CVS 1.5.something, this port passed most of the tests in
25[.src]sanity.sh. I say "most" because some tests to not apply to the
26CVS client. The tests were run by hand because the VMS POSIX shell
27was incapable of running the script. The tests that sanity.sh
28provides are not conclusive but at least provides some assurance that
29the client is usable.
30
31To compile, you will need DEC C (CC), DEC UCX, and of course DCL
32installed on your machine. Just type "@build" in the top level
33directory. This will build the sources in each subdirectory, and link
34the executable [.src]cvs.exe
35
36Copy the executable to an appropriate directory, and define the symbol "CVS"
37in a .COM file which everyone running CVS will need to run. Here's an example
38of what needs to be done.
39
40$ CVS :== $YOUR_DEVICE:[YOUR.DIRECTORY.CVS]CVS.EXE
41
42Accessing a remote repository can happen in several ways.
43
441. pserver
452. rsh - privileged (default)
463. rsh - unprivileged (on VMS side)
47
48Here's how to do each of the above:
49
50-------------------------------------------------------------------------------
511. pserver. This is the preferred way. It works just as it is
52documented in the CVS manual (see the README file in the CVS
53distribution for more information on the manual).
54
55-------------------------------------------------------------------------------
562. Using CVS internal rsh support (privileged)
57
58VMS's RSH is unusable for CVS's purposes (that is, the one in UCX.
59Don't know about Multinet). However, there is code within CVS to
60emulate RSH for purposes of contacting a CVS server "in the usual way"
61via rshd. Unfortunately, this requires the VMS CVS client to be
62installed with OPER privilege, by your system administrator.
63
64RSH uses privileged ports and trusted software/hosts to determine
65which user on the client side is trying to connect. Part of this
66security is due to the fact that on VMS or UNIX, a non privileged
67process is not permitted to bind a socket to a privileged port.
68
69If rshd receives a connection on a non-privileged port, the connection is
70immediately aborted. Only connections arriving from a privileged port will
71be authenticated and served. The CVS client will therefore need privileges
72under VMS to produce such a connection.
73
74*** Please note that no careful examination has been done of the security
75 implications of installing CVS with the OPER privilege. If some hole
76 exists, then by doing so, you will enable users who are already on
77 your system to gain unauthorized privileges ***
78
79-------------------------------------------------------------------------------
803. Using CVS internal rsh support (non-privileged)
81
82There is a workaround, but this is one case where I think the cure is worse
83than the disease. If you patch an rshd to not care that the RSH originating
84port is "non-privileged", the CVS VMS client will allow you to define the
85logical CVS_RCMD_PORT to the port number where this patched rshd will be
86listening. I leave the talk of patching rshd to the gentle reader and his/her
87friendly system administrator.
88
89If I put an entry in my /etc/services file:
90
91cvs_rcmd 4381/tcp cvs_rcmd
92
93And add a line to /etc/inetd.conf, then restart inetd via "kill -1"
94
95cvs_rcmd stream tcp nowait root /usr/sbin/tcpd /usr/local/sbin/cvs_rcmd
96
97On the VMS side, you will have to do this:
98
99$ define CVS_RCMD_PORT 4381
100
101Then run CVS in the "usual way".
102
103Note that the patched rshd will need to be invoked via inetd as root, so it can
104authenticate and _become_ the intended user, the same as the regular rshd.
105
106***Please note that you will be installing a security hole by doing this.***
107
108Please also note that this security hole is no larger than allowing a
109Macintosh, PC (OS/2, NT, etc.) to have it's hostname in any .rhosts file,
110as any user can create a privileged socket without authentication, under these
111environments. In fact, existing ports of CVS to these environment use this
112to their advantage.
113
114-------------------------------------------------------------------------------
115Wildcard expansion is not yet implemented (i.e. CVS COMMIT *.c won't
116work.) I think that expand_wild should be calling lib$findfile
117(util.c in gzip is said to provide an example), but noone has gotten
118around to implementing this.
119
120Log messages must be entered on the command line using -m or -F. You
121can use -e or define the logical EDITOR to cause CVS to try other
122editors (TPU.EXE or any other editor which wants DCL command parsing
123will not work) if you want to test what's available on your system. I
124haven't tested this, but if you install vi or emacs, chances are it
125will probably work. Just make sure the .EXE files are in a directory
126listed in VAXC$PATH (is this a typo for DCL$PATH? Also, will a
127logical name work?). If someone gets around to implementing it, we
128should probably be using the callable editors (e.g. TPU$TPU), although
129of course we also need interface(s) which are not locked into any
130particular editors.
131
132----------------------------------------
133
134Notes regarding compiling on VAX/VMS 6.2 (not Alpha) (These are items
135which hopefully will have cleaner solutions in the future, but here is
136how to get around them for now):
137
138* Need to compile lib/getdate.c with vaxc instead of decc to avoid a
139compiler bugcheck. Therefore one must add SYS$LIBRARY:VAXCRTL/LIBRARY
140to the link.
141
142* In src/ignore.c, change lstat to stat. In vms/filesubr.c, change
143"#ifdef S_ISLNK" to "#if 0".
144
145* Ignore the warnings in vms/vmsmunch.c; the system include file
146declares something as an int when it should be void *. Not *our*
147fault!
148
149* Remove the #define's of mode_t in vms/vms.h and pid_t in vms/pwd.h.
150Add "#include <sys/types.h>" in vms/pwd.h.
151
152Credits:
153
154Initial VMS port by Benjamin J. Lee <benjamin@cyclic.com>, Cyclic
155Software, October 1, 1995 (Update March 1, 1996).
156