also add -fwrapv to CFLAGS (addresses #698908)
[alioth/cvs.git] / 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
24 Welcome to CVS!
25
26 If you have problems or think you have found a bug in CVS, see the
27 section BUGS in the CVS manual (also known as Version Management with
28 CVS by Per Cederqvist et al, or cvs.texinfo--see below for details).
29
30 If you are thinking of submitting changes to CVS, see the
31 file HACKING.
32
33 Please consult the INSTALL-CVS file for information on tested
34 configurations.  If you have a comment about an already tested
35 configuration, or have tried CVS on a new configuration, please let us
36 know as described in INSTALL-CVS.  Free software only works if we all help
37 out.
38
39 Finally, we cannot guarantee that this release will not completely wipe out
40 all of your work from your system.  We do some simple testing before each
41 release, but you are completely on your own.  We recommend testing this
42 release on a source repository that is not critical to your work.  THIS
43 SOFTWARE IS SUPPLIED COMPLETELY "AS IS".  NO WARRANTY....
44
45 Thanks for your support!
46
47         -The CVS Team
48
49 -------------------------------------------------------------------------------
50
51 What Is CVS?
52
53 CVS is a version control system, which allows you to keep old versions
54 of files (usually source code), keep a log of who, when, and why
55 changes occurred, etc., like RCS or SCCS.  It handles multiple
56 developers, multiple directories, triggers to enable/log/control
57 various operations, and can work over a wide area network.  The
58 following tasks are not included; they can be done in conjunction with
59 CVS but will tend to require some script-writing and software other
60 than CVS: bug-tracking, build management (that is, make and make-like
61 tools), and automated testing.
62
63 And a whole lot more.  See the manual for more information.
64
65 -------------------------------------------------------------------------------
66
67 Notes to people upgrading from a previous release of CVS:
68
69 See the NEWS file for a description of features new in this version.
70
71 See the Compatibility section of the manual for information on
72 compatibility between CVS versions.  The quick summary is that as long
73 as you not using the optional watch features, there are no
74 compatibility problems with CVS 1.5 or later.
75
76 -------------------------------------------------------------------------------
77
78 Installation:
79
80 Please read the INSTALL-CVS file for installation instructions.  The brief
81 summary 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
89 The documentation is in the doc subdirectory.  cvs.texinfo is the main
90 manual; cvs.info* and cvs.ps are the info and postscript versions,
91 respectively, generated from cvs.texinfo.  The postscript version is
92 for 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
94 will print better on A4 paper than the other way around. If you want a
95 version formatted for A4, add the line @afourpaper near the start of
96 cvs.texinfo and re-generate cvs.ps using TeX.
97
98 -------------------------------------------------------------------------------
99
100 * How do I get up-to-date information and information about other
101 versions of CVS?
102
103 See also 
104         http://cvs.nongnu.org
105         http://www.cvsnt.org
106
107 Anyone 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
120 To subscribe to any of these lists, send mail to <list>-request@nongnu.org
121 or visit http://savannah.nongnu.org/mail/?group=cvs and follow the instructions
122 for the list you wish to subscribe to.
123
124 The newsgroup for CVS (and other configuration management systems) is
125 comp.software.config-mgmt.  The gnu.cvs.help newsgroup is a 2-way mirror
126 of the info-cvs@nongnu.org mailing list and gnu.cvs.bug is similarly a 2-way
127 mirror of bug-cvs@nongnu.org.
128
129 -------------------------------------------------------------------------------
130
131 Credits:  See the AUTHORS file.