annotate INSTALL.CVS @ 54055:6a13a0f9d22b

Add info about ssh/cvs related problems and work-around.
author Kim F. Storm <storm@cua.dk>
date Tue, 17 Feb 2004 23:46:53 +0000
parents 19d4dac27e5c
children 821beb22a34c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
53439
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
1 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
2
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
3 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
4 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
5 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
6 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
7
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
8 $ ./configure
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
9 $ make bootstrap
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
10
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
11 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
12 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
13
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
14 Normally, it is not necessary to use "make bootstrap" after every CVS
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
15 update. Unless there are problems, we suggest the following
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
16 procedure:
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
17
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
18 $ ./configure
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
19 $ make
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
20 $ cd lisp
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
21 $ 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
22 $ cd ..
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
23 $ make
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
24
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
25 (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
26 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
27
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
28 Occasionally the file "lisp/loaddefs.el" will need be updated to reflect
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
29 new autoloaded functions. If you see errors about undefined lisp
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
30 functions during compilation, that may be the reason. Another symptom
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
31 may be an error saying that "loaddefs.el" could not be found; this is
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
32 due to a change in the way loaddefs.el was handled in CVS, and should
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
33 only happen once, for users that are updating old CVS trees.
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
34
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
35 To update loaddefs.el, do:
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
36
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
37 $ cd lisp
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
38 $ make autoloads EMACS=../src/emacs
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
39
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
40 If either of above procedures fails, try "make bootstrap".
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
41
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
42 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
43 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
44 etc.) before "make bootstrap" or "make"; the rest of the procedure is
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
45 applicable to those systems as well.
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
46
19d4dac27e5c Renamed INSTALL-CVS to INSTALL.CVS to avoid file-name
Eli Zaretskii <eliz@is.elta.co.il>
parents:
diff changeset
47 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
48 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
49 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
50 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
51
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
52
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
53 Note on using SSH to access the CVS repository from inside emacs
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
54 ----------------------------------------------------------------
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
55
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
56 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
57
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
58 If you execute cvs commands inside emacs, specifically if you use
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
59 pcl-cvs, output from CVS may be lost due to a problem in the
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
60 interface between ssh, cvs, and emacs. Corrupted checkins are
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
61 also been reported to have happened.
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
62
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
63 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
64 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
65
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
66 #!/bin/bash
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
67 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
68 exec ssh "$@"
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
69
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
70 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
71 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
72
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
73 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
74 Protocol 2
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
75 ForwardX11 no
6a13a0f9d22b Add info about ssh/cvs related problems and work-around.
Kim F. Storm <storm@cua.dk>
parents: 53439
diff changeset
76 User YOUR_USERID