* advice.texi (Advising Primitives): Link to What Is a Function.
[emacs/old-mirror.git] / INSTALL.CVS
blobaee016f28d38a3ee7ee30fb7925dfd344f6a52c8
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.
6               Building and Installing Emacs from CVS
8 If this is the first time you go through it, you'll need to configure
9 before bootstrapping:
11   $ ./configure
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":
18   $ cvs update -dP
19   $ make bootstrap
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.
24   $ make
26 (If you want to install the Emacs binary, type "make install" instead
27 of "make" in the last command.)
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.
41 To update loaddefs.el (and similar files), do:
43   $ cd lisp
44   $ make autoloads
46 If either of the above partial procedures fails, try "make bootstrap".
48 Very occasionally changes in the source can introduce
49 incompatibilities with previous builds.  If a bootstrap fails, as a
50 last resort try "make maintainer-clean" before configuring and
51 bootstrapping again.  If CPU time is not an issue, the most thorough
52 way to rebuild, and avoid any spurious problems, is always to use this
53 method.
55 Users of non-Posix systems (MS-Windows etc.) should run the
56 platform-specific configuration scripts (nt/configure.bat, config.bat,
57 etc.) before "make bootstrap" or "make"; the rest of the procedure is
58 applicable to those systems as well.
60 Questions, requests, and bug reports about the CVS versions of Emacs
61 should be sent to emacs-pretest-bug@gnu.org rather than gnu.emacs.help
62 or gnu.emacs.bug.  Ideally, use M-x report-emacs-bug RET which will
63 send it to the proper place.
65 Because the CVS version of Emacs is a work in progress, it will
66 sometimes fail to build.  Please wait a day or so (and check the bug
67 and development mailing list archives) before reporting such problems.
68 In most cases, the problem is known about and is just waiting for
69 someone to fix it.
72 Note on using SSH to access the CVS repository from inside Emacs
73 ----------------------------------------------------------------
75 Write access to the CVS repository requires using SSH v2.
77 If you execute cvs commands inside Emacs, specifically if you use
78 pcl-cvs, output from CVS may be lost due to a problem in the
79 interface between ssh, cvs, and libc.  Corrupted checkins are
80 also known to have happened.
82 To fix the problem, save the following script into a file, make it
83 executable, and set CVS_RSH to the file name of the script:
85 #!/bin/bash
86 exec 2> >(exec cat >&2 2>/dev/null)
87 exec ssh "$@"
89 This may be combined with the following entry in ~/.ssh/config to
90 simplify accessing the CVS repository:
92 Host subversions.gnu.org
93      Protocol 2
94      ForwardX11 no
95      User YOUR_USERID
98 This file is part of GNU Emacs.
100 GNU Emacs is free software: you can redistribute it and/or modify
101 it under the terms of the GNU General Public License as published by
102 the Free Software Foundation, either version 3 of the License, or
103 (at your option) any later version.
105 GNU Emacs is distributed in the hope that it will be useful,
106 but WITHOUT ANY WARRANTY; without even the implied warranty of
107 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
108 GNU General Public License for more details.
110 You should have received a copy of the GNU General Public License
111 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.