annotate INSTALL.CVS @ 94969:916f0f042c9e

*** empty log message ***
author Kenichi Handa <handa@m17n.org>
date Wed, 14 May 2008 12:28:17 +0000
parents 1a762a842f80
children 8e882cf9cfb0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
79751
a9b80f99c836 Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 78262
diff changeset
1 Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
75587
68cfc1db0d26 Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents: 72914
diff changeset
2 Free Software Foundation, Inc.
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
3 See the end of the file for license conditions.
75587
68cfc1db0d26 Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents: 72914
diff changeset
4
68cfc1db0d26 Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents: 72914
diff changeset
5
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
6 Building and Installing Emacs from CVS
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
7
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
8 Some of the files that are included in the Emacs tarball, such as
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
9 byte-compiled Lisp files, are not stored in the CVS repository.
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
10 Therefore, to build from CVS you must run "make bootstrap"
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
11 instead of just "make":
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
12
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
13 $ ./configure
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
14 $ make bootstrap
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
15
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
16 The bootstrap process makes sure all necessary files are rebuilt
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
17 before it builds the final Emacs binary.
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
18
94434
561a10e874f2 Explain how to work awound an error case.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 94035
diff changeset
19 If 'make bootstrap' fails, it may be necessary to do 'make maintainer-clean'
561a10e874f2 Explain how to work awound an error case.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 94035
diff changeset
20 followed by configure before trying it again. (Occasionally the loaddefs.el
561a10e874f2 Explain how to work awound an error case.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 94035
diff changeset
21 file gets into a bad state due to changes in the Lisp libraries; this procedure
561a10e874f2 Explain how to work awound an error case.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 94035
diff changeset
22 forces it to be regenerated.)
561a10e874f2 Explain how to work awound an error case.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 94035
diff changeset
23
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
24 Normally, it is not necessary to use "make bootstrap" after every CVS
72407
4f77449f79f2 Clean up wording.
Richard M. Stallman <rms@gnu.org>
parents: 72366
diff changeset
25 update. Unless there are problems, we suggest using the following
4f77449f79f2 Clean up wording.
Richard M. Stallman <rms@gnu.org>
parents: 72366
diff changeset
26 alternative procedure after you have done "make bootstrap" at least
4f77449f79f2 Clean up wording.
Richard M. Stallman <rms@gnu.org>
parents: 72366
diff changeset
27 once:
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
28
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
29 $ ./configure
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
30 $ make
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
31 $ cd lisp
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
32 $ make recompile EMACS=../src/emacs
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
33 $ cd ..
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
34 $ make
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
35
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
36 (If you want to install the Emacs binary, type "make install" instead
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
37 of "make" in the last command.)
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
38
93899
b6020a64025d Improve previous change.
Glenn Morris <rgm@gnu.org>
parents: 93871
diff changeset
39 Occasionally the file "lisp/loaddefs.el" (and similar *-loaddefs.el
b6020a64025d Improve previous change.
Glenn Morris <rgm@gnu.org>
parents: 93871
diff changeset
40 files in some subdirectories of lisp/, e.g. mh-e/ and calendar/) will
b6020a64025d Improve previous change.
Glenn Morris <rgm@gnu.org>
parents: 93871
diff changeset
41 need to be updated to reflect new autoloaded functions. If you see
b6020a64025d Improve previous change.
Glenn Morris <rgm@gnu.org>
parents: 93871
diff changeset
42 errors (rather than warnings) about undefined lisp functions during
b6020a64025d Improve previous change.
Glenn Morris <rgm@gnu.org>
parents: 93871
diff changeset
43 compilation, that may be the reason. Another symptom may be an error
b6020a64025d Improve previous change.
Glenn Morris <rgm@gnu.org>
parents: 93871
diff changeset
44 saying that "loaddefs.el" could not be found; this is due to a change
b6020a64025d Improve previous change.
Glenn Morris <rgm@gnu.org>
parents: 93871
diff changeset
45 in the way loaddefs.el was handled in CVS, and should only happen
b6020a64025d Improve previous change.
Glenn Morris <rgm@gnu.org>
parents: 93871
diff changeset
46 once, for users that are updating old CVS trees. Finally, sometimes
b6020a64025d Improve previous change.
Glenn Morris <rgm@gnu.org>
parents: 93871
diff changeset
47 there can be build failures related to *loaddefs.el. In that case,
b6020a64025d Improve previous change.
Glenn Morris <rgm@gnu.org>
parents: 93871
diff changeset
48 delete them before following the instructions below to update them.
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
49
93899
b6020a64025d Improve previous change.
Glenn Morris <rgm@gnu.org>
parents: 93871
diff changeset
50 To update loaddefs.el (and similar files), do:
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
51
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
52 $ cd lisp
68587
1438f2238634 mh-autoloads is now a dependency of recompile, no need to remake it manually.
Eli Zaretskii <eliz@gnu.org>
parents: 66301
diff changeset
53 $ make autoloads EMACS=../src/emacs
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
54
66301
6f111b7dd138 Add mh-autoloads to the partial rebuild procedure.
Eli Zaretskii <eliz@gnu.org>
parents: 54679
diff changeset
55 If either of the above partial procedures fails, try "make bootstrap".
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
56
93869
f06f50495cd9 Mention deleting loaddefs, maintainer-clean.
Glenn Morris <rgm@gnu.org>
parents: 79751
diff changeset
57 Very occasionally changes in the source can introduce
f06f50495cd9 Mention deleting loaddefs, maintainer-clean.
Glenn Morris <rgm@gnu.org>
parents: 79751
diff changeset
58 incompatibilities with previous builds. If a bootstrap fails, as a
94035
a278a40360a9 Mention configuring after maintainer-clean.
Glenn Morris <rgm@gnu.org>
parents: 93899
diff changeset
59 last resort try "make maintainer-clean" before configuring and
a278a40360a9 Mention configuring after maintainer-clean.
Glenn Morris <rgm@gnu.org>
parents: 93899
diff changeset
60 bootstrapping again. If CPU time is not an issue, the most thorough
a278a40360a9 Mention configuring after maintainer-clean.
Glenn Morris <rgm@gnu.org>
parents: 93899
diff changeset
61 way to rebuild, and avoid any spurious problems, is always to use this
a278a40360a9 Mention configuring after maintainer-clean.
Glenn Morris <rgm@gnu.org>
parents: 93899
diff changeset
62 method.
93869
f06f50495cd9 Mention deleting loaddefs, maintainer-clean.
Glenn Morris <rgm@gnu.org>
parents: 79751
diff changeset
63
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
64 Users of non-Posix systems (MS-Windows etc.) should run the
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
65 platform-specific configuration scripts (nt/configure.bat, config.bat,
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
66 etc.) before "make bootstrap" or "make"; the rest of the procedure is
66301
6f111b7dd138 Add mh-autoloads to the partial rebuild procedure.
Eli Zaretskii <eliz@gnu.org>
parents: 54679
diff changeset
67 applicable to those systems as well, except that the value of the
6f111b7dd138 Add mh-autoloads to the partial rebuild procedure.
Eli Zaretskii <eliz@gnu.org>
parents: 54679
diff changeset
68 EMACS variable on the Make command line might be different, e.g.,
6f111b7dd138 Add mh-autoloads to the partial rebuild procedure.
Eli Zaretskii <eliz@gnu.org>
parents: 54679
diff changeset
69 ../bin/emacs.exe or some such.
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
70
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
71 Questions, requests, and bug reports about the CVS versions of Emacs
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
72 should be sent to emacs-pretest-bug@gnu.org rather than gnu.emacs.help
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
73 or gnu.emacs.bug. Ideally, use M-x report-emacs-bug RET which will
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
74 send it to the proper place.
54055
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
75
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
76
54679
821beb22a34c *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54055
diff changeset
77 Note on using SSH to access the CVS repository from inside Emacs
54055
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
78 ----------------------------------------------------------------
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
79
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
80 Write access to the CVS repository requires using SSH v2.
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
81
54679
821beb22a34c *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54055
diff changeset
82 If you execute cvs commands inside Emacs, specifically if you use
54055
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
83 pcl-cvs, output from CVS may be lost due to a problem in the
72914
ede32cd24dba Corrupted checkins are known to have happened.
Kim F. Storm <storm@cua.dk>
parents: 72407
diff changeset
84 interface between ssh, cvs, and libc. Corrupted checkins are
ede32cd24dba Corrupted checkins are known to have happened.
Kim F. Storm <storm@cua.dk>
parents: 72407
diff changeset
85 also known to have happened.
54055
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
86
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
87 To fix the problem, save the following script into a file, make it
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
88 executable, and set CVS_RSH to the file name of the script:
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
89
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
90 #!/bin/bash
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
91 exec 2> >(exec cat >&2 2>/dev/null)
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
92 exec ssh "$@"
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
93
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
94 This may be combined with the following entry in ~/.ssh/config to
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
95 simplify accessing the CVS repository:
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
96
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
97 Host subversions.gnu.org
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
98 Protocol 2
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
99 ForwardX11 no
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
100 User YOUR_USERID
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
101
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
102
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
103 This file is part of GNU Emacs.
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
104
94719
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 94434
diff changeset
105 GNU Emacs is free software: you can redistribute it and/or modify
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
106 it under the terms of the GNU General Public License as published by
94719
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 94434
diff changeset
107 the Free Software Foundation, either version 3 of the License, or
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 94434
diff changeset
108 (at your option) any later version.
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
109
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
110 GNU Emacs is distributed in the hope that it will be useful,
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
111 but WITHOUT ANY WARRANTY; without even the implied warranty of
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
112 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
113 GNU General Public License for more details.
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
114
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
115 You should have received a copy of the GNU General Public License
94719
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 94434
diff changeset
116 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.