Follow Glenn's lead and update format of Copyright.
[bpt/emacs.git] / INSTALL.CVS
1 Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
2 Free Software Foundation, Inc.
3 See the end of the file for license conditions.
4
5
6 Building and Installing Emacs from CVS
7
8 If this is the first time you go through it, you'll need to configure
9 before bootstrapping:
10
11 $ ./configure
12
13 Some of the files that are included in the Emacs tarball, such as
14 byte-compiled Lisp files, are not stored in the CVS repository.
15 Therefore, to build from CVS you must run "make bootstrap"
16 instead of just "make":
17
18 $ cvs update -dP
19 $ make bootstrap
20
21 Normally, it is not necessary to use "make bootstrap" after every CVS
22 update. "make" should work in 90% of the cases and be much quicker.
23
24 $ make
25
26 (If you want to install the Emacs binary, type "make install" instead
27 of "make" in the last command.)
28
29 Occasionally the file "lisp/loaddefs.el" (and similar automatically
30 generated files, such as esh-groups.el, and *-loaddefs.el in some
31 subdirectories of lisp/, e.g. mh-e/ and calendar/) will need to be
32 updated to reflect new autoloaded functions. If you see errors (rather
33 than warnings) about undefined lisp functions during compilation, that
34 may be the reason. Another symptom may be an error saying that
35 "loaddefs.el" could not be found; this is due to a change in the way
36 loaddefs.el was handled in CVS, and should only happen once, for users
37 that are updating old CVS trees. Finally, sometimes there can be build
38 failures related to *loaddefs.el (e.g. "required feature `esh-groups'
39 was not provided"). In that case, follow the instructions below.
40
41 To update loaddefs.el (and similar files), do:
42
43 $ cd lisp
44 $ make autogen-clean
45 $ make autoloads
46
47 If either of the above partial procedures fails, try "make bootstrap".
48
49 Very occasionally changes in the source can introduce
50 incompatibilities with previous builds. If a bootstrap fails, as a
51 last resort try "make maintainer-clean" before configuring and
52 bootstrapping again. If CPU time is not an issue, the most thorough
53 way to rebuild, and avoid any spurious problems, is always to use this
54 method.
55
56 Users of non-Posix systems (MS-Windows etc.) should run the
57 platform-specific configuration scripts (nt/configure.bat, config.bat,
58 etc.) before "make bootstrap" or "make"; the rest of the procedure is
59 applicable to those systems as well.
60
61 Questions, requests, and bug reports about the CVS versions of Emacs
62 should be sent to emacs-pretest-bug@gnu.org rather than gnu.emacs.help
63 or gnu.emacs.bug. Ideally, use M-x report-emacs-bug RET which will
64 send it to the proper place.
65
66 Because the CVS version of Emacs is a work in progress, it will
67 sometimes fail to build. Please wait a day or so (and check the bug
68 and development mailing list archives) before reporting such problems.
69 In most cases, the problem is known about and is just waiting for
70 someone to fix it.
71
72
73 Note on using SSH to access the CVS repository from inside Emacs
74 ----------------------------------------------------------------
75
76 Write access to the CVS repository requires using SSH v2.
77
78 If you execute cvs commands inside Emacs, specifically if you use
79 pcl-cvs, output from CVS may be lost due to a problem in the
80 interface between ssh, cvs, and libc. Corrupted checkins are
81 also known to have happened.
82
83 To fix the problem, save the following script into a file, make it
84 executable, and set CVS_RSH to the file name of the script:
85
86 #!/bin/bash
87 exec 2> >(exec cat >&2 2>/dev/null)
88 exec ssh "$@"
89
90 This may be combined with the following entry in ~/.ssh/config to
91 simplify accessing the CVS repository:
92
93 Host subversions.gnu.org
94 Protocol 2
95 ForwardX11 no
96 User YOUR_USERID
97
98 \f
99 This file is part of GNU Emacs.
100
101 GNU Emacs is free software: you can redistribute it and/or modify
102 it under the terms of the GNU General Public License as published by
103 the Free Software Foundation, either version 3 of the License, or
104 (at your option) any later version.
105
106 GNU Emacs is distributed in the hope that it will be useful,
107 but WITHOUT ANY WARRANTY; without even the implied warranty of
108 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
109 GNU General Public License for more details.
110
111 You should have received a copy of the GNU General Public License
112 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.