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