annotate INSTALL.CVS @ 99613:785924da433d

(Splitting Windows, Deleting Windows) (Selecting Windows, Cyclic Window Ordering) (Buffers and Windows, Displaying Buffers, Choosing Window) (Dedicated Windows, Window Point, Window Start and End) (Textual Scrolling, Vertical Scrolling, Horizontal Scrolling) (Size of Window, Resizing Windows, Window Configurations) (Window Parameters): Avoid @var at beginning of sentences and reword accordingly.
author Martin Rudalics <rudalics@gmx.at>
date Sun, 16 Nov 2008 10:15:30 +0000
parents 20ce3b4f1247
children f7624bb0bd1f
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
95686
88b2fb5783a6 There is no reason to not use the `-dP' options to `cvs update' every time.
Glenn Morris <rgm@gnu.org>
parents: 95664
diff changeset
13 $ cvs update -dP
53439
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
96134
d143e6de14ec * src/Makefile.in (emacs${EXEEXT}): Depend on the machine-specific files.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 96069
diff changeset
16 Of course, if this is the first time you go through it, you'll need to do
d143e6de14ec * src/Makefile.in (emacs${EXEEXT}): Depend on the machine-specific files.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 96069
diff changeset
17 ./configure before the "make bootstrap".
94434
561a10e874f2 Explain how to work awound an error case.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 94035
diff changeset
18
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
19 Normally, it is not necessary to use "make bootstrap" after every CVS
96134
d143e6de14ec * src/Makefile.in (emacs${EXEEXT}): Depend on the machine-specific files.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 96069
diff changeset
20 update. "make" should work in 90% of the cases and be much quicker.
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
21
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
22 $ make
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
23
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
24 (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
25 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
26
95687
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
27 Occasionally the file "lisp/loaddefs.el" (and similar automatically
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
28 generated files, such as esh-groups.el, and *-loaddefs.el in some
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
29 subdirectories of lisp/, e.g. mh-e/ and calendar/) will need to be
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
30 updated to reflect new autoloaded functions. If you see errors (rather
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
31 than warnings) about undefined lisp functions during compilation, that
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
32 may be the reason. Another symptom may be an error saying that
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
33 "loaddefs.el" could not be found; this is due to a change in the way
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
34 loaddefs.el was handled in CVS, and should only happen once, for users
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
35 that are updating old CVS trees. Finally, sometimes there can be build
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
36 failures related to *loaddefs.el (e.g. "required feature `esh-groups'
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
37 was not provided"). In that case, follow the instructions below.
53439
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 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
40
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
41 $ cd lisp
95687
18c9a69d751f loaddefs are always fully regenerated on bootstrapping.
Glenn Morris <rgm@gnu.org>
parents: 95686
diff changeset
42 $ make autogen-clean
96069
b0615674c5b7 Remove references to passing EMACS to make, since the defaults are
Glenn Morris <rgm@gnu.org>
parents: 95722
diff changeset
43 $ make autoloads
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
44
66301
6f111b7dd138 Add mh-autoloads to the partial rebuild procedure.
Eli Zaretskii <eliz@gnu.org>
parents: 54679
diff changeset
45 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
46
93869
f06f50495cd9 Mention deleting loaddefs, maintainer-clean.
Glenn Morris <rgm@gnu.org>
parents: 79751
diff changeset
47 Very occasionally changes in the source can introduce
f06f50495cd9 Mention deleting loaddefs, maintainer-clean.
Glenn Morris <rgm@gnu.org>
parents: 79751
diff changeset
48 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
49 last resort try "make maintainer-clean" before configuring and
a278a40360a9 Mention configuring after maintainer-clean.
Glenn Morris <rgm@gnu.org>
parents: 93899
diff changeset
50 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
51 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
52 method.
93869
f06f50495cd9 Mention deleting loaddefs, maintainer-clean.
Glenn Morris <rgm@gnu.org>
parents: 79751
diff changeset
53
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
54 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
55 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
56 etc.) before "make bootstrap" or "make"; the rest of the procedure is
96069
b0615674c5b7 Remove references to passing EMACS to make, since the defaults are
Glenn Morris <rgm@gnu.org>
parents: 95722
diff changeset
57 applicable to those systems as well.
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
58
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
59 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
60 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
61 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
62 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
63
97932
20ce3b4f1247 A plea for fewer "it doesn't build" messages.
Glenn Morris <rgm@gnu.org>
parents: 96134
diff changeset
64 Because the CVS version of Emacs is a work in progress, it will
20ce3b4f1247 A plea for fewer "it doesn't build" messages.
Glenn Morris <rgm@gnu.org>
parents: 96134
diff changeset
65 sometimes fail to build. Please wait a day or so (and check the bug
20ce3b4f1247 A plea for fewer "it doesn't build" messages.
Glenn Morris <rgm@gnu.org>
parents: 96134
diff changeset
66 and development mailing list archives) before reporting such problems.
20ce3b4f1247 A plea for fewer "it doesn't build" messages.
Glenn Morris <rgm@gnu.org>
parents: 96134
diff changeset
67 In most cases, the problem is known about and is just waiting for
20ce3b4f1247 A plea for fewer "it doesn't build" messages.
Glenn Morris <rgm@gnu.org>
parents: 96134
diff changeset
68 someone to fix it.
20ce3b4f1247 A plea for fewer "it doesn't build" messages.
Glenn Morris <rgm@gnu.org>
parents: 96134
diff changeset
69
54055
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
70
54679
821beb22a34c *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54055
diff changeset
71 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
72 ----------------------------------------------------------------
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
73
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
74 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
75
54679
821beb22a34c *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54055
diff changeset
76 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
77 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
78 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
79 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
80
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
81 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
82 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
83
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
84 #!/bin/bash
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
85 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
86 exec ssh "$@"
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
87
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
88 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
89 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
90
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
91 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
92 Protocol 2
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
93 ForwardX11 no
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
94 User YOUR_USERID
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
95
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
96
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
97 This file is part of GNU Emacs.
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
98
94719
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 94434
diff changeset
99 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
100 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
101 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
102 (at your option) any later version.
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
103
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
104 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
105 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
106 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
107 GNU General Public License for more details.
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
108
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
109 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
110 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.